Kayrock.Fetch.V1.Request (kayrock v0.1.12) View Source
Kayrock-generated request struct for Kafka fetch v1 API
messages
The schema of this API is
[
replica_id: :int32,
max_wait_time: :int32,
min_bytes: :int32,
topics: {:array,
[
topic: :string,
partitions: {:array,
[partition: :int32, fetch_offset: :int64, max_bytes: :int32]}
]}
]Link to this section Summary
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.Fetch.V1.Request{
client_id: nil | binary(),
correlation_id: nil | integer(),
max_wait_time: nil | integer(),
min_bytes: nil | integer(),
replica_id: nil | integer(),
topics: [
%{
topic: nil | binary(),
partitions: [
%{
partition: nil | integer(),
fetch_offset: nil | integer(),
max_bytes: nil | integer()
}
]
}
]
}
Request struct for the Kafka fetch 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.Fetch.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 a message to binary data for transfer to a Kafka broker