http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/generated/protocol_messages.html ---------------------------------------------------------------------- diff --git a/10/generated/protocol_messages.html b/10/generated/protocol_messages.html new file mode 100644 index 0000000..e9cc1c7 --- /dev/null +++ b/10/generated/protocol_messages.html @@ -0,0 +1,4345 @@ +<h5>Headers:</h5> +<pre>Request Header => api_key api_version correlation_id client_id + api_key => INT16 + api_version => INT16 + correlation_id => INT32 + client_id => NULLABLE_STRING +</pre> +<table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>api_key</td><td>The id of the request type.</td></tr> +<tr> +<td>api_version</td><td>The version of the API.</td></tr> +<tr> +<td>correlation_id</td><td>A user-supplied integer value that will be passed back with the response</td></tr> +<tr> +<td>client_id</td><td>A user specified identifier for the client making the request.</td></tr> +</table> +<pre>Response Header => correlation_id + correlation_id => INT32 +</pre> +<table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>correlation_id</td><td>The user-supplied value passed in with the request</td></tr> +</table> +<h5><a name="The_Messages_Produce">Produce API (Key: 0):</a></h5> + +<b>Requests:</b><br> +<p><pre>Produce Request (Version: 0) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 1) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 2) => acks timeout [topic_data] + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 3) => transactional_id acks timeout [topic_data] + transactional_id => NULLABLE_STRING + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>transactional_id</td><td>The transactional id or null if the producer is not transactional</td></tr> +<tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 4) => transactional_id acks timeout [topic_data] + transactional_id => NULLABLE_STRING + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>transactional_id</td><td>The transactional id or null if the producer is not transactional</td></tr> +<tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Request (Version: 5) => transactional_id acks timeout [topic_data] + transactional_id => NULLABLE_STRING + acks => INT16 + timeout => INT32 + topic_data => topic [data] + topic => STRING + data => partition record_set + partition => INT32 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>transactional_id</td><td>The transactional id or null if the producer is not transactional</td></tr> +<tr> +<td>acks</td><td>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.</td></tr> +<tr> +<td>timeout</td><td>The time to await a response in ms.</td></tr> +<tr> +<td>topic_data</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>data</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Produce Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset + partition => INT32 + error_code => INT16 + base_offset => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 1) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset + partition => INT32 + error_code => INT16 + base_offset => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 2) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset log_append_time + partition => INT32 + error_code => INT16 + base_offset => INT64 + log_append_time => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +<tr> +<td>log_append_time</td><td>The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended.</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 3) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset log_append_time + partition => INT32 + error_code => INT16 + base_offset => INT64 + log_append_time => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +<tr> +<td>log_append_time</td><td>The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended.</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 4) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset log_append_time + partition => INT32 + error_code => INT16 + base_offset => INT64 + log_append_time => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +<tr> +<td>log_append_time</td><td>The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended.</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +</table> +</p> +<p><pre>Produce Response (Version: 5) => [responses] throttle_time_ms + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code base_offset log_append_time log_start_offset + partition => INT32 + error_code => INT16 + base_offset => INT64 + log_append_time => INT64 + log_start_offset => INT64 + throttle_time_ms => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>base_offset</td><td>null</td></tr> +<tr> +<td>log_append_time</td><td>The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended.</td></tr> +<tr> +<td>log_start_offset</td><td>The start offset of the log at the time this produce response was created</td></tr> +<tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +</table> +</p> +<h5><a name="The_Messages_Fetch">Fetch API (Key: 1):</a></h5> + +<b>Requests:</b><br> +<p><pre>Fetch Request (Version: 0) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 1) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 2) => replica_id max_wait_time min_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 3) => replica_id max_wait_time min_bytes max_bytes [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + max_bytes => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>max_bytes</td><td>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.</td></tr> +<tr> +<td>topics</td><td>Topics to fetch in the order provided.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 4) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + max_bytes => INT32 + isolation_level => INT8 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset max_bytes + partition => INT32 + fetch_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>max_bytes</td><td>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.</td></tr> +<tr> +<td>isolation_level</td><td>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</td></tr> +<tr> +<td>topics</td><td>Topics to fetch in the order provided.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 5) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + max_bytes => INT32 + isolation_level => INT8 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset log_start_offset max_bytes + partition => INT32 + fetch_offset => INT64 + log_start_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>max_bytes</td><td>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.</td></tr> +<tr> +<td>isolation_level</td><td>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</td></tr> +<tr> +<td>topics</td><td>Topics to fetch in the order provided.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>log_start_offset</td><td>Earliest available offset of the follower replica. The field is only used when request is sent by follower. </td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<p><pre>Fetch Request (Version: 6) => replica_id max_wait_time min_bytes max_bytes isolation_level [topics] + replica_id => INT32 + max_wait_time => INT32 + min_bytes => INT32 + max_bytes => INT32 + isolation_level => INT8 + topics => topic [partitions] + topic => STRING + partitions => partition fetch_offset log_start_offset max_bytes + partition => INT32 + fetch_offset => INT64 + log_start_offset => INT64 + max_bytes => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>max_wait_time</td><td>Maximum time in ms to wait for the response.</td></tr> +<tr> +<td>min_bytes</td><td>Minimum bytes to accumulate in the response.</td></tr> +<tr> +<td>max_bytes</td><td>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.</td></tr> +<tr> +<td>isolation_level</td><td>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</td></tr> +<tr> +<td>topics</td><td>Topics to fetch in the order provided.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>fetch_offset</td><td>Message offset.</td></tr> +<tr> +<td>log_start_offset</td><td>Earliest available offset of the follower replica. The field is only used when request is sent by follower. </td></tr> +<tr> +<td>max_bytes</td><td>Maximum bytes to fetch.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Fetch Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 1) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 2) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 3) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark + partition => INT32 + error_code => INT16 + high_watermark => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 4) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark last_stable_offset [aborted_transactions] + partition => INT32 + error_code => INT16 + high_watermark => INT64 + last_stable_offset => INT64 + aborted_transactions => producer_id first_offset + producer_id => INT64 + first_offset => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>last_stable_offset</td><td>The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)</td></tr> +<tr> +<td>aborted_transactions</td><td>null</td></tr> +<tr> +<td>producer_id</td><td>The producer id associated with the aborted transactions</td></tr> +<tr> +<td>first_offset</td><td>The first offset in the aborted transaction</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 5) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark last_stable_offset log_start_offset [aborted_transactions] + partition => INT32 + error_code => INT16 + high_watermark => INT64 + last_stable_offset => INT64 + log_start_offset => INT64 + aborted_transactions => producer_id first_offset + producer_id => INT64 + first_offset => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>last_stable_offset</td><td>The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)</td></tr> +<tr> +<td>log_start_offset</td><td>Earliest available offset.</td></tr> +<tr> +<td>aborted_transactions</td><td>null</td></tr> +<tr> +<td>producer_id</td><td>The producer id associated with the aborted transactions</td></tr> +<tr> +<td>first_offset</td><td>The first offset in the aborted transaction</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<p><pre>Fetch Response (Version: 6) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition_header record_set + partition_header => partition error_code high_watermark last_stable_offset log_start_offset [aborted_transactions] + partition => INT32 + error_code => INT16 + high_watermark => INT64 + last_stable_offset => INT64 + log_start_offset => INT64 + aborted_transactions => producer_id first_offset + producer_id => INT64 + first_offset => INT64 + record_set => RECORDS +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition_header</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>high_watermark</td><td>Last committed offset.</td></tr> +<tr> +<td>last_stable_offset</td><td>The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)</td></tr> +<tr> +<td>log_start_offset</td><td>Earliest available offset.</td></tr> +<tr> +<td>aborted_transactions</td><td>null</td></tr> +<tr> +<td>producer_id</td><td>The producer id associated with the aborted transactions</td></tr> +<tr> +<td>first_offset</td><td>The first offset in the aborted transaction</td></tr> +<tr> +<td>record_set</td><td>null</td></tr> +</table> +</p> +<h5><a name="The_Messages_ListOffsets">ListOffsets API (Key: 2):</a></h5> + +<b>Requests:</b><br> +<p><pre>ListOffsets Request (Version: 0) => replica_id [topics] + replica_id => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition timestamp max_num_offsets + partition => INT32 + timestamp => INT64 + max_num_offsets => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>topics</td><td>Topics to list offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to list offset.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>timestamp</td><td>Timestamp.</td></tr> +<tr> +<td>max_num_offsets</td><td>Maximum offsets to return.</td></tr> +</table> +</p> +<p><pre>ListOffsets Request (Version: 1) => replica_id [topics] + replica_id => INT32 + topics => topic [partitions] + topic => STRING + partitions => partition timestamp + partition => INT32 + timestamp => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>topics</td><td>Topics to list offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to list offset.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>timestamp</td><td>The target timestamp for the partition.</td></tr> +</table> +</p> +<p><pre>ListOffsets Request (Version: 2) => replica_id isolation_level [topics] + replica_id => INT32 + isolation_level => INT8 + topics => topic [partitions] + topic => STRING + partitions => partition timestamp + partition => INT32 + timestamp => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>replica_id</td><td>Broker id of the follower. For normal consumers, use -1.</td></tr> +<tr> +<td>isolation_level</td><td>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</td></tr> +<tr> +<td>topics</td><td>Topics to list offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to list offset.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>timestamp</td><td>The target timestamp for the partition.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>ListOffsets Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code [offsets] + partition => INT32 + error_code => INT16 + offsets => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>offsets</td><td>A list of offsets.</td></tr> +</table> +</p> +<p><pre>ListOffsets Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code timestamp offset + partition => INT32 + error_code => INT16 + timestamp => INT64 + offset => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>timestamp</td><td>The timestamp associated with the returned offset</td></tr> +<tr> +<td>offset</td><td>offset found</td></tr> +</table> +</p> +<p><pre>ListOffsets Response (Version: 2) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code timestamp offset + partition => INT32 + error_code => INT16 + timestamp => INT64 + offset => INT64 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>timestamp</td><td>The timestamp associated with the returned offset</td></tr> +<tr> +<td>offset</td><td>offset found</td></tr> +</table> +</p> +<h5><a name="The_Messages_Metadata">Metadata API (Key: 3):</a></h5> + +<b>Requests:</b><br> +<p><pre>Metadata Request (Version: 0) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If no topics are specified fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 1) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 2) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 3) => [topics] + topics => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 4) => [topics] allow_auto_topic_creation + topics => STRING + allow_auto_topic_creation => BOOLEAN +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +<tr> +<td>allow_auto_topic_creation</td><td>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.</td></tr> +</table> +</p> +<p><pre>Metadata Request (Version: 5) => [topics] allow_auto_topic_creation + topics => STRING + allow_auto_topic_creation => BOOLEAN +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>topics</td><td>An array of topics to fetch metadata for. If the topics array is null fetch metadata for all topics.</td></tr> +<tr> +<td>allow_auto_topic_creation</td><td>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.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>Metadata Response (Version: 0) => [brokers] [topic_metadata] + brokers => node_id host port + node_id => INT32 + host => STRING + port => INT32 + topic_metadata => error_code topic [partition_metadata] + error_code => INT16 + topic => STRING + partition_metadata => error_code partition leader [replicas] [isr] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 1) => [brokers] controller_id [topic_metadata] + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + controller_id => INT32 + topic_metadata => error_code topic is_internal [partition_metadata] + error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => error_code partition leader [replicas] [isr] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 2) => [brokers] cluster_id controller_id [topic_metadata] + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + cluster_id => NULLABLE_STRING + controller_id => INT32 + topic_metadata => error_code topic is_internal [partition_metadata] + error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => error_code partition leader [replicas] [isr] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>cluster_id</td><td>The cluster id that this broker belongs to.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 3) => throttle_time_ms [brokers] cluster_id controller_id [topic_metadata] + throttle_time_ms => INT32 + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + cluster_id => NULLABLE_STRING + controller_id => INT32 + topic_metadata => error_code topic is_internal [partition_metadata] + error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => error_code partition leader [replicas] [isr] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>cluster_id</td><td>The cluster id that this broker belongs to.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 4) => throttle_time_ms [brokers] cluster_id controller_id [topic_metadata] + throttle_time_ms => INT32 + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + cluster_id => NULLABLE_STRING + controller_id => INT32 + topic_metadata => error_code topic is_internal [partition_metadata] + error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => error_code partition leader [replicas] [isr] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>cluster_id</td><td>The cluster id that this broker belongs to.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +</table> +</p> +<p><pre>Metadata Response (Version: 5) => throttle_time_ms [brokers] cluster_id controller_id [topic_metadata] + throttle_time_ms => INT32 + brokers => node_id host port rack + node_id => INT32 + host => STRING + port => INT32 + rack => NULLABLE_STRING + cluster_id => NULLABLE_STRING + controller_id => INT32 + topic_metadata => error_code topic is_internal [partition_metadata] + error_code => INT16 + topic => STRING + is_internal => BOOLEAN + partition_metadata => error_code partition leader [replicas] [isr] [offline_replicas] + error_code => INT16 + partition => INT32 + leader => INT32 + replicas => INT32 + isr => INT32 + offline_replicas => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>brokers</td><td>Host and port information for all brokers.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>rack</td><td>The rack of the broker.</td></tr> +<tr> +<td>cluster_id</td><td>The cluster id that this broker belongs to.</td></tr> +<tr> +<td>controller_id</td><td>The broker id of the controller broker.</td></tr> +<tr> +<td>topic_metadata</td><td>null</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>is_internal</td><td>Indicates if the topic is considered a Kafka internal topic</td></tr> +<tr> +<td>partition_metadata</td><td>Metadata for each partition of the topic.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>leader</td><td>The id of the broker acting as leader for this partition.</td></tr> +<tr> +<td>replicas</td><td>The set of all nodes that host this partition.</td></tr> +<tr> +<td>isr</td><td>The set of nodes that are in sync with the leader for this partition.</td></tr> +<tr> +<td>offline_replicas</td><td>The set of offline replicas of this partition.</td></tr> +</table> +</p> +<h5><a name="The_Messages_LeaderAndIsr">LeaderAndIsr API (Key: 4):</a></h5> + +<b>Requests:</b><br> +<p><pre>LeaderAndIsr Request (Version: 0) => controller_id controller_epoch [partition_states] [live_leaders] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_leaders => id host port + id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_leaders</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<p><pre>LeaderAndIsr Request (Version: 1) => controller_id controller_epoch [partition_states] [live_leaders] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] is_new + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + is_new => BOOLEAN + live_leaders => id host port + id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>is_new</td><td>Whether the replica should have existed on the broker or not</td></tr> +<tr> +<td>live_leaders</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>LeaderAndIsr Response (Version: 0) => error_code [partitions] + error_code => INT16 + partitions => topic partition error_code + topic => STRING + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partitions</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>LeaderAndIsr Response (Version: 1) => error_code [partitions] + error_code => INT16 + partitions => topic partition error_code + topic => STRING + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partitions</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<h5><a name="The_Messages_StopReplica">StopReplica API (Key: 5):</a></h5> + +<b>Requests:</b><br> +<p><pre>StopReplica Request (Version: 0) => controller_id controller_epoch delete_partitions [partitions] + controller_id => INT32 + controller_epoch => INT32 + delete_partitions => BOOLEAN + partitions => topic partition + topic => STRING + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>delete_partitions</td><td>Boolean which indicates if replica's partitions must be deleted.</td></tr> +<tr> +<td>partitions</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>StopReplica Response (Version: 0) => error_code [partitions] + error_code => INT16 + partitions => topic partition error_code + topic => STRING + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partitions</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<h5><a name="The_Messages_UpdateMetadata">UpdateMetadata API (Key: 6):</a></h5> + +<b>Requests:</b><br> +<p><pre>UpdateMetadata Request (Version: 0) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id host port + id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 1) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id [end_points] + id => INT32 + end_points => port host security_protocol_type + port => INT32 + host => STRING + security_protocol_type => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td>null</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 2) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id [end_points] rack + id => INT32 + end_points => port host security_protocol_type + port => INT32 + host => STRING + security_protocol_type => INT16 + rack => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td>null</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +<tr> +<td>rack</td><td>The rack</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 3) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + live_brokers => id [end_points] rack + id => INT32 + end_points => port host listener_name security_protocol_type + port => INT32 + host => STRING + listener_name => STRING + security_protocol_type => INT16 + rack => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>live_brokers</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td>null</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>listener_name</td><td>The listener name.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +<tr> +<td>rack</td><td>The rack</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Request (Version: 4) => controller_id controller_epoch [partition_states] [live_brokers] + controller_id => INT32 + controller_epoch => INT32 + partition_states => topic partition controller_epoch leader leader_epoch [isr] zk_version [replicas] [offline_replicas] + topic => STRING + partition => INT32 + controller_epoch => INT32 + leader => INT32 + leader_epoch => INT32 + isr => INT32 + zk_version => INT32 + replicas => INT32 + offline_replicas => INT32 + live_brokers => id [end_points] rack + id => INT32 + end_points => port host listener_name security_protocol_type + port => INT32 + host => STRING + listener_name => STRING + security_protocol_type => INT16 + rack => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>controller_id</td><td>The controller id.</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>partition_states</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>controller_epoch</td><td>The controller epoch.</td></tr> +<tr> +<td>leader</td><td>The broker id for the leader.</td></tr> +<tr> +<td>leader_epoch</td><td>The leader epoch.</td></tr> +<tr> +<td>isr</td><td>The in sync replica ids.</td></tr> +<tr> +<td>zk_version</td><td>The ZK version.</td></tr> +<tr> +<td>replicas</td><td>The replica ids.</td></tr> +<tr> +<td>offline_replicas</td><td>The offline replica ids</td></tr> +<tr> +<td>live_brokers</td><td>null</td></tr> +<tr> +<td>id</td><td>The broker id.</td></tr> +<tr> +<td>end_points</td><td>null</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>listener_name</td><td>The listener name.</td></tr> +<tr> +<td>security_protocol_type</td><td>The security protocol type.</td></tr> +<tr> +<td>rack</td><td>The rack</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>UpdateMetadata Response (Version: 0) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 1) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 2) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 3) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>UpdateMetadata Response (Version: 4) => error_code + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<h5><a name="The_Messages_ControlledShutdown">ControlledShutdown API (Key: 7):</a></h5> + +<b>Requests:</b><br> +<p><pre>ControlledShutdown Request (Version: 0) => broker_id + broker_id => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>broker_id</td><td>The id of the broker for which controlled shutdown has been requested.</td></tr> +</table> +</p> +<p><pre>ControlledShutdown Request (Version: 1) => broker_id + broker_id => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>broker_id</td><td>The id of the broker for which controlled shutdown has been requested.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>ControlledShutdown Response (Version: 0) => error_code [partitions_remaining] + error_code => INT16 + partitions_remaining => topic partition + topic => STRING + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partitions_remaining</td><td>The partitions that the broker still leads.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<p><pre>ControlledShutdown Response (Version: 1) => error_code [partitions_remaining] + error_code => INT16 + partitions_remaining => topic partition + topic => STRING + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>partitions_remaining</td><td>The partitions that the broker still leads.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<h5><a name="The_Messages_OffsetCommit">OffsetCommit API (Key: 8):</a></h5> + +<b>Requests:</b><br> +<p><pre>OffsetCommit Request (Version: 0) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition offset metadata + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<p><pre>OffsetCommit Request (Version: 1) => group_id generation_id member_id [topics] + group_id => STRING + generation_id => INT32 + member_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition offset timestamp metadata + partition => INT32 + offset => INT64 + timestamp => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>generation_id</td><td>The generation of the group.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator or null if joining for the first time.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>timestamp</td><td>Timestamp of the commit</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<p><pre>OffsetCommit Request (Version: 2) => group_id generation_id member_id retention_time [topics] + group_id => STRING + generation_id => INT32 + member_id => STRING + retention_time => INT64 + topics => topic [partitions] + topic => STRING + partitions => partition offset metadata + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>generation_id</td><td>The generation of the group.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator or null if joining for the first time.</td></tr> +<tr> +<td>retention_time</td><td>Time period in ms to retain the offset.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<p><pre>OffsetCommit Request (Version: 3) => group_id generation_id member_id retention_time [topics] + group_id => STRING + generation_id => INT32 + member_id => STRING + retention_time => INT64 + topics => topic [partitions] + topic => STRING + partitions => partition offset metadata + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>generation_id</td><td>The generation of the group.</td></tr> +<tr> +<td>member_id</td><td>The member id assigned by the group coordinator or null if joining for the first time.</td></tr> +<tr> +<td>retention_time</td><td>Time period in ms to retain the offset.</td></tr> +<tr> +<td>topics</td><td>Topics to commit offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to commit offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Message offset to be committed.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>OffsetCommit Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetCommit Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetCommit Response (Version: 2) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetCommit Response (Version: 3) => throttle_time_ms [responses] + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition error_code + partition => INT32 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<h5><a name="The_Messages_OffsetFetch">OffsetFetch API (Key: 9):</a></h5> + +<b>Requests:</b><br> +<p><pre>OffsetFetch Request (Version: 0) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<p><pre>OffsetFetch Request (Version: 1) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<p><pre>OffsetFetch Request (Version: 2) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets. If the topic array is null fetch offsets for all topics.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<p><pre>OffsetFetch Request (Version: 3) => group_id [topics] + group_id => STRING + topics => topic [partitions] + topic => STRING + partitions => partition + partition => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +<tr> +<td>topics</td><td>Topics to fetch offsets. If the topic array is null fetch offsets for all topics.</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partitions</td><td>Partitions to fetch offsets.</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>OffsetFetch Response (Version: 0) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetFetch Response (Version: 1) => [responses] + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetFetch Response (Version: 2) => [responses] error_code + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<p><pre>OffsetFetch Response (Version: 3) => throttle_time_ms [responses] error_code + throttle_time_ms => INT32 + responses => topic [partition_responses] + topic => STRING + partition_responses => partition offset metadata error_code + partition => INT32 + offset => INT64 + metadata => NULLABLE_STRING + error_code => INT16 + error_code => INT16 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>responses</td><td>null</td></tr> +<tr> +<td>topic</td><td>Name of topic</td></tr> +<tr> +<td>partition_responses</td><td>null</td></tr> +<tr> +<td>partition</td><td>Topic partition id</td></tr> +<tr> +<td>offset</td><td>Last committed message offset.</td></tr> +<tr> +<td>metadata</td><td>Any associated metadata the client wants to keep.</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +</table> +</p> +<h5><a name="The_Messages_FindCoordinator">FindCoordinator API (Key: 10):</a></h5> + +<b>Requests:</b><br> +<p><pre>FindCoordinator Request (Version: 0) => group_id + group_id => STRING +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>group_id</td><td>The unique group identifier</td></tr> +</table> +</p> +<p><pre>FindCoordinator Request (Version: 1) => coordinator_key coordinator_type + coordinator_key => STRING + coordinator_type => INT8 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>coordinator_key</td><td>Id to use for finding the coordinator (for groups, this is the groupId, for transactional producers, this is the transactional id)</td></tr> +<tr> +<td>coordinator_type</td><td>The type of coordinator to find (0 = group, 1 = transaction)</td></tr> +</table> +</p> +<b>Responses:</b><br> +<p><pre>FindCoordinator Response (Version: 0) => error_code coordinator + error_code => INT16 + coordinator => node_id host port + node_id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>coordinator</td><td>Host and port information for the coordinator for a consumer group.</td></tr> +<tr> +<td>node_id</td><td>The broker id.</td></tr> +<tr> +<td>host</td><td>The hostname of the broker.</td></tr> +<tr> +<td>port</td><td>The port on which the broker accepts requests.</td></tr> +</table> +</p> +<p><pre>FindCoordinator Response (Version: 1) => throttle_time_ms error_code error_message coordinator + throttle_time_ms => INT32 + error_code => INT16 + error_message => NULLABLE_STRING + coordinator => node_id host port + node_id => INT32 + host => STRING + port => INT32 +</pre><table class="data-table"><tbody> +<tr><th>Field</th> +<th>Description</th> +</tr><tr> +<td>throttle_time_ms</td><td>Duration in milliseconds for which the request was throttled due to quota violation (Zero if the request did not violate any quota)</td></tr> +<tr> +<td>error_code</td><td>Response error code</td></tr> +<tr> +<td>error_message</td><td>Response error message</td></tr> +<tr> +<td>coordinator</td><td>Host and port in
<TRUNCATED>
