Struct InitProducerIdRequest

#[non_exhaustive]
pub struct InitProducerIdRequest {
    pub transactional_id: Option<TransactionalId>,
    pub transaction_timeout_ms: i32,
    pub producer_id: ProducerId,
    pub producer_epoch: i16,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-5

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.

transactional_id: Option<TransactionalId>

The transactional id, or null if the producer is not transactional.

Supported API versions: 0-5

transaction_timeout_ms: i32

The time in ms to wait before aborting idle transactions sent by this producer. This is only relevant if a TransactionalId has been defined.

Supported API versions: 0-5

producer_id: ProducerId

The producer id. This is used to disambiguate requests if a transactional id is reused following its expiration.

Supported API versions: 3-5

producer_epoch: i16

The producer’s current epoch. This will be checked against the producer epoch on the broker, and the request will return an error if they do not match.

Supported API versions: 3-5

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl InitProducerIdRequest

pub fn with_transactional_id(self, value: Option<TransactionalId>) -> Self

Sets transactional_id to the passed value.

The transactional id, or null if the producer is not transactional.

Supported API versions: 0-5

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

Sets transaction_timeout_ms to the passed value.

The time in ms to wait before aborting idle transactions sent by this producer. This is only relevant if a TransactionalId has been defined.

Supported API versions: 0-5

pub fn with_producer_id(self, value: ProducerId) -> Self

Sets producer_id to the passed value.

The producer id. This is used to disambiguate requests if a transactional id is reused following its expiration.

Supported API versions: 3-5

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

Sets producer_epoch to the passed value.

The producer’s current epoch. This will be checked against the producer epoch on the broker, and the request will return an error if they do not match.

Supported API versions: 3-5

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 InitProducerIdRequest

fn clone(&self) -> InitProducerIdRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InitProducerIdRequest

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

Formats the value using the given formatter.

impl Decodable for InitProducerIdRequest

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 InitProducerIdRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for InitProducerIdRequest

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

Available on crate feature messages_enums only.

fn from(value: InitProducerIdRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for InitProducerIdRequest

fn header_version(version: i16) -> i16

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

impl Message for InitProducerIdRequest

const VERSIONS: VersionRange = _

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for InitProducerIdRequest

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

Available on crate features client and broker only.

const KEY: i16 = 22i16

The API key of this request.

type Response = InitProducerIdResponse

The response associated with this request.

impl StructuralPartialEq for InitProducerIdRequest