#[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
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
impl JoinGroupRequest
Sourcepub fn with_group_id(self, value: GroupId) -> Self
pub fn with_group_id(self, value: GroupId) -> Self
Sets group_id
to the passed value.
The group identifier.
Supported API versions: 0-9
Sourcepub fn with_session_timeout_ms(self, value: i32) -> Self
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
Sourcepub fn with_rebalance_timeout_ms(self, value: i32) -> Self
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
Sourcepub fn with_member_id(self, value: StrBytes) -> Self
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
Sourcepub fn with_group_instance_id(self, value: Option<StrBytes>) -> Self
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
Sourcepub fn with_protocol_type(self, value: StrBytes) -> Self
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
Sourcepub fn with_protocols(self, value: Vec<JoinGroupRequestProtocol>) -> Self
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
Sourcepub fn with_reason(self, value: Option<StrBytes>) -> Self
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
Sourcepub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self
pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self
Sets unknown_tagged_fields to the passed value.
Sourcepub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self
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
impl Clone for JoinGroupRequest
Source§fn clone(&self) -> JoinGroupRequest
fn clone(&self) -> JoinGroupRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JoinGroupRequest
impl Debug for JoinGroupRequest
Source§impl Decodable for JoinGroupRequest
Available on crate feature broker
only.
impl Decodable for JoinGroupRequest
broker
only.Source§impl Default for JoinGroupRequest
impl Default for JoinGroupRequest
Source§impl Encodable for JoinGroupRequest
Available on crate feature client
only.
impl Encodable for JoinGroupRequest
client
only.Source§impl From<JoinGroupRequest> for RequestKind
Available on crate feature messages_enums
only.
impl From<JoinGroupRequest> for RequestKind
messages_enums
only.Source§fn from(value: JoinGroupRequest) -> RequestKind
fn from(value: JoinGroupRequest) -> RequestKind
Source§impl HeaderVersion for JoinGroupRequest
impl HeaderVersion for JoinGroupRequest
Source§fn header_version(version: i16) -> i16
fn header_version(version: i16) -> i16
Source§impl Message for JoinGroupRequest
impl Message for JoinGroupRequest
Source§const VERSIONS: VersionRange
const VERSIONS: VersionRange
Source§const DEPRECATED_VERSIONS: Option<VersionRange>
const DEPRECATED_VERSIONS: Option<VersionRange>
Source§impl PartialEq for JoinGroupRequest
impl PartialEq for JoinGroupRequest
Source§impl Request for JoinGroupRequest
Available on crate features client
and broker
only.
impl Request for JoinGroupRequest
client
and broker
only.