Struct kafka_protocol::messages::join_group_request::JoinGroupRequestBuilder

pub struct JoinGroupRequestBuilder { /* private fields */ }

Builder for JoinGroupRequest.

Implementations

impl JoinGroupRequestBuilder

pub fn group_id(&mut self, value: GroupId) -> &mut Self

The group identifier.

Supported API versions: 0-9

pub fn session_timeout_ms(&mut self, value: i32) -> &mut Self

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

Supported API versions: 0-9

pub fn rebalance_timeout_ms(&mut self, value: i32) -> &mut Self

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 member_id(&mut self, value: StrBytes) -> &mut Self

The member id assigned by the group coordinator.

Supported API versions: 0-9

pub fn group_instance_id(&mut self, value: Option<StrBytes>) -> &mut Self

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

Supported API versions: 5-9

pub fn protocol_type(&mut self, value: StrBytes) -> &mut Self

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

Supported API versions: 0-9

pub fn protocols(
    &mut self,
    value: IndexMap<StrBytes, JoinGroupRequestProtocol>
) -> &mut Self

The list of protocols that the member supports.

Supported API versions: 0-9

pub fn reason(&mut self, value: Option<StrBytes>) -> &mut Self

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

Supported API versions: 8-9

pub fn unknown_tagged_fields(
    &mut self,
    value: BTreeMap<i32, Vec<u8>>
) -> &mut Self

Other tagged fields

pub fn build(&self) -> Result<JoinGroupRequest, JoinGroupRequestBuilderError>

Builds a new JoinGroupRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for JoinGroupRequestBuilder

fn clone(&self) -> JoinGroupRequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for JoinGroupRequestBuilder

fn default() -> Self

Returns the “default value” for a type.