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

Kafka protocol DescribeAcls message

Request versions summary:

  • Version 1 adds resource pattern type. Version 2 enables flexible versions. Version 3 adds user resource type.

Response versions summary:

  • Version 1 adds PatternType. Starting in version 1, on quota violation, brokers send out responses before throttling. Version 2 enables flexible versions. Version 3 adds user resource type.

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 there was no error. (int16 | versions 0+)

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

  • resources: Each Resource that is referenced in an ACL. ([]DescribeAclsResource | versions 0+)

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

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

    • pattern_type: The resource pattern type. (int8 | versions 1+)

    • acls: The ACLs. ([]AclDescription | versions 0+)

      • principal: The ACL principal. (string | versions 0+)

      • host: The ACL host. (string | versions 0+)

      • operation: The ACL operation. (int8 | versions 0+)

      • permission_type: The ACL permission type. (int8 | 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:

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

  • resource_name_filter: The resource name, or null to match any resource name. (string | versions 0+)

  • pattern_type_filter: The resource pattern to match. (int8 | versions 1+)

  • principal_filter: The principal to match, or null to match any principal. (string | versions 0+)

  • host_filter: The host to match, or null to match any host. (string | versions 0+)

  • operation: The operation to match. (int8 | versions 0+)

  • permission_type: The permission type to match. (int8 | versions 0+)