Struct ShareFetchRequest 

#[non_exhaustive]
pub struct ShareFetchRequest {
    pub group_id: Option<GroupId>,
    pub member_id: Option<StrBytes>,
    pub share_session_epoch: i32,
    pub max_wait_ms: i32,
    pub min_bytes: i32,
    pub max_bytes: i32,
    pub max_records: i32,
    pub batch_size: i32,
    pub topics: Vec<FetchTopic>,
    pub forgotten_topics_data: Vec<ForgottenTopic>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 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.

group_id: Option<GroupId>

The group identifier.

Supported API versions: 1

member_id: Option<StrBytes>

The member ID.

Supported API versions: 1

share_session_epoch: i32

The current share session epoch: 0 to open a share session; -1 to close it; otherwise increments for consecutive requests.

Supported API versions: 1

max_wait_ms: i32

The maximum time in milliseconds to wait for the response.

Supported API versions: 1

min_bytes: i32

The minimum bytes to accumulate in the response.

Supported API versions: 1

max_bytes: i32

The maximum bytes to fetch. See KIP-74 for cases where this limit may not be honored.

Supported API versions: 1

max_records: i32

The maximum number of records to fetch. This limit can be exceeded for alignment of batch boundaries.

Supported API versions: 1

batch_size: i32

The optimal number of records for batches of acquired records and acknowledgements.

Supported API versions: 1

topics: Vec<FetchTopic>

The topics to fetch.

Supported API versions: 1

forgotten_topics_data: Vec<ForgottenTopic>

The partitions to remove from this share session.

Supported API versions: 1

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl ShareFetchRequest

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

Sets group_id to the passed value.

The group identifier.

Supported API versions: 1

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

Sets member_id to the passed value.

The member ID.

Supported API versions: 1

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

Sets share_session_epoch to the passed value.

The current share session epoch: 0 to open a share session; -1 to close it; otherwise increments for consecutive requests.

Supported API versions: 1

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

Sets max_wait_ms to the passed value.

The maximum time in milliseconds to wait for the response.

Supported API versions: 1

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

Sets min_bytes to the passed value.

The minimum bytes to accumulate in the response.

Supported API versions: 1

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

Sets max_bytes to the passed value.

The maximum bytes to fetch. See KIP-74 for cases where this limit may not be honored.

Supported API versions: 1

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

Sets max_records to the passed value.

The maximum number of records to fetch. This limit can be exceeded for alignment of batch boundaries.

Supported API versions: 1

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

Sets batch_size to the passed value.

The optimal number of records for batches of acquired records and acknowledgements.

Supported API versions: 1

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

Sets topics to the passed value.

The topics to fetch.

Supported API versions: 1

pub fn with_forgotten_topics_data(self, value: Vec<ForgottenTopic>) -> Self

Sets forgotten_topics_data to the passed value.

The partitions to remove from this share session.

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

fn clone(&self) -> ShareFetchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShareFetchRequest

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

Formats the value using the given formatter.

impl Decodable for ShareFetchRequest

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 ShareFetchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for ShareFetchRequest

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

Available on crate feature messages_enums only.

fn from(value: ShareFetchRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for ShareFetchRequest

fn header_version(version: i16) -> i16

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

impl Message for ShareFetchRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for ShareFetchRequest

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

Available on crate features client and broker only.

const KEY: i16 = 78i16

The API key of this request.

type Response = ShareFetchResponse

The response associated with this request.

impl StructuralPartialEq for ShareFetchRequest