View Source KlifeProtocol.Messages.JoinGroup (Klife Protocol v0.5.0)
Kafka protocol JoinGroup message
Request versions summary:
- Version 1 adds RebalanceTimeoutMs.
- Version 2 and 3 are the same as version 1.
- Starting from version 4, the client needs to issue a second request to join group
- Starting from version 5, we add a new field called groupInstanceId to indicate member identity across restarts. with assigned id.
- Version 6 is the first flexible version.
- Version 7 is the same as version 6.
- Version 8 adds the Reason field (KIP-800).
- Version 9 is the same as version 8.
Response versions summary:
- Version 1 is the same as version 0.
- Version 2 adds throttle time.
- Starting in version 3, on quota violation, brokers send out responses before throttling.
- Starting in version 4, the client needs to issue a second request to join group with assigned id.
- Version 5 is bumped to apply group.instance.id to identify member across restarts.
- Version 6 is the first flexible version.
- Starting from version 7, the broker sends back the Protocol Type to the client (KIP-559).
- Version 8 is the same as version 7.
- Version 9 adds the SkipAssignment field.
Link to this section Summary
Functions
Returns the message api key number.
Receive a binary in the kafka wire format and deserialize it into a map.
Returns the current max supported version of this message.
Returns the current min supported version of this message.
Receives a map and serialize it to kafka wire format of the given version.
Link to this section Functions
Returns the message api key number.
Receive a binary in the kafka wire format and deserialize it into a map.
Response content fields:
throttle_time_ms: The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 2+)
error_code: The error code, or 0 if there was no error. (int16 | versions 0+)
generation_id: The generation ID of the group. (int32 | versions 0+)
protocol_type: The group protocol name. (string | versions 7+)
protocol_name: The group protocol selected by the coordinator. (string | versions 0+)
leader: The leader of the group. (string | versions 0+)
skip_assignment: True if the leader must skip running the assignment. (bool | versions 9+)
member_id: The member ID assigned by the group coordinator. (string | versions 0+)
members: ([]JoinGroupResponseMember | versions 0+)
member_id: The group member ID. (string | versions 0+)
group_instance_id: The unique identifier of the consumer instance provided by end user. (string | versions 5+)
metadata: The group member metadata. (bytes | versions 0+)
Returns the current max supported version of this message.
Returns the current min supported version of this message.
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
group_id: The group identifier. (string | versions 0+)
session_timeout_ms: The coordinator considers the consumer dead if it receives no heartbeat after this timeout in milliseconds. (int32 | versions 0+)
rebalance_timeout_ms: The maximum time in milliseconds that the coordinator will wait for each member to rejoin when rebalancing the group. (int32 | versions 1+)
member_id: The member id assigned by the group coordinator. (string | versions 0+)
group_instance_id: The unique identifier of the consumer instance provided by end user. (string | versions 5+)
protocol_type: The unique name the for class of protocols implemented by the group we want to join. (string | versions 0+)
protocols: The list of protocols that the member supports. ([]JoinGroupRequestProtocol | versions 0+)
name: The protocol name. (string | versions 0+)
metadata: The protocol metadata. (bytes | versions 0+)
reason: The reason why the member (re-)joins the group. (string | versions 8+)