Struct JoinGroupRequest

Source
#[non_exhaustive]
pub struct JoinGroupRequest { pub group_id: GroupId, pub session_timeout_ms: i32, pub rebalance_timeout_ms: i32, pub member_id: StrBytes, pub group_instance_id: Option<StrBytes>, pub protocol_type: StrBytes, pub protocols: Vec<JoinGroupRequestProtocol>, pub reason: Option<StrBytes>, pub unknown_tagged_fields: BTreeMap<i32, Bytes>, }
Expand description

Valid versions: 0-9

Fields (Non-exhaustive)§

This struct is marked as 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.
§group_id: GroupId

The group identifier.

Supported API versions: 0-9

§session_timeout_ms: i32

The coordinator considers the consumer dead if it receives no heartbeat after this timeout in milliseconds.

Supported API versions: 0-9

§rebalance_timeout_ms: i32

The maximum time in milliseconds that the coordinator will wait for each member to rejoin when rebalancing the group.

Supported API versions: 1-9

§member_id: StrBytes

The member id assigned by the group coordinator.

Supported API versions: 0-9

§group_instance_id: Option<StrBytes>

The unique identifier of the consumer instance provided by end user.

Supported API versions: 5-9

§protocol_type: StrBytes

The unique name the for class of protocols implemented by the group we want to join.

Supported API versions: 0-9

§protocols: Vec<JoinGroupRequestProtocol>

The list of protocols that the member supports.

Supported API versions: 0-9

§reason: Option<StrBytes>

The reason why the member (re-)joins the group.

Supported API versions: 8-9

§unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations§

Source§

impl JoinGroupRequest

Source

pub fn with_group_id(self, value: GroupId) -> Self

Sets group_id to the passed value.

The group identifier.

Supported API versions: 0-9

Source

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

Sets session_timeout_ms to the passed value.

The coordinator considers the consumer dead if it receives no heartbeat after this timeout in milliseconds.

Supported API versions: 0-9

Source

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

Sets rebalance_timeout_ms to the passed value.

The maximum time in milliseconds that the coordinator will wait for each member to rejoin when rebalancing the group.

Supported API versions: 1-9

Source

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

Sets member_id to the passed value.

The member id assigned by the group coordinator.

Supported API versions: 0-9

Source

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

Sets group_instance_id to the passed value.

The unique identifier of the consumer instance provided by end user.

Supported API versions: 5-9

Source

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

Sets protocol_type to the passed value.

The unique name the for class of protocols implemented by the group we want to join.

Supported API versions: 0-9

Source

pub fn with_protocols(self, value: Vec<JoinGroupRequestProtocol>) -> Self

Sets protocols to the passed value.

The list of protocols that the member supports.

Supported API versions: 0-9

Source

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

Sets reason to the passed value.

The reason why the member (re-)joins the group.

Supported API versions: 8-9

Source

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

Source

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations§

Source§

impl Clone for JoinGroupRequest

Source§

fn clone(&self) -> JoinGroupRequest

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JoinGroupRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decodable for JoinGroupRequest

Available on crate feature broker only.
Source§

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

Decode the message from the provided buffer and version.
Source§

impl Default for JoinGroupRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Encodable for JoinGroupRequest

Available on crate feature client only.
Source§

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.
Source§

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.
Source§

impl From<JoinGroupRequest> for RequestKind

Available on crate feature messages_enums only.
Source§

fn from(value: JoinGroupRequest) -> RequestKind

Converts to this type from the input type.
Source§

impl HeaderVersion for JoinGroupRequest

Source§

fn header_version(version: i16) -> i16

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

impl Message for JoinGroupRequest

Source§

const VERSIONS: VersionRange

The valid versions for this message.
Source§

const DEPRECATED_VERSIONS: Option<VersionRange>

The deprecated versions for this message.
Source§

impl PartialEq for JoinGroupRequest

Source§

fn eq(&self, other: &JoinGroupRequest) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Request for JoinGroupRequest

Available on crate features client and broker only.
Source§

const KEY: i16 = 11i16

The API key of this request.
Source§

type Response = JoinGroupResponse

The response associated with this request.
Source§

impl StructuralPartialEq for JoinGroupRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.