Safe Haskell | None |
---|---|
Language | Haskell2010 |
Kafka.Metadata
Description
Module with metadata types and functions.
Synopsis
- data KafkaMetadata = KafkaMetadata {
- kmBrokers :: [BrokerMetadata]
- kmTopics :: [TopicMetadata]
- kmOrigBroker :: !BrokerId
- data BrokerMetadata = BrokerMetadata {
- bmBrokerId :: !BrokerId
- bmBrokerHost :: !Text
- bmBrokerPort :: !Int
- data TopicMetadata = TopicMetadata {}
- data PartitionMetadata = PartitionMetadata {
- pmPartitionId :: !PartitionId
- pmError :: Maybe KafkaError
- pmLeader :: !BrokerId
- pmReplicas :: [BrokerId]
- pmInSyncReplicas :: [BrokerId]
- data WatermarkOffsets = WatermarkOffsets {}
- newtype GroupMemberId = GroupMemberId Text
- data GroupMemberInfo = GroupMemberInfo {}
- newtype GroupProtocolType = GroupProtocolType Text
- newtype GroupProtocol = GroupProtocol Text
- data GroupState
- data GroupInfo = GroupInfo {}
- allTopicsMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError KafkaMetadata)
- topicMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m (Either KafkaError KafkaMetadata)
- watermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m [Either KafkaError WatermarkOffsets]
- watermarkOffsets' :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicMetadata -> m [Either KafkaError WatermarkOffsets]
- partitionWatermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> PartitionId -> m (Either KafkaError WatermarkOffsets)
- offsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> [(TopicName, PartitionId)] -> m (Either KafkaError [TopicPartition])
- offsetsForTime' :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicMetadata -> m (Either KafkaError [TopicPartition])
- topicOffsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicName -> m (Either KafkaError [TopicPartition])
- allConsumerGroupsInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError [GroupInfo])
- consumerGroupInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> ConsumerGroupId -> m (Either KafkaError [GroupInfo])
Documentation
data KafkaMetadata Source #
Constructors
KafkaMetadata | |
Fields
|
Instances
data BrokerMetadata Source #
Constructors
BrokerMetadata | |
Fields
|
Instances
data TopicMetadata Source #
Constructors
TopicMetadata | |
Fields
|
Instances
data PartitionMetadata Source #
Constructors
PartitionMetadata | |
Fields
|
Instances
data WatermarkOffsets Source #
Constructors
WatermarkOffsets | |
Fields
|
Instances
newtype GroupMemberId Source #
Constructors
GroupMemberId Text |
Instances
Eq GroupMemberId Source # | |
Defined in Kafka.Metadata Methods (==) :: GroupMemberId -> GroupMemberId -> Bool # (/=) :: GroupMemberId -> GroupMemberId -> Bool # | |
Ord GroupMemberId Source # | |
Defined in Kafka.Metadata Methods compare :: GroupMemberId -> GroupMemberId -> Ordering # (<) :: GroupMemberId -> GroupMemberId -> Bool # (<=) :: GroupMemberId -> GroupMemberId -> Bool # (>) :: GroupMemberId -> GroupMemberId -> Bool # (>=) :: GroupMemberId -> GroupMemberId -> Bool # max :: GroupMemberId -> GroupMemberId -> GroupMemberId # min :: GroupMemberId -> GroupMemberId -> GroupMemberId # | |
Read GroupMemberId Source # | |
Defined in Kafka.Metadata Methods readsPrec :: Int -> ReadS GroupMemberId # readList :: ReadS [GroupMemberId] # | |
Show GroupMemberId Source # | |
Defined in Kafka.Metadata Methods showsPrec :: Int -> GroupMemberId -> ShowS # show :: GroupMemberId -> String # showList :: [GroupMemberId] -> ShowS # |
data GroupMemberInfo Source #
Constructors
GroupMemberInfo | |
Fields
|
Instances
newtype GroupProtocolType Source #
Constructors
GroupProtocolType Text |
Instances
newtype GroupProtocol Source #
Constructors
GroupProtocol Text |
Instances
data GroupState Source #
Constructors
GroupPreparingRebalance | Group is preparing to rebalance |
GroupEmpty | Group has no more members, but lingers until all offsets have expired |
GroupAwaitingSync | Group is awaiting state assignment from the leader |
GroupStable | Group is stable |
GroupDead | Group has no more members and its metadata is being removed |
Instances
Constructors
GroupInfo | |
Fields
|
Instances
Eq GroupInfo Source # | |
Show GroupInfo Source # | |
Generic GroupInfo Source # | |
type Rep GroupInfo Source # | |
Defined in Kafka.Metadata type Rep GroupInfo = D1 ('MetaData "GroupInfo" "Kafka.Metadata" "hw-kafka-client-4.0.4-inplace" 'False) (C1 ('MetaCons "GroupInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "giGroup") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsumerGroupId) :*: (S1 ('MetaSel ('Just "giError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KafkaError)) :*: S1 ('MetaSel ('Just "giState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupState))) :*: (S1 ('MetaSel ('Just "giProtocolType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupProtocolType) :*: (S1 ('MetaSel ('Just "giProtocol") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GroupProtocol) :*: S1 ('MetaSel ('Just "giMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GroupMemberInfo]))))) |
allTopicsMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError KafkaMetadata) Source #
Returns metadata for all topics in the cluster
topicMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m (Either KafkaError KafkaMetadata) Source #
Returns metadata only for specified topic
watermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m [Either KafkaError WatermarkOffsets] Source #
Query broker for low (oldestbeginning) and high (newestend) offsets for a given topic.
watermarkOffsets' :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicMetadata -> m [Either KafkaError WatermarkOffsets] Source #
Query broker for low (oldestbeginning) and high (newestend) offsets for a given topic.
partitionWatermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> PartitionId -> m (Either KafkaError WatermarkOffsets) Source #
Query broker for low (oldestbeginning) and high (newestend) offsets for a specific partition
offsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> [(TopicName, PartitionId)] -> m (Either KafkaError [TopicPartition]) Source #
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.
offsetsForTime' :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicMetadata -> m (Either KafkaError [TopicPartition]) Source #
Look up the offsets for the given metadata 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.
topicOffsetsForTime :: (MonadIO m, HasKafka k) => k -> Timeout -> Millis -> TopicName -> m (Either KafkaError [TopicPartition]) Source #
Look up the offsets for the given topic 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.
allConsumerGroupsInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError [GroupInfo]) Source #
List and describe all consumer groups in cluster.
consumerGroupInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> ConsumerGroupId -> m (Either KafkaError [GroupInfo]) Source #
Describe a given consumer group.