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

Kafka protocol DescribeConfigs message

Request versions summary:

  • Version 1 adds IncludeSynonyms. Version 2 is the same as version 1. Version 4 enables flexible versions.

Response versions summary:

  • Version 1 adds ConfigSource and the synonyms. Starting in version 2, on quota violation, brokers send out responses before throttling. Version 4 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+)

  • results: The results for each resource. ([]DescribeConfigsResult | versions 0+)

    • error_code: The error code, or 0 if we were able to successfully describe the configurations. (int16 | versions 0+)

    • error_message: The error message, or null if we were able to successfully describe the configurations. (string | versions 0+)

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

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

    • configs: Each listed configuration. ([]DescribeConfigsResourceResult | versions 0+)

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

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

      • read_only: True if the configuration is read-only. (bool | versions 0+)

      • is_default: True if the configuration is not set. (bool | versions 0)

      • config_source: The configuration source. (int8 | versions 1+)

      • is_sensitive: True if this configuration is sensitive. (bool | versions 0+)

      • synonyms: The synonyms for this configuration key. ([]DescribeConfigsSynonym | versions 1+)

        • name: The synonym name. (string | versions 1+)

        • value: The synonym value. (string | versions 1+)

        • source: The synonym source. (int8 | versions 1+)

      • config_type: The configuration data type. Type can be one of the following values - BOOLEAN, STRING, INT, SHORT, LONG, DOUBLE, LIST, CLASS, PASSWORD (int8 | versions 3+)

      • documentation: The configuration documentation. (string | versions 3+)

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 resources whose configurations we want to describe. ([]DescribeConfigsResource | versions 0+)

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

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

    • configuration_keys: The configuration keys to list, or null to list all configuration keys. ([]string | versions 0+)

  • include_synonyms: True if we should include all synonyms. (bool | versions 1+)

  • include_documentation: True if we should include configuration documentation. (bool | versions 3+)