@qualithm/kafka-client - v0.1.6
    Preparing search index...

    Type Alias ConsumerGroupHeartbeatRequest

    ConsumerGroupHeartbeat request payload (v0).

    type ConsumerGroupHeartbeatRequest = {
        groupId: string;
        instanceId: string | null;
        memberEpoch: number;
        memberId: string;
        rackId: string | null;
        rebalanceTimeoutMs: number;
        serverAssignor: string | null;
        subscribedTopicNames: readonly string[] | null;
        taggedFields?: readonly TaggedField[];
        topicPartitions:
            | readonly ConsumerGroupHeartbeatRequestTopicPartition[]
            | null;
    }
    Index

    Properties

    groupId instanceId memberEpoch memberId rackId rebalanceTimeoutMs serverAssignor subscribedTopicNames taggedFields? topicPartitions

    Properties

    groupId: string

    The group ID.

    instanceId: string | null

    The instance ID for static membership, or null.

    memberEpoch: number

    The member epoch. 0 to join the group. -1 to leave the group. -2 to signal a completely new member that wants to join.

    memberId: string

    The member ID (empty string on first heartbeat).

    rackId: string | null

    The rack ID, or null.

    rebalanceTimeoutMs: number

    The maximum time in ms for the group to rebalance.

    serverAssignor: string | null

    The server-side assignor name, or null.

    subscribedTopicNames: readonly string[] | null

    The list of subscribed topic names, or null (unchanged).

    taggedFields?: readonly TaggedField[]

    Tagged fields.

    topicPartitions: readonly ConsumerGroupHeartbeatRequestTopicPartition[] | null

    The consumer's current topic-partition assignment, or null (unchanged).

    Settings

    Member Visibility

    On This Page

    Properties