Struct ConsumerGroupHeartbeatResponse 

#[non_exhaustive]
pub struct ConsumerGroupHeartbeatResponse {
    pub throttle_time_ms: i32,
    pub error_code: i16,
    pub error_message: Option<StrBytes>,
    pub member_id: Option<StrBytes>,
    pub member_epoch: i32,
    pub heartbeat_interval_ms: i32,
    pub assignment: Option<Assignment>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-1

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.

throttle_time_ms: i32

The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.

Supported API versions: 0-1

error_code: i16

The top-level error code, or 0 if there was no error.

Supported API versions: 0-1

error_message: Option<StrBytes>

The top-level error message, or null if there was no error.

Supported API versions: 0-1

member_id: Option<StrBytes>

The member id is generated by the consumer starting from version 1, while in version 0, it can be provided by users or generated by the group coordinator.

Supported API versions: 0-1

member_epoch: i32

The member epoch.

Supported API versions: 0-1

heartbeat_interval_ms: i32

The heartbeat interval in milliseconds.

Supported API versions: 0-1

assignment: Option<Assignment>

null if not provided; the assignment otherwise.

Supported API versions: 0-1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl ConsumerGroupHeartbeatResponse

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

Sets throttle_time_ms to the passed value.

The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota.

Supported API versions: 0-1

pub fn with_error_code(self, value: i16) -> Self

Sets error_code to the passed value.

The top-level error code, or 0 if there was no error.

Supported API versions: 0-1

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

Sets error_message to the passed value.

The top-level error message, or null if there was no error.

Supported API versions: 0-1

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

Sets member_id to the passed value.

The member id is generated by the consumer starting from version 1, while in version 0, it can be provided by users or generated by the group coordinator.

Supported API versions: 0-1

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

Sets member_epoch to the passed value.

The member epoch.

Supported API versions: 0-1

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

Sets heartbeat_interval_ms to the passed value.

The heartbeat interval in milliseconds.

Supported API versions: 0-1

pub fn with_assignment(self, value: Option<Assignment>) -> Self

Sets assignment to the passed value.

null if not provided; the assignment otherwise.

Supported API versions: 0-1

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 ConsumerGroupHeartbeatResponse

fn clone(&self) -> ConsumerGroupHeartbeatResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerGroupHeartbeatResponse

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

Formats the value using the given formatter.

impl Decodable for ConsumerGroupHeartbeatResponse

Available on crate feature client only.

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

Decode the message from the provided buffer and version.

impl Default for ConsumerGroupHeartbeatResponse

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for ConsumerGroupHeartbeatResponse

Available on crate feature broker 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<ConsumerGroupHeartbeatResponse> for ResponseKind

Available on crate feature messages_enums only.

fn from(value: ConsumerGroupHeartbeatResponse) -> ResponseKind

Converts to this type from the input type.

impl HeaderVersion for ConsumerGroupHeartbeatResponse

fn header_version(version: i16) -> i16

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

impl Message for ConsumerGroupHeartbeatResponse

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for ConsumerGroupHeartbeatResponse

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