Struct BrokerHeartbeatRequest

#[non_exhaustive]
pub struct BrokerHeartbeatRequest {
    pub broker_id: BrokerId,
    pub broker_epoch: i64,
    pub current_metadata_offset: i64,
    pub want_fence: bool,
    pub want_shut_down: bool,
    pub offline_log_dirs: Vec<Uuid>,
    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.

broker_id: BrokerId

The broker ID.

Supported API versions: 0-1

broker_epoch: i64

The broker epoch.

Supported API versions: 0-1

current_metadata_offset: i64

The highest metadata offset which the broker has reached.

Supported API versions: 0-1

want_fence: bool

True if the broker wants to be fenced, false otherwise.

Supported API versions: 0-1

want_shut_down: bool

True if the broker wants to be shut down, false otherwise.

Supported API versions: 0-1

offline_log_dirs: Vec<Uuid>

Log directories that failed and went offline.

Supported API versions: 1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl BrokerHeartbeatRequest

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

Sets broker_id to the passed value.

The broker ID.

Supported API versions: 0-1

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

Sets broker_epoch to the passed value.

The broker epoch.

Supported API versions: 0-1

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

Sets current_metadata_offset to the passed value.

The highest metadata offset which the broker has reached.

Supported API versions: 0-1

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

Sets want_fence to the passed value.

True if the broker wants to be fenced, false otherwise.

Supported API versions: 0-1

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

Sets want_shut_down to the passed value.

True if the broker wants to be shut down, false otherwise.

Supported API versions: 0-1

pub fn with_offline_log_dirs(self, value: Vec<Uuid>) -> Self

Sets offline_log_dirs to the passed value.

Log directories that failed and went offline.

Supported API versions: 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 BrokerHeartbeatRequest

fn clone(&self) -> BrokerHeartbeatRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrokerHeartbeatRequest

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

Formats the value using the given formatter.

impl Decodable for BrokerHeartbeatRequest

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 BrokerHeartbeatRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for BrokerHeartbeatRequest

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

Available on crate feature messages_enums only.

fn from(value: BrokerHeartbeatRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for BrokerHeartbeatRequest

fn header_version(version: i16) -> i16

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

impl Message for BrokerHeartbeatRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for BrokerHeartbeatRequest

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

Available on crate features client and broker only.

const KEY: i16 = 63i16

The API key of this request.

type Response = BrokerHeartbeatResponse

The response associated with this request.

impl StructuralPartialEq for BrokerHeartbeatRequest