View Source Kayrock.ListOffsets.V1.Request (kayrock v0.2.0)

Kayrock-generated request struct for Kafka list_offsets v1 API messages

The schema of this API is

[
  replica_id: :int32,
  topics: {:array,
   [
     topic: :string,
     partitions: {:array, [partition: :int32, timestamp: :int64]}
   ]}
]

Summary

Types

t()

Request struct for the Kafka list_offsets 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

Types

Link to this type

t()

View Source 
@type t() :: %Kayrock.ListOffsets.V1.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  replica_id: nil | integer(),
  topics: [
    %{
      topic: nil | binary(),
      partitions: [%{partition: nil | integer(), timestamp: nil | integer()}]
    }
  ]
}

Request struct for the Kafka list_offsets API v1

Functions

Link to this function

api_key()

View Source 
@spec api_key() :: integer()

Returns the Kafka API key for this API

Link to this function

api_vsn()

View Source 
@spec api_vsn() :: integer()

Returns the API version (1) implemented by this module

Link to this function

response_deserializer()

View Source 
@spec response_deserializer() ::
  (binary() -> {Kayrock.ListOffsets.V1.Response.t(), binary()})

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

Link to this function

schema()

View Source 
@spec schema() :: term()

Returns the schema of this message

See above.

Link to this function

serialize(struct)

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

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