Struct ApiVersionsResponse

#[non_exhaustive]
pub struct ApiVersionsResponse {
    pub error_code: i16,
    pub api_keys: Vec<ApiVersion>,
    pub throttle_time_ms: i32,
    pub supported_features: Vec<SupportedFeatureKey>,
    pub finalized_features_epoch: i64,
    pub finalized_features: Vec<FinalizedFeatureKey>,
    pub zk_migration_ready: bool,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-4

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.

error_code: i16

The top-level error code.

Supported API versions: 0-4

api_keys: Vec<ApiVersion>

The APIs supported by the broker.

Supported API versions: 0-4

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: 1-4

supported_features: Vec<SupportedFeatureKey>

Features supported by the broker. Note: in v0-v3, features with MinSupportedVersion = 0 are omitted.

Supported API versions: 3-4

finalized_features_epoch: i64

The monotonically increasing epoch for the finalized features information. Valid values are >= 0. A value of -1 is special and represents unknown epoch.

Supported API versions: 3-4

finalized_features: Vec<FinalizedFeatureKey>

List of cluster-wide finalized features. The information is valid only if FinalizedFeaturesEpoch >= 0.

Supported API versions: 3-4

zk_migration_ready: bool

Set by a KRaft controller if the required configurations for ZK migration are present

Supported API versions: 3-4

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl ApiVersionsResponse

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

Sets error_code to the passed value.

The top-level error code.

Supported API versions: 0-4

pub fn with_api_keys(self, value: Vec<ApiVersion>) -> Self

Sets api_keys to the passed value.

The APIs supported by the broker.

Supported API versions: 0-4

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: 1-4

pub fn with_supported_features(self, value: Vec<SupportedFeatureKey>) -> Self

Sets supported_features to the passed value.

Features supported by the broker. Note: in v0-v3, features with MinSupportedVersion = 0 are omitted.

Supported API versions: 3-4

pub fn with_finalized_features_epoch(self, value: i64) -> Self

Sets finalized_features_epoch to the passed value.

The monotonically increasing epoch for the finalized features information. Valid values are >= 0. A value of -1 is special and represents unknown epoch.

Supported API versions: 3-4

pub fn with_finalized_features(self, value: Vec<FinalizedFeatureKey>) -> Self

Sets finalized_features to the passed value.

List of cluster-wide finalized features. The information is valid only if FinalizedFeaturesEpoch >= 0.

Supported API versions: 3-4

pub fn with_zk_migration_ready(self, value: bool) -> Self

Sets zk_migration_ready to the passed value.

Set by a KRaft controller if the required configurations for ZK migration are present

Supported API versions: 3-4

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 ApiVersionsResponse

fn clone(&self) -> ApiVersionsResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiVersionsResponse

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

Formats the value using the given formatter.

impl Decodable for ApiVersionsResponse

Available on crate feature client only.

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

Decode the message from the provided buffer and version.

impl Default for ApiVersionsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for ApiVersionsResponse

Available on crate feature broker only.

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<ApiVersionsResponse> for ResponseKind

Available on crate feature messages_enums only.

fn from(value: ApiVersionsResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for ApiVersionsResponse

fn header_version(version: i16) -> i16

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

impl Message for ApiVersionsResponse

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for ApiVersionsResponse

fn eq(&self, other: &ApiVersionsResponse) -> 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 ApiVersionsResponse