# DO NOT EDIT THIS FILE MANUALLY
# This module is automatically generated by running mix task generate_file
# every change must be done inside the mix task directly
defmodule KlifeProtocol.Messages.OffsetCommit do
@moduledoc """
Kafka protocol OffsetCommit message
Request versions summary:
- Version 1 adds timestamp and group membership information, as well as the commit timestamp.
- Version 2 adds retention time. It removes the commit timestamp added in version 1.
- Version 3 and 4 are the same as version 2.
- Version 5 removes the retention time, which is now controlled only by a broker configuration.
- Version 6 adds the leader epoch for fencing.
- version 7 adds a new field called groupInstanceId to indicate member identity across restarts.
- Version 8 is the first flexible version.
- Version 9 is the first version that can be used with the new consumer group protocol (KIP-848). The
request is the same as version 8.
Response versions summary:
- Versions 1 and 2 are the same as version 0.
- Version 3 adds the throttle time to the response.
- Starting in version 4, on quota violation, brokers send out responses before throttling.
- Versions 5 and 6 are the same as version 4.
- Version 7 offsetCommitRequest supports a new field called groupInstanceId to indicate member identity across restarts.
- Version 8 is the first flexible version.
- Version 9 is the first version that can be used with the new consumer group protocol (KIP-848). The response is
the same as version 8 but can return STALE_MEMBER_EPOCH when the new consumer group protocol is used and
GROUP_ID_NOT_FOUND when the group does not exist for both protocols.
"""
alias KlifeProtocol.Deserializer
alias KlifeProtocol.Serializer
alias KlifeProtocol.Header
@api_key 8
@min_flexible_version_req 8
@min_flexible_version_res 8
@doc """
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
- group_id: The unique group identifier. (string | versions 0+)
- generation_id_or_member_epoch: The generation of the group if using the classic group protocol or the member epoch if using the consumer protocol. (int32 | versions 1+)
- member_id: The member ID assigned by the group coordinator. (string | versions 1+)
- group_instance_id: The unique identifier of the consumer instance provided by end user. (string | versions 7+)
- retention_time_ms: The time period in ms to retain the offset. (int64 | versions 2-4)
- topics: The topics to commit offsets for. ([]OffsetCommitRequestTopic | versions 0+)
- name: The topic name. (string | versions 0+)
- partitions: Each partition to commit offsets for. ([]OffsetCommitRequestPartition | versions 0+)
- partition_index: The partition index. (int32 | versions 0+)
- committed_offset: The message offset to be committed. (int64 | versions 0+)
- committed_leader_epoch: The leader epoch of this partition. (int32 | versions 6+)
- commit_timestamp: The timestamp of the commit. (int64 | versions 1)
- committed_metadata: Any associated metadata the client wants to keep. (string | versions 0+)
"""
def serialize_request(%{headers: headers, content: content}, version) do
headers
|> Map.put(:request_api_key, @api_key)
|> Map.put(:request_api_version, version)
|> Header.serialize_request(req_header_version(version))
|> then(&Serializer.execute(content, request_schema(version), &1))
end
@doc """
Receive a binary in the kafka wire format and deserialize it into a map.
Response content fields:
- throttle_time_ms: The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 3+)
- topics: The responses for each topic. ([]OffsetCommitResponseTopic | versions 0+)
- name: The topic name. (string | versions 0+)
- partitions: The responses for each partition in the topic. ([]OffsetCommitResponsePartition | versions 0+)
- partition_index: The partition index. (int32 | versions 0+)
- error_code: The error code, or 0 if there was no error. (int16 | versions 0+)
"""
def deserialize_response(data, version, with_header? \\ true)
def deserialize_response(data, version, true) do
{:ok, {headers, rest_data}} = Header.deserialize_response(data, res_header_version(version))
case Deserializer.execute(rest_data, response_schema(version)) do
{:ok, {content, <<>>}} ->
{:ok, %{headers: headers, content: content}}
{:error, _reason} = err ->
err
end
end
def deserialize_response(data, version, false) do
case Deserializer.execute(data, response_schema(version)) do
{:ok, {content, <<>>}} ->
{:ok, %{content: content}}
{:error, _reason} = err ->
err
end
end
@doc """
Returns the message api key number.
"""
def api_key(), do: @api_key
@doc """
Returns the current max supported version of this message.
"""
def max_supported_version(), do: 9
@doc """
Returns the current min supported version of this message.
"""
def min_supported_version(), do: 0
defp req_header_version(msg_version),
do: if(msg_version >= @min_flexible_version_req, do: 2, else: 1)
defp res_header_version(msg_version),
do: if(msg_version >= @min_flexible_version_res, do: 1, else: 0)
defp request_schema(0),
do: [
group_id: {:string, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(1),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
commit_timestamp: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(2),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
retention_time_ms: {:int64, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(3),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
retention_time_ms: {:int64, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(4),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
retention_time_ms: {:int64, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(5),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(6),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_leader_epoch: {:int32, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(7),
do: [
group_id: {:string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:string, %{is_nullable?: false}},
group_instance_id: {:string, %{is_nullable?: true}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_leader_epoch: {:int32, %{is_nullable?: false}},
committed_metadata: {:string, %{is_nullable?: true}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(8),
do: [
group_id: {:compact_string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:compact_string, %{is_nullable?: false}},
group_instance_id: {:compact_string, %{is_nullable?: true}},
topics:
{{:compact_array,
[
name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_leader_epoch: {:int32, %{is_nullable?: false}},
committed_metadata: {:compact_string, %{is_nullable?: true}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
defp request_schema(9),
do: [
group_id: {:compact_string, %{is_nullable?: false}},
generation_id_or_member_epoch: {:int32, %{is_nullable?: false}},
member_id: {:compact_string, %{is_nullable?: false}},
group_instance_id: {:compact_string, %{is_nullable?: true}},
topics:
{{:compact_array,
[
name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
committed_offset: {:int64, %{is_nullable?: false}},
committed_leader_epoch: {:int32, %{is_nullable?: false}},
committed_metadata: {:compact_string, %{is_nullable?: true}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
defp request_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message OffsetCommit")
defp response_schema(0),
do: [
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(1),
do: [
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(2),
do: [
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(3),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(4),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(5),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(6),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(7),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
name: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(8),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]
defp response_schema(9),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]
defp response_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message OffsetCommit")
end
