...

Text file src/github.com/twmb/franz-go/generate/definitions/13_leave_group

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

     1// LeaveGroupRequest issues a request for a group member to leave the group,
     2// triggering a group rebalance.
     3//
     4// Version 3 changed removed MemberID and added a batch instance+member ID
     5// way of leaving a group.
     6LeaveGroupRequest => key 13, max version 5, flexible v4+, group coordinator
     7  // Group is the group to leave.
     8  Group: string
     9  // MemberID is the member that is leaving.
    10  MemberID: string // v0-v2
    11  // Members are member and group instance IDs to cause to leave a group.
    12  Members: [=>] // v3+
    13    MemberID: string
    14    InstanceID: nullable-string
    15    // Reason is an optional reason why this member is leaving the group
    16    // (KIP-800, Kafka 3.2+).
    17    Reason: nullable-string // v5+
    18
    19// LeaveGroupResponse is returned from a LeaveGroupRequest.
    20LeaveGroupResponse =>
    21  ThrottleMillis(2) // v1+
    22  // ErrorCode is the error for the leave group request.
    23  //
    24  // GROUP_AUTHORIZATION_FAILED is returned if the client is not authorized
    25  // to the group (no read perms).
    26  //
    27  // INVALID_GROUP_ID is returned in the requested group ID is invalid.
    28  //
    29  // COORDINATOR_NOT_AVAILABLE is returned if the coordinator is not available
    30  // (due to the requested broker shutting down or it has not completed startup).
    31  //
    32  // COORDINATOR_LOAD_IN_PROGRESS is returned if the group is loading.
    33  //
    34  // NOT_COORDINATOR is returned if the requested broker is not the coordinator
    35  // for the requested group.
    36  //
    37  // UNKNOWN_MEMBER_ID is returned if the member ID is not a part of the group,
    38  // or if the group is empty or dead.
    39  ErrorCode: int16
    40  // Members are the list of members and group instance IDs that left the group.
    41  Members: [=>] // v3+
    42    MemberID: string
    43    InstanceID: nullable-string
    44    // An individual member's leave error code.
    45    ErrorCode: int16

View as plain text