Struct aws_sdk_kinesis::operation::get_records::GetRecordsOutput

#[non_exhaustive]
pub struct GetRecordsOutput {
    pub records: Vec<Record>,
    pub next_shard_iterator: Option<String>,
    pub millis_behind_latest: Option<i64>,
    pub child_shards: Option<Vec<ChildShard>>,
    /* private fields */
}

Represents the output 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.

records: Vec<Record>

The data records retrieved from the shard.

next_shard_iterator: 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.

millis_behind_latest: 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.

child_shards: 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.

Implementations

impl GetRecordsOutput

pub fn records(&self) -> &[Record]

The data records retrieved from the shard.

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

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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .child_shards.is_none().

impl GetRecordsOutput

pub fn builder() -> GetRecordsOutputBuilder

Creates a new builder-style object to manufacture GetRecordsOutput.

Trait Implementations

impl Clone for GetRecordsOutput

fn clone(&self) -> GetRecordsOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetRecordsOutput

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

Formats the value using the given formatter.

impl PartialEq for GetRecordsOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetRecordsOutput