Struct kafka_protocol::messages::stop_replica_request::StopReplicaRequest

#[non_exhaustive]
pub struct StopReplicaRequest {
    pub controller_id: BrokerId,
    pub is_k_raft_controller: bool,
    pub controller_epoch: i32,
    pub broker_epoch: i64,
    pub delete_partitions: bool,
    pub ungrouped_partitions: Vec<StopReplicaPartitionV0>,
    pub topics: Vec<StopReplicaTopicV1>,
    pub topic_states: Vec<StopReplicaTopicState>,
    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.

controller_id: BrokerId

The controller id.

Supported API versions: 0-4

is_k_raft_controller: bool

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

Supported API versions: 4

controller_epoch: i32

The controller epoch.

Supported API versions: 0-4

broker_epoch: i64

The broker epoch.

Supported API versions: 1-4

delete_partitions: bool

Whether these partitions should be deleted.

Supported API versions: 0-2

ungrouped_partitions: Vec<StopReplicaPartitionV0>

The partitions to stop.

Supported API versions: 0

topics: Vec<StopReplicaTopicV1>

The topics to stop.

Supported API versions: 1-2

topic_states: Vec<StopReplicaTopicState>

Each topic.

Supported API versions: 3-4

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl StopReplicaRequest

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

Sets controller_id to the passed value.

The controller id.

Supported API versions: 0-4

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

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

Sets controller_epoch to the passed value.

The controller epoch.

Supported API versions: 0-4

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

Sets broker_epoch to the passed value.

The broker epoch.

Supported API versions: 1-4

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

Sets delete_partitions to the passed value.

Whether these partitions should be deleted.

Supported API versions: 0-2

pub fn with_ungrouped_partitions( self, value: Vec<StopReplicaPartitionV0>, ) -> Self

Sets ungrouped_partitions to the passed value.

The partitions to stop.

Supported API versions: 0

pub fn with_topics(self, value: Vec<StopReplicaTopicV1>) -> Self

Sets topics to the passed value.

The topics to stop.

Supported API versions: 1-2

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

Sets topic_states to the passed value.

Each topic.

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 StopReplicaRequest

fn clone(&self) -> StopReplicaRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StopReplicaRequest

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

Formats the value using the given formatter.

impl Decodable for StopReplicaRequest

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

Decode the message from the provided buffer and version.

impl Default for StopReplicaRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for StopReplicaRequest

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<StopReplicaRequest> for RequestKind

fn from(value: StopReplicaRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for StopReplicaRequest

fn header_version(version: i16) -> i16

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

impl Message for StopReplicaRequest

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for StopReplicaRequest

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

const KEY: i16 = 5i16

The API key of this request.

type Response = StopReplicaResponse

The response associated with this request.

impl StructuralPartialEq for StopReplicaRequest