#[non_exhaustive]pub struct ListShardsInputBuilder { /* private fields */ }
Expand description
A builder for ListShardsInput
.
Implementations§
Source§impl ListShardsInputBuilder
impl ListShardsInputBuilder
Sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn get_stream_name(&self) -> &Option<String>
pub fn get_stream_name(&self) -> &Option<String>
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
When the number of shards in the data stream is greater than the default value for the MaxResults
parameter, or if you explicitly specify a value for MaxResults
that is less than the number of shards in the data stream, the response includes a pagination token named NextToken
. You can specify this NextToken
value in a subsequent call to ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when you specify NextToken
. If you specify a MaxResults
value that is less than the number of shards that the operation returns if you don't specify MaxResults
, the response will contain a new NextToken
value. You can use the new NextToken
value in a subsequent call to the ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards
, you get ExpiredNextTokenException
.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
When the number of shards in the data stream is greater than the default value for the MaxResults
parameter, or if you explicitly specify a value for MaxResults
that is less than the number of shards in the data stream, the response includes a pagination token named NextToken
. You can specify this NextToken
value in a subsequent call to ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when you specify NextToken
. If you specify a MaxResults
value that is less than the number of shards that the operation returns if you don't specify MaxResults
, the response will contain a new NextToken
value. You can use the new NextToken
value in a subsequent call to the ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards
, you get ExpiredNextTokenException
.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
When the number of shards in the data stream is greater than the default value for the MaxResults
parameter, or if you explicitly specify a value for MaxResults
that is less than the number of shards in the data stream, the response includes a pagination token named NextToken
. You can specify this NextToken
value in a subsequent call to ListShards
to list the next set of shards.
Don't specify StreamName
or StreamCreationTimestamp
if you specify NextToken
because the latter unambiguously identifies the stream.
You can optionally specify a value for the MaxResults
parameter when you specify NextToken
. If you specify a MaxResults
value that is less than the number of shards that the operation returns if you don't specify MaxResults
, the response will contain a new NextToken
value. You can use the new NextToken
value in a subsequent call to the ListShards
operation.
Tokens expire after 300 seconds. When you obtain a value for NextToken
in the response to a call to ListShards
, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards
, you get ExpiredNextTokenException
.
Sourcepub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
pub fn exclusive_start_shard_id(self, input: impl Into<String>) -> Self
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for ListShards
to list the shards starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken
.
Sourcepub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
pub fn set_exclusive_start_shard_id(self, input: Option<String>) -> Self
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for ListShards
to list the shards starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken
.
Sourcepub fn get_exclusive_start_shard_id(&self) -> &Option<String>
pub fn get_exclusive_start_shard_id(&self) -> &Option<String>
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior is for ListShards
to list the shards starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken
.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of shards to return in a single call to ListShards
. The maximum number of shards to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000 results are returned.
When the number of shards to be listed is greater than the value of MaxResults
, the response contains a NextToken
value that you can use in a subsequent call to ListShards
to list the next set of shards.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of shards to return in a single call to ListShards
. The maximum number of shards to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000 results are returned.
When the number of shards to be listed is greater than the value of MaxResults
, the response contains a NextToken
value that you can use in a subsequent call to ListShards
to list the next set of shards.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of shards to return in a single call to ListShards
. The maximum number of shards to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000 results are returned.
When the number of shards to be listed is greater than the value of MaxResults
, the response contains a NextToken
value that you can use in a subsequent call to ListShards
to list the next set of shards.
Sourcepub fn stream_creation_timestamp(self, input: DateTime) -> Self
pub fn stream_creation_timestamp(self, input: DateTime) -> Self
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn get_stream_creation_timestamp(&self) -> &Option<DateTime>
pub fn get_stream_creation_timestamp(&self) -> &Option<DateTime>
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken
parameter.
Sourcepub fn shard_filter(self, input: ShardFilter) -> Self
pub fn shard_filter(self, input: ShardFilter) -> Self
Enables you to filter out the response of the ListShards
API. You can only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API, the Type
is the required property and must be specified. If you specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the value for the optional ShardId
property. The ShardId
property is identical in fuctionality to the ExclusiveStartShardId
parameter of the ListShards
API. When ShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must also provide the value for the optional Timestamp
property. If you specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP are returned.
Sourcepub fn set_shard_filter(self, input: Option<ShardFilter>) -> Self
pub fn set_shard_filter(self, input: Option<ShardFilter>) -> Self
Enables you to filter out the response of the ListShards
API. You can only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API, the Type
is the required property and must be specified. If you specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the value for the optional ShardId
property. The ShardId
property is identical in fuctionality to the ExclusiveStartShardId
parameter of the ListShards
API. When ShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must also provide the value for the optional Timestamp
property. If you specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP are returned.
Sourcepub fn get_shard_filter(&self) -> &Option<ShardFilter>
pub fn get_shard_filter(&self) -> &Option<ShardFilter>
Enables you to filter out the response of the ListShards
API. You can only specify one filter at a time.
If you use the ShardFilter
parameter when invoking the ListShards API, the Type
is the required property and must be specified. If you specify the AT_TRIM_HORIZON
, FROM_TRIM_HORIZON
, or AT_LATEST
types, you do not need to specify either the ShardId
or the Timestamp
optional properties.
If you specify the AFTER_SHARD_ID
type, you must also provide the value for the optional ShardId
property. The ShardId
property is identical in fuctionality to the ExclusiveStartShardId
parameter of the ListShards
API. When ShardId
property is specified, the response includes the shards starting with the shard whose ID immediately follows the ShardId
that you provided.
If you specify the AT_TIMESTAMP
or FROM_TIMESTAMP_ID
type, you must also provide the value for the optional Timestamp
property. If you specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP are returned.
Sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the stream.
Sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the stream.
Sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The ARN of the stream.
Sourcepub fn build(self) -> Result<ListShardsInput, BuildError>
pub fn build(self) -> Result<ListShardsInput, BuildError>
Consumes the builder and constructs a ListShardsInput
.
Source§impl ListShardsInputBuilder
impl ListShardsInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ListShardsOutput, SdkError<ListShardsError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ListShardsOutput, SdkError<ListShardsError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ListShardsInputBuilder
impl Clone for ListShardsInputBuilder
Source§fn clone(&self) -> ListShardsInputBuilder
fn clone(&self) -> ListShardsInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ListShardsInputBuilder
impl Debug for ListShardsInputBuilder
Source§impl Default for ListShardsInputBuilder
impl Default for ListShardsInputBuilder
Source§fn default() -> ListShardsInputBuilder
fn default() -> ListShardsInputBuilder
Source§impl PartialEq for ListShardsInputBuilder
impl PartialEq for ListShardsInputBuilder
impl StructuralPartialEq for ListShardsInputBuilder
Auto Trait Implementations§
impl Freeze for ListShardsInputBuilder
impl RefUnwindSafe for ListShardsInputBuilder
impl Send for ListShardsInputBuilder
impl Sync for ListShardsInputBuilder
impl Unpin for ListShardsInputBuilder
impl UnwindSafe for ListShardsInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);