Kayrock.OffsetCommit.V6.Request (kayrock v1.0.1)

Kayrock-generated request struct for Kafka offset_commit v6 API messages

The schema of this API is

[
  group_id: :string,
  generation_id: :int32,
  member_id: :string,
  topics: {:array,
   [
     name: :string,
     partitions: {:array,
      [
        partition_index: :int32,
        committed_offset: :int64,
        committed_leader_epoch: :int32,
        committed_metadata: :nullable_string
      ]}
   ]}
]

Summary

Types

t()

Request struct for the Kafka offset_commit API v6

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (6) 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.OffsetCommit.V6.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  generation_id: nil | integer(),
  group_id: nil | binary(),
  member_id: nil | binary(),
  topics: [
    %{
      name: nil | binary(),
      partitions: [
        %{
          partition_index: nil | integer(),
          committed_offset: nil | integer(),
          committed_leader_epoch: nil | integer(),
          committed_metadata: nil | binary()
        }
      ]
    }
  ]
}

Request struct for the Kafka offset_commit API v6

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

response_deserializer()

@spec response_deserializer() :: (binary() ->
                              {Kayrock.OffsetCommit.V6.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