Class ConsumerDescription
- java.lang.Object
-
- software.amazon.awssdk.services.kinesis.model.ConsumerDescription
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConsumerDescription.Builder,ConsumerDescription>
@Generated("software.amazon.awssdk:codegen") public final class ConsumerDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConsumerDescription.Builder,ConsumerDescription>
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ConsumerDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConsumerDescription.Builder
builder()
String
consumerARN()
When you register a consumer, Kinesis Data Streams generates an ARN for it.Instant
consumerCreationTimestamp()
String
consumerName()
The name of the consumer is something you choose when you register the consumer.ConsumerStatus
consumerStatus()
A consumer can't read data while in theCREATING
orDELETING
states.String
consumerStatusAsString()
A consumer can't read data while in theCREATING
orDELETING
states.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends ConsumerDescription.Builder>
serializableBuilderClass()
String
streamARN()
The ARN of the stream with which you registered the consumer.ConsumerDescription.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
consumerName
public final String 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
public final String 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
public final ConsumerStatus 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:
ConsumerStatus
-
consumerStatusAsString
public final String 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:
ConsumerStatus
-
consumerCreationTimestamp
public final Instant consumerCreationTimestamp()
- Returns:
-
streamARN
public final String 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
public ConsumerDescription.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ConsumerDescription.Builder,ConsumerDescription>
-
builder
public static ConsumerDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConsumerDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-