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

Kafka protocol DescribeClientQuotas message

Request versions summary:

  • Version 1 enables flexible versions.

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+)

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

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

  • entries: A result entry. ([]EntryData | versions 0+)

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

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

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

    • values: The quota values for the entity. ([]ValueData | versions 0+)

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

      • value: The quota configuration value. (float64 | 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:

  • components: Filter components to apply to quota entities. ([]ComponentData | versions 0+)

    • entity_type: The entity type that the filter component applies to. (string | versions 0+)

    • match_type: How to match the entity {0 = exact name, 1 = default name, 2 = any specified name}. (int8 | versions 0+)

    • match: The string to match against, or null if unused for the match type. (string | versions 0+)

  • strict: Whether the match is strict, i.e. should exclude entities with unspecified entity types. (bool | versions 0+)