Kayrock.DescribeConfigs.V1.Request (kayrock v0.1.15) View Source

Kayrock-generated request struct for Kafka describe_configs v1 API messages

The schema of this API is

[
  resources: {:array,
   [
     resource_type: :int8,
     resource_name: :string,
     config_names: {:array, :string}
   ]},
  include_synonyms: :boolean
]

Link to this section Summary

Types

t()

Request struct for the Kafka describe_configs API v1

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (1) 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

Link to this section Types

t()

Specs

t() :: %Kayrock.DescribeConfigs.V1.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  include_synonyms: nil | integer(),
  resources: [
    %{
      resource_type: nil | integer(),
      resource_name: nil | binary(),
      config_names: [nil | binary()]
    }
  ]
}

Request struct for the Kafka describe_configs API v1

Link to this section Functions

api_key()

Specs

api_key() :: integer()

Returns the Kafka API key for this API

api_vsn()

Specs

api_vsn() :: integer()

Returns the API version (1) implemented by this module

response_deserializer()

Specs

response_deserializer() ::
  (binary() -> {Kayrock.DescribeConfigs.V1.Response.t(), binary()})

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

schema()

Specs

schema() :: term()

Returns the schema of this message

See above.

serialize(struct)

Specs

serialize(t()) :: iodata()

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