Interface Consumer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Consumer.Builder,
,Consumer> SdkBuilder<Consumer.Builder,
,Consumer> SdkPojo
- Enclosing class:
Consumer
-
Method Summary
Modifier and TypeMethodDescriptionconsumerARN
(String consumerARN) When you register a consumer, Kinesis Data Streams generates an ARN for it.consumerCreationTimestamp
(Instant consumerCreationTimestamp) consumerName
(String consumerName) The name of the consumer is something you choose when you register the consumer.consumerStatus
(String consumerStatus) A consumer can't read data while in theCREATING
orDELETING
states.consumerStatus
(ConsumerStatus consumerStatus) A consumer can't read data while in theCREATING
orDELETING
states.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
consumerName
The name of the consumer is something you choose when you register the consumer.
- Parameters:
consumerName
- The name of the consumer is something you choose when you register the consumer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumerARN
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.
- Parameters:
consumerARN
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumerStatus
A consumer can't read data while in the
CREATING
orDELETING
states.- Parameters:
consumerStatus
- A consumer can't read data while in theCREATING
orDELETING
states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
consumerStatus
A consumer can't read data while in the
CREATING
orDELETING
states.- Parameters:
consumerStatus
- A consumer can't read data while in theCREATING
orDELETING
states.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
consumerCreationTimestamp
- Parameters:
consumerCreationTimestamp
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-