Kafka.Metadata

Documentation

data KafkaMetadata

Constructors

KafkaMetadata

Fields

• kmBrokers :: [BrokerMetadata]
• kmTopics :: [TopicMetadata]
• kmOrigBroker :: !BrokerId

Instances

Eq KafkaMetadata

Methods

(==) :: KafkaMetadata -> KafkaMetadata -> Bool

(/=) :: KafkaMetadata -> KafkaMetadata -> Bool

Show KafkaMetadata

Methods

showsPrec :: Int -> KafkaMetadata -> ShowS

show :: KafkaMetadata -> String

showList :: [KafkaMetadata] -> ShowS

data BrokerMetadata

Constructors

BrokerMetadata

Fields

• bmBrokerId :: !BrokerId
• bmBrokerHost :: !String
• bmBrokerPort :: !Int

Instances

Eq BrokerMetadata

Methods

(==) :: BrokerMetadata -> BrokerMetadata -> Bool

(/=) :: BrokerMetadata -> BrokerMetadata -> Bool

Show BrokerMetadata

Methods

showsPrec :: Int -> BrokerMetadata -> ShowS

show :: BrokerMetadata -> String

showList :: [BrokerMetadata] -> ShowS

data TopicMetadata

Constructors

TopicMetadata

Fields

• tmTopicName :: !TopicName
• tmPartitions :: [PartitionMetadata]
• tmError :: Maybe KafkaError

Instances

Eq TopicMetadata

Methods

(==) :: TopicMetadata -> TopicMetadata -> Bool

(/=) :: TopicMetadata -> TopicMetadata -> Bool

Show TopicMetadata

Methods

showsPrec :: Int -> TopicMetadata -> ShowS

show :: TopicMetadata -> String

showList :: [TopicMetadata] -> ShowS

data PartitionMetadata

Constructors

PartitionMetadata

Fields

• pmPartitionId :: !PartitionId
• pmError :: Maybe KafkaError
• pmLeader :: !BrokerId
• pmReplicas :: [BrokerId]
• pmInSyncReplicas :: [BrokerId]

Instances

Eq PartitionMetadata

Methods

(==) :: PartitionMetadata -> PartitionMetadata -> Bool

(/=) :: PartitionMetadata -> PartitionMetadata -> Bool

Show PartitionMetadata

Methods

showsPrec :: Int -> PartitionMetadata -> ShowS

show :: PartitionMetadata -> String

showList :: [PartitionMetadata] -> ShowS

data WatermarkOffsets

Constructors

WatermarkOffsets

Fields

• woTopicName :: !TopicName
• woPartitionId :: !PartitionId
• woLowWatermark :: !Offset
• woHighWatermark :: !Offset

Instances

Eq WatermarkOffsets

Methods

(==) :: WatermarkOffsets -> WatermarkOffsets -> Bool

(/=) :: WatermarkOffsets -> WatermarkOffsets -> Bool

Show WatermarkOffsets

Methods

showsPrec :: Int -> WatermarkOffsets -> ShowS

show :: WatermarkOffsets -> String

showList :: [WatermarkOffsets] -> ShowS

newtype GroupMemberId

Constructors

GroupMemberId String

Instances

Eq GroupMemberId

Methods

(==) :: GroupMemberId -> GroupMemberId -> Bool

(/=) :: GroupMemberId -> GroupMemberId -> Bool

Ord GroupMemberId

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

Methods

readsPrec :: Int -> ReadS GroupMemberId

readList :: ReadS [GroupMemberId]

readPrec :: ReadPrec GroupMemberId

readListPrec :: ReadPrec [GroupMemberId]

Show GroupMemberId

Methods

showsPrec :: Int -> GroupMemberId -> ShowS

show :: GroupMemberId -> String

showList :: [GroupMemberId] -> ShowS

data GroupMemberInfo

Constructors

GroupMemberInfo

Fields

• gmiMemberId :: !GroupMemberId
• gmiClientId :: !ClientId
• gmiClientHost :: !String
• gmiMetadata :: !ByteString
• gmiAssignment :: !ByteString

Instances

Eq GroupMemberInfo

Methods

(==) :: GroupMemberInfo -> GroupMemberInfo -> Bool

(/=) :: GroupMemberInfo -> GroupMemberInfo -> Bool

Show GroupMemberInfo

Methods

showsPrec :: Int -> GroupMemberInfo -> ShowS

show :: GroupMemberInfo -> String

showList :: [GroupMemberInfo] -> ShowS

newtype GroupProtocolType

Constructors

GroupProtocolType String

Instances

Eq GroupProtocolType

Methods

