Kayrock.Fetch.V2.Request (kayrock v0.1.15) View Source

Kayrock-generated request struct for Kafka fetch v2 API messages

The schema of this API is

[
  replica_id: :int32,
  max_wait_time: :int32,
  min_bytes: :int32,
  topics: {:array,
   [
     topic: :string,
     partitions: {:array,
      [partition: :int32, fetch_offset: :int64, max_bytes: :int32]}
   ]}
]

Link to this section Summary

Types

t()

Request struct for the Kafka fetch API v2

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (2) 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.Fetch.V2.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  max_wait_time: nil | integer(),
  min_bytes: nil | integer(),
  replica_id: nil | integer(),
  topics: [
    %{
      topic: nil | binary(),
      partitions: [
        %{
          partition: nil | integer(),
          fetch_offset: nil | integer(),
          max_bytes: nil | integer()
        }
      ]
    }
  ]
}

Request struct for the Kafka fetch API v2

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

response_deserializer()

Specs

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