View Source KlifeProtocol.Messages.AlterClientQuotas (Klife Protocol v0.7.0)

Kafka protocol AlterClientQuotas message

Request versions summary:

Response versions summary:

  • Version 1 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: The 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+)

  • entries: The quota configuration entries to alter. ([]EntryData | versions 0+)

    • error_code: The error code, or 0 if the quota alteration succeeded. (int16 | versions 0+)

    • error_message: The error message, or null if the quota alteration succeeded. (string | versions 0+)

    • entity: The quota entity to alter. ([]EntityData | versions 0+)

      • entity_type: The entity type. (string | versions 0+)

      • entity_name: The name of the entity, or null if the default. (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:

  • entries: The quota configuration entries to alter. ([]EntryData | versions 0+)

    • entity: The quota entity to alter. ([]EntityData | versions 0+)

      • entity_type: The entity type. (string | versions 0+)

      • entity_name: The name of the entity, or null if the default. (string | versions 0+)

    • ops: An individual quota configuration entry to alter. ([]OpData | versions 0+)

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

      • value: The value to set, otherwise ignored if the value is to be removed. (float64 | versions 0+)

      • remove: Whether the quota configuration value should be removed, otherwise set. (bool | versions 0+)

  • validate_only: Whether the alteration should be validated, but not performed. (bool | versions 0+)