Class ConsumerDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConsumerDescription.Builder,
ConsumerDescription>
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ConsumerDescription.Builder
builder()
final String
When you register a consumer, Kinesis Data Streams generates an ARN for it.final Instant
final String
The name of the consumer is something you choose when you register the consumer.final ConsumerStatus
A consumer can't read data while in theCREATING
orDELETING
states.final String
A consumer can't read data while in theCREATING
orDELETING
states.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends ConsumerDescription.Builder> final String
The ARN of the stream with which you registered the consumer.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
consumerName
The name of the consumer is something you choose when you register the consumer.
- Returns:
- The name of the consumer is something you choose when you register the consumer.
-
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:
- 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.
-
consumerStatus
A consumer can't read data while in the
CREATING
orDELETING
states.If the service returns an enum value that is not available in the current SDK version,
consumerStatus
will returnConsumerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconsumerStatusAsString()
.- Returns:
- A consumer can't read data while in the
CREATING
orDELETING
states. - See Also:
-
consumerStatusAsString
A consumer can't read data while in the
CREATING
orDELETING
states.If the service returns an enum value that is not available in the current SDK version,
consumerStatus
will returnConsumerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconsumerStatusAsString()
.- Returns:
- A consumer can't read data while in the
CREATING
orDELETING
states. - See Also:
-
consumerCreationTimestamp
- Returns:
-
streamARN
The ARN of the stream with which you registered the consumer.
- Returns:
- The ARN of the stream with which you registered the consumer.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConsumerDescription.Builder,
ConsumerDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-