Kayrock.Produce.V5.Request (kayrock v0.1.12) View Source

Kayrock-generated request struct for Kafka produce v5 API messages

The schema of this API is

[
  transactional_id: :nullable_string,
  acks: :int16,
  timeout: :int32,
  topic_data: {:array,
   [topic: :string, data: {:array, [partition: :int32, record_set: :records]}]}
]

Link to this section Summary

Types

t()

Request struct for the Kafka produce API v5

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (5) 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.Produce.V5.Request{
  acks: nil | integer(),
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  timeout: nil | integer(),
  topic_data: [
    %{
      topic: nil | binary(),
      data: [
        %{
          partition: nil | integer(),
          record_set: nil | Kayrock.MessageSet.t() | Kayrock.RecordBatch.t()
        }
      ]
    }
  ],
  transactional_id: nil | binary()
}

Request struct for the Kafka produce API v5

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 (5) implemented by this module

response_deserializer()

Specs

response_deserializer() ::
  (binary() -> {Kayrock.Produce.V5.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