Struct aws_sdk_kinesis::types::builders::ConsumerDescriptionBuilder
source · #[non_exhaustive]pub struct ConsumerDescriptionBuilder { /* private fields */ }
Expand description
A builder for ConsumerDescription
.
Implementations§
source§impl ConsumerDescriptionBuilder
impl ConsumerDescriptionBuilder
sourcepub fn consumer_name(self, input: impl Into<String>) -> Self
pub fn consumer_name(self, input: impl Into<String>) -> Self
The name of the consumer is something you choose when you register the consumer.
This field is required.sourcepub fn set_consumer_name(self, input: Option<String>) -> Self
pub fn set_consumer_name(self, input: Option<String>) -> Self
The name of the consumer is something you choose when you register the consumer.
sourcepub fn get_consumer_name(&self) -> &Option<String>
pub fn get_consumer_name(&self) -> &Option<String>
The name of the consumer is something you choose when you register the consumer.
sourcepub fn consumer_arn(self, input: impl Into<String>) -> Self
pub fn consumer_arn(self, input: impl Into<String>) -> Self
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard
.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
This field is required.sourcepub fn set_consumer_arn(self, input: Option<String>) -> Self
pub fn set_consumer_arn(self, input: Option<String>) -> Self
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard
.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
sourcepub fn get_consumer_arn(&self) -> &Option<String>
pub fn get_consumer_arn(&self) -> &Option<String>
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard
.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
sourcepub fn consumer_status(self, input: ConsumerStatus) -> Self
pub fn consumer_status(self, input: ConsumerStatus) -> Self
A consumer can't read data while in the CREATING
or DELETING
states.
sourcepub fn set_consumer_status(self, input: Option<ConsumerStatus>) -> Self
pub fn set_consumer_status(self, input: Option<ConsumerStatus>) -> Self
A consumer can't read data while in the CREATING
or DELETING
states.
sourcepub fn get_consumer_status(&self) -> &Option<ConsumerStatus>
pub fn get_consumer_status(&self) -> &Option<ConsumerStatus>
A consumer can't read data while in the CREATING
or DELETING
states.
sourcepub fn consumer_creation_timestamp(self, input: DateTime) -> Self
pub fn consumer_creation_timestamp(self, input: DateTime) -> Self
sourcepub fn set_consumer_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_consumer_creation_timestamp(self, input: Option<DateTime>) -> Self
sourcepub fn get_consumer_creation_timestamp(&self) -> &Option<DateTime>
pub fn get_consumer_creation_timestamp(&self) -> &Option<DateTime>
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 with which you registered the consumer.
This field is required.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 with which you registered the consumer.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The ARN of the stream with which you registered the consumer.
sourcepub fn build(self) -> Result<ConsumerDescription, BuildError>
pub fn build(self) -> Result<ConsumerDescription, BuildError>
Consumes the builder and constructs a ConsumerDescription
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for ConsumerDescriptionBuilder
impl Clone for ConsumerDescriptionBuilder
source§fn clone(&self) -> ConsumerDescriptionBuilder
fn clone(&self) -> ConsumerDescriptionBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ConsumerDescriptionBuilder
impl Debug for ConsumerDescriptionBuilder
source§impl Default for ConsumerDescriptionBuilder
impl Default for ConsumerDescriptionBuilder
source§fn default() -> ConsumerDescriptionBuilder
fn default() -> ConsumerDescriptionBuilder
source§impl PartialEq for ConsumerDescriptionBuilder
impl PartialEq for ConsumerDescriptionBuilder
source§fn eq(&self, other: &ConsumerDescriptionBuilder) -> bool
fn eq(&self, other: &ConsumerDescriptionBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ConsumerDescriptionBuilder
Auto Trait Implementations§
impl Freeze for ConsumerDescriptionBuilder
impl RefUnwindSafe for ConsumerDescriptionBuilder
impl Send for ConsumerDescriptionBuilder
impl Sync for ConsumerDescriptionBuilder
impl Unpin for ConsumerDescriptionBuilder
impl UnwindSafe for ConsumerDescriptionBuilder
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