Struct aws_sdk_kinesis::operation::get_records::builders::GetRecordsOutputBuilder

#[non_exhaustive]
pub struct GetRecordsOutputBuilder { /* private fields */ }

A builder for GetRecordsOutput.

Implementations

impl GetRecordsOutputBuilder

pub fn records(self, input: Record) -> Self

Appends an item to records.

To override the contents of this collection use set_records.

The data records retrieved from the shard.

pub fn set_records(self, input: Option<Vec<Record>>) -> Self

The data records retrieved from the shard.

pub fn get_records(&self) -> &Option<Vec<Record>>

The data records retrieved from the shard.

pub fn next_shard_iterator(self, input: impl Into<String>) -> Self

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

pub fn set_next_shard_iterator(self, input: Option<String>) -> Self

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

pub fn get_next_shard_iterator(&self) -> &Option<String>

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

pub fn millis_behind_latest(self, input: i64) -> Self

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

pub fn set_millis_behind_latest(self, input: Option<i64>) -> Self

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

pub fn get_millis_behind_latest(&self) -> &Option<i64>

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

pub fn child_shards(self, input: ChildShard) -> Self

Appends an item to child_shards.

To override the contents of this collection use set_child_shards.

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

pub fn set_child_shards(self, input: Option<Vec<ChildShard>>) -> Self

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

pub fn get_child_shards(&self) -> &Option<Vec<ChildShard>>

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

pub fn build(self) -> Result<GetRecordsOutput, BuildError>

Consumes the builder and constructs a GetRecordsOutput. This method will fail if any of the following fields are not set:

• records

Trait Implementations

impl Clone for GetRecordsOutputBuilder

fn clone(&self) -> GetRecordsOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetRecordsOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetRecordsOutputBuilder

fn default() -> GetRecordsOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetRecordsOutputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetRecordsOutputBuilder