...

Text file src/github.com/twmb/franz-go/generate/definitions/12_heartbeat

Documentation: github.com/twmb/franz-go/generate/definitions

     1// HeartbeatRequest issues a heartbeat for a member in a group, ensuring that
     2// Kafka does not expire the member from the group.
     3HeartbeatRequest => key 12, max version 4, flexible v4+, group coordinator
     4  // Group is the group ID this heartbeat is for.
     5  Group: string
     6  // Generation is the group generation this heartbeat is for.
     7  Generation: int32
     8  // MemberID is the member ID this member is for.
     9  MemberID: string
    10  // InstanceID is the instance ID of this member in the group (KIP-345).
    11  InstanceID: nullable-string // v3+
    12
    13// HeartbeatResponse is returned from a HeartbeatRequest.
    14HeartbeatResponse =>
    15  ThrottleMillis(2) // v1+
    16  // ErrorCode is the error for the heartbeat request.
    17  //
    18  // GROUP_AUTHORIZATION_FAILED is returned if the client is not authorized
    19  // to the group (no read perms).
    20  //
    21  // INVALID_GROUP_ID is returned in the requested group ID is invalid.
    22  //
    23  // COORDINATOR_NOT_AVAILABLE is returned if the coordinator is not available
    24  // (due to the requested broker shutting down or it has not completed startup).
    25  //
    26  // NOT_COORDINATOR is returned if the requested broker is not the coordinator
    27  // for the requested group.
    28  //
    29  // UNKNOWN_MEMBER_ID is returned if the member ID is not a part of the group,
    30  // or if the group is empty or dead.
    31  //
    32  // ILLEGAL_GENERATION is returned if the request's generation ID is invalid.
    33  //
    34  // REBALANCE_IN_PROGRESS is returned if the group is currently rebalancing.
    35  ErrorCode: int16

View as plain text