Kayrock.Metadata.V8.Request (kayrock v1.0.1)

Kayrock-generated request struct for Kafka metadata v8 API messages

The schema of this API is

[
  topics: {:array, [name: :string]},
  allow_auto_topic_creation: :boolean,
  include_cluster_authorized_operations: :boolean,
  include_topic_authorized_operations: :boolean
]

Summary

Types

t()

Request struct for the Kafka metadata API v8

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (8) implemented by this module

response_deserializer()

Returns a function that can be used to deserialize the wire response from the broker for this message type

schema()

Returns the schema of this message

serialize(struct)

Serialize a message to binary data for transfer to a Kafka broker

Types

t()

@type t() :: %Kayrock.Metadata.V8.Request{
  allow_auto_topic_creation: nil | integer(),
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  include_cluster_authorized_operations: nil | integer(),
  include_topic_authorized_operations: nil | integer(),
  topics: [%{name: nil | binary()}]
}

Request struct for the Kafka metadata API v8

Functions

api_key()

@spec api_key() :: integer()

Returns the Kafka API key for this API

api_vsn()

@spec api_vsn() :: integer()

Returns the API version (8) implemented by this module

response_deserializer()

@spec response_deserializer() :: (binary() ->
                              {Kayrock.Metadata.V8.Response.t(), binary()})

Returns a function that can be used to deserialize the wire response from the broker for this message type

schema()

@spec schema() :: term()

Returns the schema of this message

See above.

serialize(struct)

@spec serialize(t()) :: iodata()

Serialize a message to binary data for transfer to a Kafka broker