Kayrock.IncrementalAlterConfigs.V1.Request (kayrock v1.0.1)

Copy Markdown View Source

Kayrock-generated request struct for Kafka incremental_alter_configs v1 API messages

The schema of this API is

[
  resources: {:compact_array,
   [
     resource_type: :int8,
     resource_name: :compact_string,
     configs: {:compact_array,
      [
        name: :compact_string,
        config_operation: :int8,
        value: :compact_nullable_string,
        tagged_fields: :tagged_fields
      ]},
     tagged_fields: :tagged_fields
   ]},
  validate_only: :boolean,
  tagged_fields: :tagged_fields
]

Summary

Types

t()

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

t()

@type t() :: %Kayrock.IncrementalAlterConfigs.V1.Request{
  client_id: nil | binary(),
  correlation_id: nil | integer(),
  resources:
    nil
    | [
        %{
          resource_type: nil | integer(),
          resource_name: nil | binary(),
          configs:
            nil
            | [
                %{
                  name: nil | binary(),
                  config_operation: nil | integer(),
                  value: nil | binary(),
                  tagged_fields: [{non_neg_integer(), binary()}]
                }
              ],
          tagged_fields: [{non_neg_integer(), binary()}]
        }
      ],
  tagged_fields: [{non_neg_integer(), binary()}],
  validate_only: nil | integer()
}

Request struct for the Kafka incremental_alter_configs API v1

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

response_deserializer()

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