View Source KlifeProtocol.Messages.AlterConfigs (Klife Protocol v0.5.0)

Kafka protocol AlterConfigs message

Request versions summary:

  • Version 1 is the same as version 0. Version 2 enables flexible versions.

Response versions summary:

  • Starting in version 1, on quota violation brokers send out responses before throttling. Version 2 enables flexible versions.

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: Duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 0+)

  • responses: The responses for each resource. ([]AlterConfigsResourceResponse | versions 0+)

    • error_code: The resource error code. (int16 | versions 0+)

    • error_message: The resource error message, or null if there was no error. (string | versions 0+)

    • resource_type: The resource type. (int8 | versions 0+)

    • resource_name: The resource name. (string | versions 0+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • resources: The updates for each resource. ([]AlterConfigsResource | versions 0+)

    • resource_type: The resource type. (int8 | versions 0+)

    • resource_name: The resource name. (string | versions 0+)

    • configs: The configurations. ([]AlterableConfig | versions 0+)

      • name: The configuration key name. (string | versions 0+)

      • value: The value to set for the configuration key. (string | versions 0+)

  • validate_only: True if we should validate the request, but not change the configurations. (bool | versions 0+)