kafka-clients 1.0 内部请求接口文档
2019-08-07 19:51 chen.simon 阅读(330) 评论(0) 编辑 收藏 举报AddOffsetsToTxnRequest
version:0
| name | type | defaultValue | docString |
| transactional_id | STRING | null | The transactional id corresponding to the transaction. |
| producer_id | INT64 | null | Current producer id in use by the transactional id. |
| producer_epoch | INT16 | null | Current epoch associated with the producer id. |
| group_id | STRING | null | The unique group identifier |
AddPartitionsToTxnRequest
version:0
| name | type | defaultValue | docString |
| transactional_id | STRING | null | The transactional id corresponding to the transaction. |
| producer_id | INT64 | null | Current producer id in use by the transactional id. |
| producer_epoch | INT16 | null | Current epoch associated with the producer id. |
| topics | ARRAY({topic:STRING,partitions:ARRAY(INT32)}) | null | The partitions to add to the transaction. |
AlterConfigsRequest
version:0
| name | type | defaultValue | docString |
| resources | ARRAY({resource_type:INT8,resource_name:STRING,config_entries:ARRAY({config_name:STRING,config_value:NULLABLE_STRING})}) | null | An array of resources to update with the provided configs. |
| validate_only | BOOLEAN | null | null |
AlterReplicaLogDirsRequest
version:0
| name | type | defaultValue | docString |
| log_dirs | ARRAY({log_dir:STRING,topics:ARRAY({topic:STRING,partitions:ARRAY(INT32)})}) | null | null |
ApiVersionsRequest
version:0
| name | type | defaultValue | docString |
version:1
| name | type | defaultValue | docString |
ControlledShutdownRequest
version:0
| name | type | defaultValue | docString |
| broker_id | INT32 | null | The id of the broker for which controlled shutdown has been requested. |
version:1
| name | type | defaultValue | docString |
| broker_id | INT32 | null | The id of the broker for which controlled shutdown has been requested. |
CreateAclsRequest
version:0
| name | type | defaultValue | docString |
| creations | ARRAY({resource_type:INT8,resource_name:STRING,principal:STRING,host:STRING,operation:INT8,permission_type:INT8}) | null | null |
CreatePartitionsRequest
version:0
| name | type | defaultValue | docString |
| topic_partitions | ARRAY({topic:STRING,new_partitions:{count:INT32,assignment:ARRAY(ARRAY(INT32))}}) | null | List of topic and the corresponding new partitions. |
| timeout | INT32 | null | The time in ms to wait for the partitions to be created. |
| validate_only | BOOLEAN | null | If true then validate the request, but don't actually increase the number of partitions. |
CreateTopicsRequest
version:0
| name | type | defaultValue | docString |
| create_topic_requests | ARRAY({topic:STRING,num_partitions:INT32,replication_factor:INT16,replica_assignment:ARRAY({partition:INT32,replicas:ARRAY(INT32)}),config_entries:ARRAY({config_name:STRING,config_value:NULLABLE_STRING})}) | null | An array of single topic creation requests. Can not have multiple entries for the same topic. |
| timeout | INT32 | null | The time in ms to wait for a topic to be completely created on the controller node. Values <= 0 will trigger topic creation and return immediately |
version:1
| name | type | defaultValue | docString |
| create_topic_requests | ARRAY({topic:STRING,num_partitions:INT32,replication_factor:INT16,replica_assignment:ARRAY({partition:INT32,replicas:ARRAY(INT32)}),config_entries:ARRAY({config_name:STRING,config_value:NULLABLE_STRING})}) | null | An array of single topic creation requests. Can not have multiple entries for the same topic. |
| timeout | INT32 | null | The time in ms to wait for a topic to be completely created on the controller node. Values <= 0 will trigger topic creation and return immediately |
| validate_only | BOOLEAN | null | If this is true, the request will be validated, but the topic won't be created. |
version:2
| name | type | defaultValue | docString |
| create_topic_requests | ARRAY({topic:STRING,num_partitions:INT32,replication_factor:INT16,replica_assignment:ARRAY({partition:INT32,replicas:ARRAY(INT32)}),config_entries:ARRAY({config_name:STRING,config_value:NULLABLE_STRING})}) | null | An array of single topic creation requests. Can not have multiple entries for the same topic. |
| timeout | INT32 | null | The time in ms to wait for a topic to be completely created on the controller node. Values <= 0 will trigger topic creation and return immediately |
| validate_only | BOOLEAN | null | If this is true, the request will be validated, but the topic won't be created. |
DeleteAclsRequest
version:0
| name | type | defaultValue | docString |
| filters | ARRAY({resource_type:INT8,resource_name:NULLABLE_STRING,principal:NULLABLE_STRING,host:NULLABLE_STRING,operation:INT8,permission_type:INT8}) | null | null |
DeleteRecordsRequest
version:0
| name | type | defaultValue | docString |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64})}) | null | null |
| timeout | INT32 | null | The maximum time to await a response in ms. |
DeleteTopicsRequest
version:0
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to be deleted. |
| timeout | INT32 | null | The time in ms to wait for a topic to be completely deleted on the controller node. Values <= 0 will trigger topic deletion and return immediately |
version:1
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to be deleted. |
| timeout | INT32 | null | The time in ms to wait for a topic to be completely deleted on the controller node. Values <= 0 will trigger topic deletion and return immediately |
DescribeAclsRequest
version:0
| name | type | defaultValue | docString |
| resource_type | INT8 | null | The resource type |
| resource_name | NULLABLE_STRING | null | The resource name filter |
| principal | NULLABLE_STRING | null | The ACL principal filter |
| host | NULLABLE_STRING | null | The ACL host filter |
| operation | INT8 | null | The ACL operation |
| permission_type | INT8 | null | The ACL permission type |
DescribeConfigsRequest
version:0
| name | type | defaultValue | docString |
| resources | ARRAY({resource_type:INT8,resource_name:STRING,config_names:ARRAY(STRING)}) | null | An array of config resources to be returned. |
DescribeGroupsRequest
version:0
| name | type | defaultValue | docString |
| group_ids | ARRAY(STRING) | null | List of groupIds to request metadata for (an empty groupId array will return empty group metadata). |
version:1
| name | type | defaultValue | docString |
| group_ids | ARRAY(STRING) | null | List of groupIds to request metadata for (an empty groupId array will return empty group metadata). |
DescribeLogDirsRequest
version:0
| name | type | defaultValue | docString |
| topics | ARRAY({topic:STRING,partitions:ARRAY(INT32)}) | null | null |
EndTxnRequest
version:0
| name | type | defaultValue | docString |
| transactional_id | STRING | null | The transactional id corresponding to the transaction. |
| producer_id | INT64 | null | Current producer id in use by the transactional id. |
| producer_epoch | INT16 | null | Current epoch associated with the producer id. |
| transaction_result | BOOLEAN | null | The result of the transaction (0 = ABORT, 1 = COMMIT) |
FetchRequest
version:0
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch. |
version:1
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch. |
version:2
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch. |
version:3
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| max_bytes | INT32 | null | Maximum bytes to accumulate in the response. Note that this is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that progress can be made. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch in the order provided. |
version:4
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| max_bytes | INT32 | null | Maximum bytes to accumulate in the response. Note that this is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that progress can be made. |
| isolation_level | INT8 | null | This setting controls the visibility of transactional records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records visible. With READ_COMMITTED (isolation_level = 1), non-transactional and COMMITTED transactional records are visible. To be more concrete, READ_COMMITTED returns all data from offsets smaller than the current LSO (last stable offset), and enables the inclusion of the list of aborted transactions in the result, which allows consumers to discard ABORTED transactional records |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch in the order provided. |
version:5
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| max_bytes | INT32 | null | Maximum bytes to accumulate in the response. Note that this is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that progress can be made. |
| isolation_level | INT8 | null | This setting controls the visibility of transactional records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records visible. With READ_COMMITTED (isolation_level = 1), non-transactional and COMMITTED transactional records are visible. To be more concrete, READ_COMMITTED returns all data from offsets smaller than the current LSO (last stable offset), and enables the inclusion of the list of aborted transactions in the result, which allows consumers to discard ABORTED transactional records |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,log_start_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch in the order provided. |
version:6
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| max_wait_time | INT32 | null | Maximum time in ms to wait for the response. |
| min_bytes | INT32 | null | Minimum bytes to accumulate in the response. |
| max_bytes | INT32 | null | Maximum bytes to accumulate in the response. Note that this is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that progress can be made. |
| isolation_level | INT8 | null | This setting controls the visibility of transactional records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records visible. With READ_COMMITTED (isolation_level = 1), non-transactional and COMMITTED transactional records are visible. To be more concrete, READ_COMMITTED returns all data from offsets smaller than the current LSO (last stable offset), and enables the inclusion of the list of aborted transactions in the result, which allows consumers to discard ABORTED transactional records |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,fetch_offset:INT64,log_start_offset:INT64,max_bytes:INT32})}) | null | Topics to fetch in the order provided. |
FindCoordinatorRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
version:1
| name | type | defaultValue | docString |
| coordinator_key | STRING | null | Id to use for finding the coordinator (for groups, this is the groupId, for transactional producers, this is the transactional id) |
| coordinator_type | INT8 | null | The type of coordinator to find (0 = group, 1 = transaction) |
HeartbeatRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
InitProducerIdRequest
version:0
| name | type | defaultValue | docString |
| transactional_id | NULLABLE_STRING | null | The transactional id or null if the producer is not transactional |
| transaction_timeout_ms | INT32 | null | The time in ms to wait for before aborting idle transactions sent by this producer. |
JoinGroupRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| session_timeout | INT32 | null | The coordinator considers the consumer dead if it receives no heartbeat after this timeout in ms. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| protocol_type | STRING | null | Unique name for class of protocols implemented by group |
| group_protocols | ARRAY({protocol_name:STRING,protocol_metadata:BYTES}) | null | List of protocols that the member supports |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| session_timeout | INT32 | null | The coordinator considers the consumer dead if it receives no heartbeat after this timeout in ms. |
| rebalance_timeout | INT32 | null | The maximum time that the coordinator will wait for each member to rejoin when rebalancing the group |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| protocol_type | STRING | null | Unique name for class of protocols implemented by group |
| group_protocols | ARRAY({protocol_name:STRING,protocol_metadata:BYTES}) | null | List of protocols that the member supports |
version:2
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| session_timeout | INT32 | null | The coordinator considers the consumer dead if it receives no heartbeat after this timeout in ms. |
| rebalance_timeout | INT32 | null | The maximum time that the coordinator will wait for each member to rejoin when rebalancing the group |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| protocol_type | STRING | null | Unique name for class of protocols implemented by group |
| group_protocols | ARRAY({protocol_name:STRING,protocol_metadata:BYTES}) | null | List of protocols that the member supports |
LeaderAndIsrRequest
version:0
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32)}) | null | null |
| live_leaders | ARRAY({id:INT32,host:STRING,port:INT32}) | null | null |
version:1
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32),is_new:BOOLEAN}) | null | null |
| live_leaders | ARRAY({id:INT32,host:STRING,port:INT32}) | null | null |
LeaveGroupRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
ListGroupsRequest
version:0
| name | type | defaultValue | docString |
version:1
| name | type | defaultValue | docString |
ListOffsetRequest
version:0
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,timestamp:INT64,max_num_offsets:INT32})}) | null | Topics to list offsets. |
version:1
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,timestamp:INT64})}) | null | Topics to list offsets. |
version:2
| name | type | defaultValue | docString |
| replica_id | INT32 | null | Broker id of the follower. For normal consumers, use -1. |
| isolation_level | INT8 | null | This setting controls the visibility of transactional records. Using READ_UNCOMMITTED (isolation_level = 0) makes all records visible. With READ_COMMITTED (isolation_level = 1), non-transactional and COMMITTED transactional records are visible. To be more concrete, READ_COMMITTED returns all data from offsets smaller than the current LSO (last stable offset), and enables the inclusion of the list of aborted transactions in the result, which allows consumers to discard ABORTED transactional records |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,timestamp:INT64})}) | null | Topics to list offsets. |
MetadataRequest
version:0
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If no topics are specified fetch metadata for all topics. |
version:1
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics. |
version:2
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics. |
version:3
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics. |
version:4
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics. |
| allow_auto_topic_creation | BOOLEAN | null | If this and the broker config 'auto.create.topics.enable' are true, topics that don't exist will be created by the broker. Otherwise, no topics will be created by the broker. |
version:5
| name | type | defaultValue | docString |
| topics | ARRAY(STRING) | null | An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics. |
| allow_auto_topic_creation | BOOLEAN | null | If this and the broker config 'auto.create.topics.enable' are true, topics that don't exist will be created by the broker. Otherwise, no topics will be created by the broker. |
OffsetCommitRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64,metadata:NULLABLE_STRING})}) | null | Topics to commit offsets. |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64,timestamp:INT64,metadata:NULLABLE_STRING})}) | null | Topics to commit offsets. |
version:2
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| retention_time | INT64 | null | Time period in ms to retain the offset. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64,metadata:NULLABLE_STRING})}) | null | Topics to commit offsets. |
version:3
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| retention_time | INT64 | null | Time period in ms to retain the offset. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64,metadata:NULLABLE_STRING})}) | null | Topics to commit offsets. |
OffsetFetchRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32})}) | null | Topics to fetch offsets. |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32})}) | null | Topics to fetch offsets. |
version:2
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32})}) | null | Topics to fetch offsets. If the topic array is null fetch offsets for all topics. |
version:3
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32})}) | null | Topics to fetch offsets. If the topic array is null fetch offsets for all topics. |
OffsetsForLeaderEpochRequest
version:0
| name | type | defaultValue | docString |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,leader_epoch:INT32})}) | null | An array of topics to get epochs for |
ProduceRequest
version:0
| name | type | defaultValue | docString |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
version:1
| name | type | defaultValue | docString |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
version:2
| name | type | defaultValue | docString |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
version:3
| name | type | defaultValue | docString |
| transactional_id | NULLABLE_STRING | null | The transactional id or null if the producer is not transactional |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
version:4
| name | type | defaultValue | docString |
| transactional_id | NULLABLE_STRING | null | The transactional id or null if the producer is not transactional |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
version:5
| name | type | defaultValue | docString |
| transactional_id | NULLABLE_STRING | null | The transactional id or null if the producer is not transactional |
| acks | INT16 | null | The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments, 1 for only the leader and -1 for the full ISR. |
| timeout | INT32 | null | The time to await a response in ms. |
| topic_data | ARRAY({topic:STRING,data:ARRAY({partition:INT32,record_set:RECORDS})}) | null | null |
SaslAuthenticateRequest
version:0
| name | type | defaultValue | docString |
| sasl_auth_bytes | BYTES | null | SASL authentication bytes from client as defined by the SASL mechanism. |
SaslHandshakeRequest
version:0
| name | type | defaultValue | docString |
| mechanism | STRING | null | SASL Mechanism chosen by the client. |
version:1
| name | type | defaultValue | docString |
| mechanism | STRING | null | SASL Mechanism chosen by the client. |
StopReplicaRequest
version:0
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| delete_partitions | BOOLEAN | null | Boolean which indicates if replica's partitions must be deleted. |
| partitions | ARRAY({topic:STRING,partition:INT32}) | null | null |
SyncGroupRequest
version:0
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| group_assignment | ARRAY({member_id:STRING,member_assignment:BYTES}) | null | null |
version:1
| name | type | defaultValue | docString |
| group_id | STRING | null | The unique group identifier |
| generation_id | INT32 | null | The generation of the group. |
| member_id | STRING | null | The member id assigned by the group coordinator or null if joining for the first time. |
| group_assignment | ARRAY({member_id:STRING,member_assignment:BYTES}) | null | null |
TxnOffsetCommitRequest
version:0
| name | type | defaultValue | docString |
| transactional_id | STRING | null | The transactional id corresponding to the transaction. |
| group_id | STRING | null | The unique group identifier |
| producer_id | INT64 | null | Current producer id in use by the transactional id. |
| producer_epoch | INT16 | null | Current epoch associated with the producer id. |
| topics | ARRAY({topic:STRING,partitions:ARRAY({partition:INT32,offset:INT64,metadata:NULLABLE_STRING})}) | null | The partitions to write markers for. |
UpdateMetadataRequest
version:0
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32)}) | null | null |
| live_brokers | ARRAY({id:INT32,host:STRING,port:INT32}) | null | null |
version:1
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32)}) | null | null |
| live_brokers | ARRAY({id:INT32,end_points:ARRAY({port:INT32,host:STRING,security_protocol_type:INT16})}) | null | null |
version:2
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32)}) | null | null |
| live_brokers | ARRAY({id:INT32,end_points:ARRAY({port:INT32,host:STRING,security_protocol_type:INT16}),rack:NULLABLE_STRING}) | null | null |
version:3
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32)}) | null | null |
| live_brokers | ARRAY({id:INT32,end_points:ARRAY({port:INT32,host:STRING,listener_name:STRING,security_protocol_type:INT16}),rack:NULLABLE_STRING}) | null | null |
version:4
| name | type | defaultValue | docString |
| controller_id | INT32 | null | The controller id. |
| controller_epoch | INT32 | null | The controller epoch. |
| partition_states | ARRAY({topic:STRING,partition:INT32,controller_epoch:INT32,leader:INT32,leader_epoch:INT32,isr:ARRAY(INT32),zk_version:INT32,replicas:ARRAY(INT32),offline_replicas:ARRAY(INT32)}) | null | null |
| live_brokers | ARRAY({id:INT32,end_points:ARRAY({port:INT32,host:STRING,listener_name:STRING,security_protocol_type:INT16}),rack:NULLABLE_STRING}) | null | null |
WriteTxnMarkersRequest
version:0
| name | type | defaultValue | docString |
| transaction_markers | ARRAY({producer_id:INT64,producer_epoch:INT16,transaction_result:BOOLEAN,topics:ARRAY({topic:STRING,partitions:ARRAY(INT32)}),coordinator_epoch:INT32}) | null | The transaction markers to be written. |
