Struct OffsetCommitRequest

#[non_exhaustive]
pub struct OffsetCommitRequest {
    pub group_id: GroupId,
    pub generation_id_or_member_epoch: i32,
    pub member_id: StrBytes,
    pub group_instance_id: Option<StrBytes>,
    pub retention_time_ms: i64,
    pub topics: Vec<OffsetCommitRequestTopic>,
    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 unique group identifier.

Supported API versions: 0-9

generation_id_or_member_epoch: i32

The generation of the group if using the classic group protocol or the member epoch if using the consumer protocol.

Supported API versions: 1-9

member_id: StrBytes

The member ID assigned by the group coordinator.

Supported API versions: 1-9

group_instance_id: Option<StrBytes>

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

Supported API versions: 7-9

retention_time_ms: i64

The time period in ms to retain the offset.

Supported API versions: 2-4

topics: Vec<OffsetCommitRequestTopic>

The topics to commit offsets for.

Supported API versions: 0-9

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl OffsetCommitRequest

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

Sets group_id to the passed value.

The unique group identifier.

Supported API versions: 0-9

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

Sets generation_id_or_member_epoch to the passed value.

The generation of the group if using the classic group protocol or the member epoch if using the consumer protocol.

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: 1-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: 7-9

pub fn with_retention_time_ms(self, value: i64) -> Self

Sets retention_time_ms to the passed value.

The time period in ms to retain the offset.

Supported API versions: 2-4

pub fn with_topics(self, value: Vec<OffsetCommitRequestTopic>) -> Self

Sets topics to the passed value.

The topics to commit offsets for.

Supported API versions: 0-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 OffsetCommitRequest

fn clone(&self) -> OffsetCommitRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetCommitRequest

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

Formats the value using the given formatter.

impl Decodable for OffsetCommitRequest

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 OffsetCommitRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for OffsetCommitRequest

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

Available on crate feature messages_enums only.

fn from(value: OffsetCommitRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for OffsetCommitRequest

fn header_version(version: i16) -> i16

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

impl Message for OffsetCommitRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange>

The deprecated versions for this message.

impl PartialEq for OffsetCommitRequest

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

Available on crate features client and broker only.

const KEY: i16 = 8i16

The API key of this request.

type Response = OffsetCommitResponse

The response associated with this request.

impl StructuralPartialEq for OffsetCommitRequest