Struct UpdateMetadataRequest

#[non_exhaustive]
pub struct UpdateMetadataRequest {
    pub controller_id: BrokerId,
    pub is_k_raft_controller: bool,
    pub _type: i8,
    pub controller_epoch: i32,
    pub broker_epoch: i64,
    pub ungrouped_partition_states: Vec<UpdateMetadataPartitionState>,
    pub topic_states: Vec<UpdateMetadataTopicState>,
    pub live_brokers: Vec<UpdateMetadataBroker>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-8

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.

controller_id: BrokerId

The controller id.

Supported API versions: 0-8

is_k_raft_controller: bool

If KRaft controller id is used during migration. See KIP-866

Supported API versions: 8

_type: i8

Indicates if this request is a Full metadata snapshot (2), Incremental (1), or Unknown (0). Using during ZK migration, see KIP-866

Supported API versions: 8

controller_epoch: i32

The controller epoch.

Supported API versions: 0-8

broker_epoch: i64

The broker epoch.

Supported API versions: 5-8

ungrouped_partition_states: Vec<UpdateMetadataPartitionState>

In older versions of this RPC, each partition that we would like to update.

Supported API versions: 0-4

topic_states: Vec<UpdateMetadataTopicState>

In newer versions of this RPC, each topic that we would like to update.

Supported API versions: 5-8

live_brokers: Vec<UpdateMetadataBroker>

Supported API versions: 0-8

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl UpdateMetadataRequest

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

Sets controller_id to the passed value.

The controller id.

Supported API versions: 0-8

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

Sets is_k_raft_controller to the passed value.

If KRaft controller id is used during migration. See KIP-866

Supported API versions: 8

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

Sets _type to the passed value.

Indicates if this request is a Full metadata snapshot (2), Incremental (1), or Unknown (0). Using during ZK migration, see KIP-866

Supported API versions: 8

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

Sets controller_epoch to the passed value.

The controller epoch.

Supported API versions: 0-8

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

Sets broker_epoch to the passed value.

The broker epoch.

Supported API versions: 5-8

pub fn with_ungrouped_partition_states( self, value: Vec<UpdateMetadataPartitionState>, ) -> Self

Sets ungrouped_partition_states to the passed value.

In older versions of this RPC, each partition that we would like to update.

Supported API versions: 0-4

pub fn with_topic_states(self, value: Vec<UpdateMetadataTopicState>) -> Self

Sets topic_states to the passed value.

In newer versions of this RPC, each topic that we would like to update.

Supported API versions: 5-8

pub fn with_live_brokers(self, value: Vec<UpdateMetadataBroker>) -> Self

Sets live_brokers to the passed value.

Supported API versions: 0-8

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 UpdateMetadataRequest

fn clone(&self) -> UpdateMetadataRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateMetadataRequest

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

Formats the value using the given formatter.

impl Decodable for UpdateMetadataRequest

Available on crate feature broker only.

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

Decode the message from the provided buffer and version.

impl Default for UpdateMetadataRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for UpdateMetadataRequest

Available on crate feature client 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<UpdateMetadataRequest> for RequestKind

Available on crate feature messages_enums only.

fn from(value: UpdateMetadataRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for UpdateMetadataRequest

fn header_version(version: i16) -> i16

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

impl Message for UpdateMetadataRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for UpdateMetadataRequest

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

Available on crate features client and broker only.

const KEY: i16 = 6i16

The API key of this request.

type Response = UpdateMetadataResponse

The response associated with this request.

impl StructuralPartialEq for UpdateMetadataRequest