Struct kafka_protocol::messages::join_group_request::JoinGroupRequest

#[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: IndexMap<StrBytes, JoinGroupRequestProtocol>,
    pub reason: Option<StrBytes>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-9

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.

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: IndexMap<StrBytes, 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

impl JoinGroupRequest

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

Sets group_id to the passed value.

The group identifier.

Supported API versions: 0-9

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

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

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

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

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

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

Sets protocols to the passed value.

The list of protocols that the member supports.

Supported API versions: 0-9

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

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 JoinGroupRequest

fn clone(&self) -> JoinGroupRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JoinGroupRequest

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

Formats the value using the given formatter.

impl Decodable for JoinGroupRequest

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

Decode the message from the provided buffer and version.

impl Default for JoinGroupRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for JoinGroupRequest

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

fn from(value: JoinGroupRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for JoinGroupRequest

fn header_version(version: i16) -> i16

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

impl Message for JoinGroupRequest

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = _

The deprecated versions for this message.

impl PartialEq for JoinGroupRequest

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

const KEY: i16 = 11i16

The API key of this request.

type Response = JoinGroupResponse

The response associated with this request.

impl StructuralPartialEq for JoinGroupRequest