Struct BrokerRegistrationRequest

#[non_exhaustive]
pub struct BrokerRegistrationRequest {
    pub broker_id: BrokerId,
    pub cluster_id: StrBytes,
    pub incarnation_id: Uuid,
    pub listeners: Vec<Listener>,
    pub features: Vec<Feature>,
    pub rack: Option<StrBytes>,
    pub is_migrating_zk_broker: bool,
    pub log_dirs: Vec<Uuid>,
    pub previous_broker_epoch: i64,
    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.

broker_id: BrokerId

The broker ID.

Supported API versions: 0-4

cluster_id: StrBytes

The cluster id of the broker process.

Supported API versions: 0-4

incarnation_id: Uuid

The incarnation id of the broker process.

Supported API versions: 0-4

listeners: Vec<Listener>

The listeners of this broker

Supported API versions: 0-4

features: Vec<Feature>

The features on this broker. Note: in v0-v3, features with MinSupportedVersion = 0 are omitted.

Supported API versions: 0-4

rack: Option<StrBytes>

The rack which this broker is in.

Supported API versions: 0-4

is_migrating_zk_broker: bool

If the required configurations for ZK migration are present, this value is set to true

Supported API versions: 1-4

log_dirs: Vec<Uuid>

Log directories configured in this broker which are available.

Supported API versions: 2-4

previous_broker_epoch: i64

The epoch before a clean shutdown.

Supported API versions: 3-4

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl BrokerRegistrationRequest

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

Sets broker_id to the passed value.

The broker ID.

Supported API versions: 0-4

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

Sets cluster_id to the passed value.

The cluster id of the broker process.

Supported API versions: 0-4

pub fn with_incarnation_id(self, value: Uuid) -> Self

Sets incarnation_id to the passed value.

The incarnation id of the broker process.

Supported API versions: 0-4

pub fn with_listeners(self, value: Vec<Listener>) -> Self

Sets listeners to the passed value.

The listeners of this broker

Supported API versions: 0-4

pub fn with_features(self, value: Vec<Feature>) -> Self

Sets features to the passed value.

The features on this broker. Note: in v0-v3, features with MinSupportedVersion = 0 are omitted.

Supported API versions: 0-4

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

Sets rack to the passed value.

The rack which this broker is in.

Supported API versions: 0-4

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

Sets is_migrating_zk_broker to the passed value.

If the required configurations for ZK migration are present, this value is set to true

Supported API versions: 1-4

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

Sets log_dirs to the passed value.

Log directories configured in this broker which are available.

Supported API versions: 2-4

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

Sets previous_broker_epoch to the passed value.

The epoch before a clean shutdown.

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 BrokerRegistrationRequest

fn clone(&self) -> BrokerRegistrationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrokerRegistrationRequest

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

Formats the value using the given formatter.

impl Decodable for BrokerRegistrationRequest

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 BrokerRegistrationRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for BrokerRegistrationRequest

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

Available on crate feature messages_enums only.

fn from(value: BrokerRegistrationRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for BrokerRegistrationRequest

fn header_version(version: i16) -> i16

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

impl Message for BrokerRegistrationRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for BrokerRegistrationRequest

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

Available on crate features client and broker only.

const KEY: i16 = 62i16

The API key of this request.

type Response = BrokerRegistrationResponse

The response associated with this request.

impl StructuralPartialEq for BrokerRegistrationRequest