Struct aws_sdk_kinesis::input::GetRecordsInput

#[non_exhaustive]
pub struct GetRecordsInput {
    pub shard_iterator: Option<String>,
    pub limit: Option<i32>,
}

Represents the input for GetRecords.

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.

shard_iterator: Option<String>

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

limit: Option<i32>

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Implementations

impl GetRecordsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetRecords, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GetRecords>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetRecordsInput

impl GetRecordsInput

pub fn shard_iterator(&self) -> Option<&str>

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

pub fn limit(&self) -> Option<i32>

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.

Trait Implementations

impl Clone for GetRecordsInput

fn clone(&self) -> GetRecordsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetRecordsInput

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

Formats the value using the given formatter.

impl PartialEq<GetRecordsInput> for GetRecordsInput

fn eq(&self, other: &GetRecordsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetRecordsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for GetRecordsInput