Struct aws_sdk_kinesis::operation::describe_stream_consumer::builders::DescribeStreamConsumerFluentBuilder
source · pub struct DescribeStreamConsumerFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeStreamConsumer
.
To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers
operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream.
When making a cross-account call with DescribeStreamConsumer
, make sure to provide the ARN of the consumer.
Implementations§
source§impl DescribeStreamConsumerFluentBuilder
impl DescribeStreamConsumerFluentBuilder
sourcepub fn as_input(&self) -> &DescribeStreamConsumerInputBuilder
pub fn as_input(&self) -> &DescribeStreamConsumerInputBuilder
Access the DescribeStreamConsumer as a reference.
sourcepub async fn send(
self
) -> Result<DescribeStreamConsumerOutput, SdkError<DescribeStreamConsumerError, HttpResponse>>
pub async fn send( self ) -> Result<DescribeStreamConsumerOutput, SdkError<DescribeStreamConsumerError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<DescribeStreamConsumerOutput, DescribeStreamConsumerError, Self>
pub fn customize( self ) -> CustomizableOperation<DescribeStreamConsumerOutput, DescribeStreamConsumerError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
sourcepub fn consumer_name(self, input: impl Into<String>) -> Self
pub fn consumer_name(self, input: impl Into<String>) -> Self
The name that you gave to the consumer.
sourcepub fn set_consumer_name(self, input: Option<String>) -> Self
pub fn set_consumer_name(self, input: Option<String>) -> Self
The name that you gave to the consumer.
sourcepub fn get_consumer_name(&self) -> &Option<String>
pub fn get_consumer_name(&self) -> &Option<String>
The name that you gave to the consumer.
sourcepub fn consumer_arn(self, input: impl Into<String>) -> Self
pub fn consumer_arn(self, input: impl Into<String>) -> Self
The ARN returned by Kinesis Data Streams when you registered the consumer.
sourcepub fn set_consumer_arn(self, input: Option<String>) -> Self
pub fn set_consumer_arn(self, input: Option<String>) -> Self
The ARN returned by Kinesis Data Streams when you registered the consumer.
sourcepub fn get_consumer_arn(&self) -> &Option<String>
pub fn get_consumer_arn(&self) -> &Option<String>
The ARN returned by Kinesis Data Streams when you registered the consumer.
Trait Implementations§
source§impl Clone for DescribeStreamConsumerFluentBuilder
impl Clone for DescribeStreamConsumerFluentBuilder
source§fn clone(&self) -> DescribeStreamConsumerFluentBuilder
fn clone(&self) -> DescribeStreamConsumerFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DescribeStreamConsumerFluentBuilder
impl !RefUnwindSafe for DescribeStreamConsumerFluentBuilder
impl Send for DescribeStreamConsumerFluentBuilder
impl Sync for DescribeStreamConsumerFluentBuilder
impl Unpin for DescribeStreamConsumerFluentBuilder
impl !UnwindSafe for DescribeStreamConsumerFluentBuilder
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> 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 more