Struct aws_sdk_kinesis::model::ShardFilter

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

The request parameter used to filter out the response of the ListShards API.

Implementations

impl ShardFilter

pub fn type(&self) -> Option<&ShardFilterType>

The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.

You can specify the following valid values:

• AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.

• AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.

• FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).

• AT_LATEST - the response includes only the currently open shards of the data stream.

• AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.

• FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.

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

The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.

pub fn timestamp(&self) -> Option<&DateTime>

The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.

impl ShardFilter

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ShardFilter.

Trait Implementations

impl Clone for ShardFilter

fn clone(&self) -> ShardFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShardFilter

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

Formats the value using the given formatter.

impl PartialEq<ShardFilter> for ShardFilter

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