Kayrock.Heartbeat.V4.Request (kayrock v1.0.1)

Kayrock-generated request struct for Kafka heartbeat v4 API messages

The schema of this API is

[
  group_id: :compact_string,
  generation_id: :int32,
  member_id: :compact_string,
  group_instance_id: :compact_nullable_string,
  tagged_fields: :tagged_fields
]

Summary

Types

t()

Request struct for the Kafka heartbeat API v4

Functions

api_key()

Returns the Kafka API key for this API

api_vsn()

Returns the API version (4) 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.Heartbeat.V4.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  generation_id: nil | integer(),
  group_id: nil | binary(),
  group_instance_id: nil | binary(),
  member_id: nil | binary(),
  tagged_fields: [{non_neg_integer(), binary()}]
}

Request struct for the Kafka heartbeat API v4

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

response_deserializer()

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