Struct ConsumerGroupHeartbeatRequest

#[non_exhaustive]
pub struct ConsumerGroupHeartbeatRequest {
    pub group_id: GroupId,
    pub member_id: StrBytes,
    pub member_epoch: i32,
    pub instance_id: Option<StrBytes>,
    pub rack_id: Option<StrBytes>,
    pub rebalance_timeout_ms: i32,
    pub subscribed_topic_names: Option<Vec<TopicName>>,
    pub server_assignor: Option<StrBytes>,
    pub topic_partitions: Option<Vec<TopicPartitions>>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0

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

member_id: StrBytes

The member id generated by the coordinator. The member id must be kept during the entire lifetime of the member.

Supported API versions: 0

member_epoch: i32

The current member epoch; 0 to join the group; -1 to leave the group; -2 to indicate that the static member will rejoin.

Supported API versions: 0

instance_id: Option<StrBytes>

null if not provided or if it didn’t change since the last heartbeat; the instance Id otherwise.

Supported API versions: 0

rack_id: Option<StrBytes>

null if not provided or if it didn’t change since the last heartbeat; the rack ID of consumer otherwise.

Supported API versions: 0

rebalance_timeout_ms: i32

-1 if it didn’t change since the last heartbeat; the maximum time in milliseconds that the coordinator will wait on the member to revoke its partitions otherwise.

Supported API versions: 0

subscribed_topic_names: Option<Vec<TopicName>>

null if it didn’t change since the last heartbeat; the subscribed topic names otherwise.

Supported API versions: 0

server_assignor: Option<StrBytes>

null if not used or if it didn’t change since the last heartbeat; the server side assignor to use otherwise.

Supported API versions: 0

topic_partitions: Option<Vec<TopicPartitions>>

null if it didn’t change since the last heartbeat; the partitions owned by the member.

Supported API versions: 0

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl ConsumerGroupHeartbeatRequest

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

Sets group_id to the passed value.

The group identifier.

Supported API versions: 0

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

Sets member_id to the passed value.

The member id generated by the coordinator. The member id must be kept during the entire lifetime of the member.

Supported API versions: 0

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

Sets member_epoch to the passed value.

The current member epoch; 0 to join the group; -1 to leave the group; -2 to indicate that the static member will rejoin.

Supported API versions: 0

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

Sets instance_id to the passed value.

null if not provided or if it didn’t change since the last heartbeat; the instance Id otherwise.

Supported API versions: 0

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

Sets rack_id to the passed value.

null if not provided or if it didn’t change since the last heartbeat; the rack ID of consumer otherwise.

Supported API versions: 0

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

Sets rebalance_timeout_ms to the passed value.

-1 if it didn’t change since the last heartbeat; the maximum time in milliseconds that the coordinator will wait on the member to revoke its partitions otherwise.

Supported API versions: 0

pub fn with_subscribed_topic_names(self, value: Option<Vec<TopicName>>) -> Self

Sets subscribed_topic_names to the passed value.

null if it didn’t change since the last heartbeat; the subscribed topic names otherwise.

Supported API versions: 0

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

Sets server_assignor to the passed value.

null if not used or if it didn’t change since the last heartbeat; the server side assignor to use otherwise.

Supported API versions: 0

pub fn with_topic_partitions(self, value: Option<Vec<TopicPartitions>>) -> Self

Sets topic_partitions to the passed value.

null if it didn’t change since the last heartbeat; the partitions owned by the member.

Supported API versions: 0

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 ConsumerGroupHeartbeatRequest

fn clone(&self) -> ConsumerGroupHeartbeatRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerGroupHeartbeatRequest

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

Formats the value using the given formatter.

impl Decodable for ConsumerGroupHeartbeatRequest

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 ConsumerGroupHeartbeatRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for ConsumerGroupHeartbeatRequest

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

Available on crate feature messages_enums only.

fn from(value: ConsumerGroupHeartbeatRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for ConsumerGroupHeartbeatRequest

fn header_version(version: i16) -> i16

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

impl Message for ConsumerGroupHeartbeatRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for ConsumerGroupHeartbeatRequest

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

Available on crate features client and broker only.

const KEY: i16 = 68i16

The API key of this request.

type Response = ConsumerGroupHeartbeatResponse

The response associated with this request.

impl StructuralPartialEq for ConsumerGroupHeartbeatRequest