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

Kayrock-generated request struct for Kafka heartbeat v1 API messages

The schema of this API is

[group_id: :string, generation_id: :int32, member_id: :string]

Link to this section Summary

Types

t()

Request struct for the Kafka heartbeat API v1

Functions

Returns the Kafka API key for this API

Returns the API version (1) implemented by this module

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

Returns the schema of this message

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

Link to this section Types

Specs

t() :: %Kayrock.Heartbeat.V1.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  generation_id: nil | integer(),
  group_id: nil | binary(),
  member_id: nil | binary()
}

Request struct for the Kafka heartbeat API v1

Link to this section Functions

Specs

api_key() :: integer()

Returns the Kafka API key for this API

Specs

api_vsn() :: integer()

Returns the API version (1) implemented by this module

Specs

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

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

Specs

schema() :: term()

Returns the schema of this message

See above.

Specs

serialize(t()) :: iodata()

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