Kayrock.CreateDelegationToken.V2.Request (kayrock v1.0.1)

Copy Markdown View Source

Kayrock-generated request struct for Kafka create_delegation_token v2 API messages

The schema of this API is

[
  renewers: {:compact_array,
   [
     principal_type: :compact_string,
     principal_name: :compact_string,
     tagged_fields: :tagged_fields
   ]},
  max_lifetime_ms: :int64,
  tagged_fields: :tagged_fields
]

Summary

Types

t()

Request struct for the Kafka create_delegation_token API v2

Functions

Returns the Kafka API key for this API

Returns the API version (2) 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

Types

t()

@type t() :: %Kayrock.CreateDelegationToken.V2.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  max_lifetime_ms: nil | integer(),
  renewers:
    nil
    | [
        %{
          principal_type: nil | binary(),
          principal_name: nil | binary(),
          tagged_fields: [{non_neg_integer(), binary()}]
        }
      ],
  tagged_fields: [{non_neg_integer(), binary()}]
}

Request struct for the Kafka create_delegation_token API v2

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

response_deserializer()

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