# 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.OffsetForLeaderEpoch do
@moduledoc """
Kafka protocol OffsetForLeaderEpoch message
Request versions summary:
- Version 1 is the same as version 0.
- Version 2 adds the current leader epoch to support fencing.
- Version 3 adds ReplicaId (the default is -2 which conventionally represents a
"debug" consumer which is allowed to see offsets beyond the high watermark).
Followers will use this replicaId when using an older version of the protocol.
- Version 4 enables flexible versions.
Response versions summary:
- Version 1 added the leader epoch to the response.
- Version 2 added the throttle time.
- Version 3 is the same as version 2.
- Version 4 enables flexible versions.
"""
alias KlifeProtocol.Deserializer
alias KlifeProtocol.Serializer
alias KlifeProtocol.Header
@api_key 23
@min_flexible_version_req 4
@min_flexible_version_res 4
@doc """
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
- replica_id: The broker ID of the follower, of -1 if this request is from a consumer. (int32 | versions 3+)
- topics: Each topic to get offsets for. ([]OffsetForLeaderTopic | versions 0+)
- topic: The topic name. (string | versions 0+)
- partitions: Each partition to get offsets for. ([]OffsetForLeaderPartition | versions 0+)
- partition: The partition index. (int32 | versions 0+)
- current_leader_epoch: An epoch used to fence consumers/replicas with old metadata. If the epoch provided by the client is larger than the current epoch known to the broker, then the UNKNOWN_LEADER_EPOCH error code will be returned. If the provided epoch is smaller, then the FENCED_LEADER_EPOCH error code will be returned. (int32 | versions 2+)
- leader_epoch: The epoch to look up an offset for. (int32 | 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 2+)
- topics: Each topic we fetched offsets for. ([]OffsetForLeaderTopicResult | versions 0+)
- topic: The topic name. (string | versions 0+)
- partitions: Each partition in the topic we fetched offsets for. ([]EpochEndOffset | versions 0+)
- error_code: The error code 0, or if there was no error. (int16 | versions 0+)
- partition: The partition index. (int32 | versions 0+)
- leader_epoch: The leader epoch of the partition. (int32 | versions 1+)
- end_offset: The end offset of the epoch. (int64 | 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: 4
@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: [
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(1),
do: [
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(2),
do: [
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition: {:int32, %{is_nullable?: false}},
current_leader_epoch: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(3),
do: [
replica_id: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
partition: {:int32, %{is_nullable?: false}},
current_leader_epoch: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp request_schema(4),
do: [
replica_id: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition: {:int32, %{is_nullable?: false}},
current_leader_epoch: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
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 OffsetForLeaderEpoch")
defp response_schema(0),
do: [
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
error_code: {:int16, %{is_nullable?: false}},
partition: {:int32, %{is_nullable?: false}},
end_offset: {:int64, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(1),
do: [
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
error_code: {:int16, %{is_nullable?: false}},
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
end_offset: {:int64, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(2),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
error_code: {:int16, %{is_nullable?: false}},
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
end_offset: {:int64, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(3),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:array,
[
topic: {:string, %{is_nullable?: false}},
partitions:
{{:array,
[
error_code: {:int16, %{is_nullable?: false}},
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
end_offset: {:int64, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(4),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
error_code: {:int16, %{is_nullable?: false}},
partition: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
end_offset: {:int64, %{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 OffsetForLeaderEpoch")
end