IMessageConsumer interface
Provides access to the kafka message consumer
public interface IMessageConsumer
Members
| name | description |
|---|---|
| Assignment { get; } | Gets the current partition assignment |
| ClientInstanceName { get; } | Gets the name of this client instance. Contains (but is not equal to) the client.id configuration parameter. |
| ClusterName { get; } | Gets the unique cluster´s name defined in the configuration |
| ConsumerName { get; } | Gets the unique consumer´s name defined in the configuration |
| GroupId { get; } | Gets the group id define in the configuration |
| ManagementDisabled { get; } | Gets a value indicating whether the consumer is able to be manageable or not |
| MemberId { get; } | Gets the (dynamic) group member id of this consumer (as set by the broker). |
| PausedPartitions { get; } | Gets the consumer's paused partitions |
| RunningPartitions { get; } | Gets the consumer's running partitions |
| Status { get; } | Gets the current consumer status |
| Subscription { get; } | Gets the current topic subscription |
| Topics { get; } | Gets the consumer configured topics |
| WorkersCount { get; } | Gets the current number of workers allocated of the consumer |
| ChangeWorkersCountAndRestartAsync(…) | Restart the current consumer with the new worker count |
| GetOffsets(…) | Look up the offsets for the given partitions by timestamp. The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition. |
| GetPosition(…) | Gets the current position (offset) for the specified topic / partition. The offset field of each requested partition will be set to the offset of the last consumed message + 1, or Offset.Unset in case there was no previous message consumed by this consumer. |
| GetTopicPartitionsLag() | Gets the lag of each topic/partitions assigned |
| GetWatermarkOffsets(…) | Get the last cached low (oldest available / beginning) and high (newest/end) offsets for a topic/partition. Does not block. |
| OverrideOffsetsAndRestartAsync(…) | Overrides the offsets of the given partitions and restart the consumer |
| Pause(…) | Pause consumption for the provided list of partitions. |
| QueryWatermarkOffsets(…) | Query the Kafka cluster for low (oldest available/beginning) and high (newest/end) offsets for the specified topic/partition. This is a blocking call - always contacts the cluster for the required information. |
| RestartAsync() | Restart KafkaFlow consumer and recreate the internal Confluent Consumer |
| Resume(…) | Resume consumption for the provided list of partitions. |
| StartAsync() | Starts KafkaFlow consumer creating a new Confluent Consumer |
| StopAsync() | Stops KafkaFlow consumer destroying the Confluent Consumer |
See Also
- namespace KafkaFlow.Consumers