(==) :: GroupProtocolType -> GroupProtocolType -> Bool

(/=) :: GroupProtocolType -> GroupProtocolType -> Bool

Ord GroupProtocolType

Methods

compare :: GroupProtocolType -> GroupProtocolType -> Ordering

(<) :: GroupProtocolType -> GroupProtocolType -> Bool

(<=) :: GroupProtocolType -> GroupProtocolType -> Bool

(>) :: GroupProtocolType -> GroupProtocolType -> Bool

(>=) :: GroupProtocolType -> GroupProtocolType -> Bool

max :: GroupProtocolType -> GroupProtocolType -> GroupProtocolType

min :: GroupProtocolType -> GroupProtocolType -> GroupProtocolType

Read GroupProtocolType

Methods

readsPrec :: Int -> ReadS GroupProtocolType

readList :: ReadS [GroupProtocolType]

readPrec :: ReadPrec GroupProtocolType

readListPrec :: ReadPrec [GroupProtocolType]

Show GroupProtocolType

Methods

showsPrec :: Int -> GroupProtocolType -> ShowS

show :: GroupProtocolType -> String

showList :: [GroupProtocolType] -> ShowS

newtype GroupProtocol

Constructors

GroupProtocol String

Instances

Eq GroupProtocol

Methods

(==) :: GroupProtocol -> GroupProtocol -> Bool

(/=) :: GroupProtocol -> GroupProtocol -> Bool

Ord GroupProtocol

Methods

compare :: GroupProtocol -> GroupProtocol -> Ordering

(<) :: GroupProtocol -> GroupProtocol -> Bool

(<=) :: GroupProtocol -> GroupProtocol -> Bool

(>) :: GroupProtocol -> GroupProtocol -> Bool

(>=) :: GroupProtocol -> GroupProtocol -> Bool

max :: GroupProtocol -> GroupProtocol -> GroupProtocol

min :: GroupProtocol -> GroupProtocol -> GroupProtocol

Read GroupProtocol

Methods

readsPrec :: Int -> ReadS GroupProtocol

readList :: ReadS [GroupProtocol]

readPrec :: ReadPrec GroupProtocol

readListPrec :: ReadPrec [GroupProtocol]

Show GroupProtocol

Methods

showsPrec :: Int -> GroupProtocol -> ShowS

show :: GroupProtocol -> String

showList :: [GroupProtocol] -> ShowS

data GroupState

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

Eq GroupState

Methods

(==) :: GroupState -> GroupState -> Bool

(/=) :: GroupState -> GroupState -> Bool

Ord GroupState

Methods

compare :: GroupState -> GroupState -> Ordering

(<) :: GroupState -> GroupState -> Bool

(<=) :: GroupState -> GroupState -> Bool

(>) :: GroupState -> GroupState -> Bool

(>=) :: GroupState -> GroupState -> Bool

max :: GroupState -> GroupState -> GroupState

min :: GroupState -> GroupState -> GroupState

Read GroupState

Methods

readsPrec :: Int -> ReadS GroupState

readList :: ReadS [GroupState]

readPrec :: ReadPrec GroupState

readListPrec :: ReadPrec [GroupState]

Show GroupState

Methods

showsPrec :: Int -> GroupState -> ShowS

show :: GroupState -> String

showList :: [GroupState] -> ShowS

data GroupInfo

Constructors

GroupInfo

Fields

• giGroup :: !ConsumerGroupId
• giError :: Maybe KafkaError
• giState :: !GroupState
• giProtocolType :: !GroupProtocolType
• giProtocol :: !GroupProtocol
• giMembers :: [GroupMemberInfo]

Instances

Eq GroupInfo

Methods

(==) :: GroupInfo -> GroupInfo -> Bool

(/=) :: GroupInfo -> GroupInfo -> Bool

Show GroupInfo

Methods

showsPrec :: Int -> GroupInfo -> ShowS

show :: GroupInfo -> String

showList :: [GroupInfo] -> ShowS

allTopicsMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> m (Either KafkaError KafkaMetadata)

Returns metadata for all topics in the cluster

topicMetadata :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m (Either KafkaError KafkaMetadata)

Returns metadata only for specified topic

watermarkOffsets :: (MonadIO m, HasKafka k) => k -> Timeout -> TopicName -> m [Either KafkaError WatermarkOffsets]

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]

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)

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])

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])

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])

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])

List and describe all consumer groups in cluster.

consumerGroupInfo :: (MonadIO m, HasKafka k) => k -> Timeout -> ConsumerGroupId -> m (Either KafkaError [GroupInfo])

Describe a given consumer group.