# 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.Vote do
@moduledoc """
Kafka protocol Vote message
Request versions summary:
- Version 1 adds voter key and directory id (KIP-853)
Version 2 adds PreVote field and renames candidate to replica
Response versions summary:
- Version 1 adds leader endpoint (KIP-853)
Version 2 handles PreVote requests
"""
alias KlifeProtocol.Deserializer
alias KlifeProtocol.Serializer
alias KlifeProtocol.Header
@api_key 52
@min_flexible_version_req 0
@min_flexible_version_res 0
@doc """
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
- cluster_id: The cluster id. (string | versions 0+)
- voter_id: The replica id of the voter receiving the request. (int32 | versions 1+)
- topics: The topic data. ([]TopicData | versions 0+)
- topic_name: The topic name. (string | versions 0+)
- partitions: The partition data. ([]PartitionData | versions 0+)
- partition_index: The partition index. (int32 | versions 0+)
- replica_epoch: The epoch of the voter sending the request (int32 | versions 0+)
- replica_id: The replica id of the voter sending the request (int32 | versions 0+)
- replica_directory_id: The directory id of the voter sending the request (uuid | versions 1+)
- voter_directory_id: The directory id of the voter receiving the request (uuid | versions 1+)
- last_offset_epoch: The epoch of the last record written to the metadata log. (int32 | versions 0+)
- last_offset: The log end offset of the metadata log of the voter sending the request. (int64 | versions 0+)
- pre_vote: Whether the request is a PreVote request (not persisted) or not. (bool | versions 2+)
"""
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:
- error_code: The top level error code. (int16 | versions 0+)
- topics: The results for each topic. ([]TopicData | versions 0+)
- topic_name: The topic name. (string | versions 0+)
- partitions: The results for each partition. ([]PartitionData | versions 0+)
- partition_index: The partition index. (int32 | versions 0+)
- error_code: The partition level error code. (int16 | versions 0+)
- leader_id: The ID of the current leader or -1 if the leader is unknown. (int32 | versions 0+)
- leader_epoch: The latest known leader epoch. (int32 | versions 0+)
- vote_granted: True if the vote was granted and false otherwise. (bool | versions 0+)
- node_endpoints: Endpoints for all current-leaders enumerated in PartitionData. ([]NodeEndpoint | versions 1+)
- node_id: The ID of the associated node. (int32 | versions 1+)
- host: The node's hostname. (string | versions 1+)
- port: The node's port. (uint16 | versions 1+)
"""
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: 2
@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)
def request_schema(0),
do: [
cluster_id: {:compact_string, %{is_nullable?: true}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
replica_epoch: {:int32, %{is_nullable?: false}},
replica_id: {:int32, %{is_nullable?: false}},
last_offset_epoch: {:int32, %{is_nullable?: false}},
last_offset: {:int64, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
def request_schema(1),
do: [
cluster_id: {:compact_string, %{is_nullable?: true}},
voter_id: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
replica_epoch: {:int32, %{is_nullable?: false}},
replica_id: {:int32, %{is_nullable?: false}},
replica_directory_id: {:uuid, %{is_nullable?: false}},
voter_directory_id: {:uuid, %{is_nullable?: false}},
last_offset_epoch: {:int32, %{is_nullable?: false}},
last_offset: {:int64, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
def request_schema(2),
do: [
cluster_id: {:compact_string, %{is_nullable?: true}},
voter_id: {:int32, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
replica_epoch: {:int32, %{is_nullable?: false}},
replica_id: {:int32, %{is_nullable?: false}},
replica_directory_id: {:uuid, %{is_nullable?: false}},
voter_directory_id: {:uuid, %{is_nullable?: false}},
last_offset_epoch: {:int32, %{is_nullable?: false}},
last_offset: {:int64, %{is_nullable?: false}},
pre_vote: {:boolean, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
def request_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message Vote")
def response_schema(0),
do: [
error_code: {:int16, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
leader_id: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
vote_granted: {:boolean, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]
def response_schema(1),
do: [
error_code: {:int16, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
leader_id: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
vote_granted: {:boolean, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer:
{:tag_buffer,
%{
0 =>
{{:node_endpoints,
{:compact_array,
[
node_id: {:int32, %{is_nullable?: false}},
host: {:compact_string, %{is_nullable?: false}},
port: {:uint16, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}}, %{is_nullable?: false}}
}}
]
def response_schema(2),
do: [
error_code: {:int16, %{is_nullable?: false}},
topics:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partitions:
{{:compact_array,
[
partition_index: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
leader_id: {:int32, %{is_nullable?: false}},
leader_epoch: {:int32, %{is_nullable?: false}},
vote_granted: {:boolean, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer:
{:tag_buffer,
%{
0 =>
{{:node_endpoints,
{:compact_array,
[
node_id: {:int32, %{is_nullable?: false}},
host: {:compact_string, %{is_nullable?: false}},
port: {:uint16, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}}, %{is_nullable?: false}}
}}
]
def response_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message Vote")
end