Struct GetStreamOutput

#[non_exhaustive]
pub struct GetStreamOutput {
    pub stream_arn: String,
    pub stream_label: String,
    pub stream_status: StreamStatus,
    pub stream_view_type: StreamViewType,
    pub creation_request_date_time: DateTime,
    pub keyspace_name: String,
    pub table_name: String,
    pub shards: Option<Vec<Shard>>,
    pub next_token: Option<String>,
    /* private fields */
}

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.

stream_arn: String

The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

stream_label: String

A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

stream_status: StreamStatus

The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

stream_view_type: StreamViewType

The format of the data records in this stream. Currently, this can be one of the following options:

• NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

• NEW_IMAGE - the version of the row after the change.

• OLD_IMAGE - the version of the row before the change.

• KEYS_ONLY - the partition and clustering keys of the row that was changed.

creation_request_date_time: DateTime

The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

keyspace_name: String

The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

table_name: String

The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

shards: Option<Vec<Shard>>

An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.

next_token: Option<String>

A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

Implementations

impl GetStreamOutput

pub fn stream_arn(&self) -> &str

The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

pub fn stream_label(&self) -> &str

A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

pub fn stream_status(&self) -> &StreamStatus

The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

pub fn stream_view_type(&self) -> &StreamViewType

The format of the data records in this stream. Currently, this can be one of the following options:

• NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

• NEW_IMAGE - the version of the row after the change.

• OLD_IMAGE - the version of the row before the change.

• KEYS_ONLY - the partition and clustering keys of the row that was changed.

pub fn creation_request_date_time(&self) -> &DateTime

The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

pub fn keyspace_name(&self) -> &str

The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

pub fn table_name(&self) -> &str

The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.

pub fn shards(&self) -> &[Shard]

An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.

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

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

A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

impl GetStreamOutput

pub fn builder() -> GetStreamOutputBuilder

Creates a new builder-style object to manufacture GetStreamOutput.

Trait Implementations

impl Clone for GetStreamOutput

fn clone(&self) -> GetStreamOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetStreamOutput

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

Formats the value using the given formatter.

impl PartialEq for GetStreamOutput

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

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

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

impl StructuralPartialEq for GetStreamOutput