...

Text file src/github.com/twmb/franz-go/generate/definitions/10_find_coordinator

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

     1// FindCoordinatorRequest requests the coordinator for a group or transaction.
     2//
     3// This coordinator is different from the broker leader coordinator. This
     4// coordinator is the partition leader for the partition that is storing
     5// the group or transaction ID.
     6FindCoordinatorRequest => key 10, max version 4, flexible v3+
     7  // CoordinatorKey is the ID to use for finding the coordinator. For groups,
     8  // this is the group name, for transactional producer, this is the
     9  // transactional ID.
    10  CoordinatorKey: string // v0-v3
    11  // CoordinatorType is the type that key is. Groups are type 0,
    12  // transactional IDs are type 1.
    13  CoordinatorType: int8 // v1+
    14  // CoordinatorKeys contains all keys to find the coordinator for.
    15  CoordinatorKeys: [string] // v4+
    16
    17// FindCoordinatorResponse is returned from a FindCoordinatorRequest.
    18FindCoordinatorResponse =>
    19  ThrottleMillis(2) // v1+
    20  // ErrorCode is the error returned for the request.
    21  //
    22  // GROUP_AUTHORIZATION_FAILED is returned if for a group ID request and the
    23  // client is not authorized to describe groups.
    24  //
    25  // TRANSACTIONAL_ID_AUTHORIZATION_FAILED is returned for a transactional ID
    26  // request and the client is not authorized to describe transactional IDs.
    27  //
    28  // INVALID_REQUEST is returned if not asking for a known type (group,
    29  // or transaction).
    30  //
    31  // COORDINATOR_NOT_AVAILABLE is returned if the coordinator is not available
    32  // for the requested ID, which would be if the group or transactional topic
    33  // does not exist or the partition the requested key maps to is not available.
    34  ErrorCode: int16 // v0-v3
    35  // ErrorMessage is an informative message if the request errored.
    36  ErrorMessage: nullable-string // v1-v3
    37  // NodeID is the broker ID of the coordinator.
    38  NodeID: int32 // v0-v3
    39  // Host is the host of the coordinator.
    40  Host: string // v0-v3
    41  // Port is the port of the coordinator.
    42  Port: int32 // v0-v3
    43  // Coordinators, introduced for KIP-699, is the bulk response for
    44  // coordinators. The fields in the struct exactly match the original fields
    45  // in the FindCoordinatorResponse, thus they are left undocumented.
    46  Coordinators: [=>] // v4+
    47    Key: string
    48    NodeID: int32
    49    Host: string
    50    Port: int32
    51    ErrorCode: int16
    52    ErrorMessage: nullable-string

View as plain text