THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
- Checks wether the group exists. If it does not, GROUP_ID_NOT_FOUND is returned.
- Checks wether the member exists. If it does not, UNKNOWN_MEMBER_ID is returned.
- Checks wether the member epoch matches the current member epoch. If it does not, STALE_MEMBER_EPOCH is returned.
- Checks wether the member is the chosen one to compute the assignment. If it does not, UNKNOWN_MEMBER_ID is returned.
- Returns the group state of the group.
Response Schema
The response always contains both the topic id and the topic name. This is to ensure that the client-side assignor gets all the information that it needs to compute the assignment and does not have any local dependencies (e.g. metadata cache). We want the client-side assignor to be fast and independent. Moreover, topic names are required for Streams' assignor in order to map them to the topology which is based on topic names.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiKey": TBD,
"type": "response",
"name": "ConsumerGroupPrepareAssignmentResponse",
"validVersions": "0",
"flexibleVersions": "0+",
// Supported errors:
// - GROUP_AUTHORIZATION_FAILED
// - NOT_COORDINATOR
// - COORDINATOR_NOT_AVAILABLE
// - COORDINATOR_LOAD_IN_PROGRESS
// - INVALID_REQUEST
// - INVALID_GROUP_ID
// - GROUP_ID_NOT_FOUND
// - UNKNOWN_MEMBER_ID
// - STALE_MEMBER_EPOCH
"fields": [
{ "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
"about": "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." },
{ "name": "ErrorCode", "type": "int16", "versions": "0+",
"about": "The top-level error code, or 0 if there was no error" },
{ "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
"about": "The top-level error message, or null if there was no error." },
{ "name": "GroupEpoch", "type": "int32", "versions": "0+",
"about": "The group epoch." },
{ "name": "AssignorName", "type": "string", "versions": "0+",
"about": "The selected assignor." },
{ "name": "Members", "type": "[]Member", "versions": "0+",
"about": "The members.", "fields": [
{ "name": "MemberId", "type": "string", "versions": "0+",
"about": "The member ID." },
{ "name": "MemberEpoch", "type": "int32", "versions": "0+",
"about": "The member epoch." },
{ "name": "InstanceId", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
"about": "The member instance ID." },
{ "name": "RackId", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
",
"about": "The member instance ID." },
{ "name": "SubscribedTopics", "type": "[]SubscribedTopic", "versions": "0+",
"about": "The subscribed topic IDs.", "fields": [
{ "name": "TopicId", "type": "uuid", "versions": "0+",
"about": "The membertopic instance ID." },
{ "name": "SubscribedTopicIdsTopicName", "type": "[]uuidstring", "versions": "0+",
"about": "The subscribed topic IDsname." }
]},
{ "name": "Assignor", "type": "Assignor", "versions": "0+",
"about": "The information of the selected assignor",
"fields": [
{ "name": "VersionReason", "type": "int16int8", "versions": "0+",
"about": "The versionreason of the metadata update." },
{ "name": "ReasonMetadataVersion", "type": "int8int16", "versions": "0+",
"about": "The reasonversion of the metadata update." },
{ "name": "MetadataMetadataBytes", "type": "bytes", "versions": "0+",
"about": "The assignor metadata." }
]},
{ "name": "TopicPartitions", "type": "[]TopicPartition", "versions": "0+",
"about": "The target topic-partitions of the member.",
"fields": [
{ "name": "TopicId", "type": "uuid", "versions": "0+",
"about": "The topic ID." },
{ "name": "TopicName", "type": "string", "versions": "0+",
"about": "The topic name." },
{ "name": "Partitions", "type": "[]int32", "versions": "0+",
"about": "The partitions." }
]}
]},
{ "name": "Topics", "type": "[]TopicMetadata", "versions": "0+",
"about": "The topic-partition metadata.",
"fields": [
{ "name": "TopicId", "type": "uuid", "versions": "0+",
"about": "The topic ID." },
{ "name": "TopicName", "type": "string", "versions": "0+",
"about": "The topic name." },
{ "name": "NumPartitions", "type": "int32", "versions": "0+",
"about": "The number of partitions." }
]}
]
}
|
Response Handling
If the response contains no error, the member calls the client side assignor with the group state.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiKey": TBD,
"type": "request",
"listeners": ["zkBroker", "broker"],
"name": "ConsumerGroupInstallAssignmentRequest",
"validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "GroupId", "type": "string", "versions": "0+", "entityType": "groupId",
"about": "The group identifier." },
{ "name": "MemberId", "type": "string", "versions": "0+",
"about": "The member id assigned by the group coordinator." },
{ "name": "MemberEpoch", "type": "int32", "versions": "0+",
"about": "The member epoch." },
{ "name": "GroupEpoch", "type": "int32", "versions": "0+",
"about": "The group epoch." },
{ "name": "Error", "type": "int8", "versions": "0+",
"about": "The assignment error; or zero if the assignment is successful." },
{ "name": "Members", "type": "[]Member", "versions": "0+",
"about": "The members.", "fields": [
{ "name": "MemberId", "type": "string", "versions": "0+",
"about": "The member ID." },
{ "name": "Partitions", "type": "[]TopicPartition", "versions": "0+",
"about": "The assigned topic-partitions to the member.",
"fields": [
{ "name": "TopicId", "type": "uuid", "versions": "0+",
"about": "The topic ID." },
{ "name": "Partitions", "type": "[]int32", "versions": "0+",
"about": "The partitions." }
]},
{ "name": "VersionMetadataVersion", "type": "int32", "versions": "0+",
"about": "The metadata version." }
{ "name": "MetadataMetadataBytes", "type": "bytes", "versions": "0+",
"about": "The metadata bytes." }
]}
]
} |
...