Struct kafka_protocol::messages::describe_cluster_response::DescribeClusterResponse

#[non_exhaustive]
pub struct DescribeClusterResponse {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub error_message: Option<StrBytes>,
    pub endpoint_type: i8,
    pub cluster_id: StrBytes,
    pub controller_id: BrokerId,
    pub brokers: IndexMap<BrokerId, DescribeClusterBroker>,
    pub cluster_authorized_operations: i32,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-1

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

throttle_time_ms: i32

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.

Supported API versions: 0-1

error_code: i16

The top-level error code, or 0 if there was no error

Supported API versions: 0-1

error_message: Option<StrBytes>

The top-level error message, or null if there was no error.

Supported API versions: 0-1

endpoint_type: i8

The endpoint type that was described. 1=brokers, 2=controllers.

Supported API versions: 1

cluster_id: StrBytes

The cluster ID that responding broker belongs to.

Supported API versions: 0-1

controller_id: BrokerId

The ID of the controller broker.

Supported API versions: 0-1

brokers: IndexMap<BrokerId, DescribeClusterBroker>

Each broker in the response.

Supported API versions: 0-1

cluster_authorized_operations: i32

32-bit bitfield to represent authorized operations for this cluster.

Supported API versions: 0-1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl DescribeClusterResponse

pub fn with_throttle_time_ms(self, value: i32) -> Self

Sets throttle_time_ms to the passed value.

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.

Supported API versions: 0-1

pub fn with_error_code(self, value: i16) -> Self

Sets error_code to the passed value.

The top-level error code, or 0 if there was no error

Supported API versions: 0-1

pub fn with_error_message(self, value: Option<StrBytes>) -> Self

Sets error_message to the passed value.

The top-level error message, or null if there was no error.

Supported API versions: 0-1

pub fn with_endpoint_type(self, value: i8) -> Self

Sets endpoint_type to the passed value.

The endpoint type that was described. 1=brokers, 2=controllers.

Supported API versions: 1

pub fn with_cluster_id(self, value: StrBytes) -> Self

Sets cluster_id to the passed value.

The cluster ID that responding broker belongs to.

Supported API versions: 0-1

pub fn with_controller_id(self, value: BrokerId) -> Self

Sets controller_id to the passed value.

The ID of the controller broker.

Supported API versions: 0-1

pub fn with_brokers( self, value: IndexMap<BrokerId, DescribeClusterBroker>, ) -> Self

Sets brokers to the passed value.

Each broker in the response.

Supported API versions: 0-1

pub fn with_cluster_authorized_operations(self, value: i32) -> Self

Sets cluster_authorized_operations to the passed value.

32-bit bitfield to represent authorized operations for this cluster.

Supported API versions: 0-1

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for DescribeClusterResponse

fn clone(&self) -> DescribeClusterResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeClusterResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for DescribeClusterResponse

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for DescribeClusterResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for DescribeClusterResponse

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl From<DescribeClusterResponse> for ResponseKind

fn from(value: DescribeClusterResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for DescribeClusterResponse

fn header_version(version: i16) -> i16

Maps a header version to a given version for a particular API message.

impl Message for DescribeClusterResponse

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for DescribeClusterResponse

fn eq(&self, other: &DescribeClusterResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeClusterResponse