# 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.DescribeAcls do
@moduledoc """
Kafka protocol DescribeAcls message
Request versions summary:
- Version 1 adds resource pattern type.
Version 2 enables flexible versions.
Version 3 adds user resource type.
Response versions summary:
- Version 1 adds PatternType.
Starting in version 1, on quota violation, brokers send out responses before throttling.
Version 2 enables flexible versions.
Version 3 adds user resource type.
"""
alias KlifeProtocol.Deserializer
alias KlifeProtocol.Serializer
alias KlifeProtocol.Header
@api_key 29
@min_flexible_version_req 2
@min_flexible_version_res 2
@doc """
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
- resource_type_filter: The resource type. (int8 | versions 0+)
- resource_name_filter: The resource name, or null to match any resource name. (string | versions 0+)
- pattern_type_filter: The resource pattern to match. (int8 | versions 1+)
- principal_filter: The principal to match, or null to match any principal. (string | versions 0+)
- host_filter: The host to match, or null to match any host. (string | versions 0+)
- operation: The operation to match. (int8 | versions 0+)
- permission_type: The permission type to match. (int8 | 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 0+)
- error_code: The error code, or 0 if there was no error. (int16 | versions 0+)
- error_message: The error message, or null if there was no error. (string | versions 0+)
- resources: Each Resource that is referenced in an ACL. ([]DescribeAclsResource | versions 0+)
- resource_type: The resource type. (int8 | versions 0+)
- resource_name: The resource name. (string | versions 0+)
- pattern_type: The resource pattern type. (int8 | versions 1+)
- acls: The ACLs. ([]AclDescription | versions 0+)
- principal: The ACL principal. (string | versions 0+)
- host: The ACL host. (string | versions 0+)
- operation: The ACL operation. (int8 | versions 0+)
- permission_type: The ACL permission type. (int8 | 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: 3
@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: [
resource_type_filter: {:int8, %{is_nullable?: false}},
resource_name_filter: {:string, %{is_nullable?: true}},
principal_filter: {:string, %{is_nullable?: true}},
host_filter: {:string, %{is_nullable?: true}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}}
]
defp request_schema(1),
do: [
resource_type_filter: {:int8, %{is_nullable?: false}},
resource_name_filter: {:string, %{is_nullable?: true}},
pattern_type_filter: {:int8, %{is_nullable?: false}},
principal_filter: {:string, %{is_nullable?: true}},
host_filter: {:string, %{is_nullable?: true}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}}
]
defp request_schema(2),
do: [
resource_type_filter: {:int8, %{is_nullable?: false}},
resource_name_filter: {:compact_string, %{is_nullable?: true}},
pattern_type_filter: {:int8, %{is_nullable?: false}},
principal_filter: {:compact_string, %{is_nullable?: true}},
host_filter: {:compact_string, %{is_nullable?: true}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
defp request_schema(3),
do: [
resource_type_filter: {:int8, %{is_nullable?: false}},
resource_name_filter: {:compact_string, %{is_nullable?: true}},
pattern_type_filter: {:int8, %{is_nullable?: false}},
principal_filter: {:compact_string, %{is_nullable?: true}},
host_filter: {:compact_string, %{is_nullable?: true}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
defp request_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message DescribeAcls")
defp response_schema(0),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
error_message: {:string, %{is_nullable?: true}},
resources:
{{:array,
[
resource_type: {:int8, %{is_nullable?: false}},
resource_name: {:string, %{is_nullable?: false}},
acls:
{{:array,
[
principal: {:string, %{is_nullable?: false}},
host: {:string, %{is_nullable?: false}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(1),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
error_message: {:string, %{is_nullable?: true}},
resources:
{{:array,
[
resource_type: {:int8, %{is_nullable?: false}},
resource_name: {:string, %{is_nullable?: false}},
pattern_type: {:int8, %{is_nullable?: false}},
acls:
{{:array,
[
principal: {:string, %{is_nullable?: false}},
host: {:string, %{is_nullable?: false}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(2),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
error_message: {:compact_string, %{is_nullable?: true}},
resources:
{{:compact_array,
[
resource_type: {:int8, %{is_nullable?: false}},
resource_name: {:compact_string, %{is_nullable?: false}},
pattern_type: {:int8, %{is_nullable?: false}},
acls:
{{:compact_array,
[
principal: {:compact_string, %{is_nullable?: false}},
host: {:compact_string, %{is_nullable?: false}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]
defp response_schema(3),
do: [
throttle_time_ms: {:int32, %{is_nullable?: false}},
error_code: {:int16, %{is_nullable?: false}},
error_message: {:compact_string, %{is_nullable?: true}},
resources:
{{:compact_array,
[
resource_type: {:int8, %{is_nullable?: false}},
resource_name: {:compact_string, %{is_nullable?: false}},
pattern_type: {:int8, %{is_nullable?: false}},
acls:
{{:compact_array,
[
principal: {:compact_string, %{is_nullable?: false}},
host: {:compact_string, %{is_nullable?: false}},
operation: {:int8, %{is_nullable?: false}},
permission_type: {:int8, %{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 DescribeAcls")
end