@Generated(value="software.amazon.awssdk:codegen") public final class Consumer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Consumer.Builder,Consumer>
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
Modifier and Type | Class and Description |
---|---|
static interface |
Consumer.Builder |
Modifier and Type | Method and Description |
---|---|
static Consumer.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 the
CREATING or DELETING states. |
String |
consumerStatusAsString()
A consumer can't read data while in the
CREATING or DELETING states. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends Consumer.Builder> |
serializableBuilderClass() |
Consumer.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String consumerName()
The name of the consumer is something you choose when you register the consumer.
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.
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.
public final ConsumerStatus consumerStatus()
A consumer can't read data while in the CREATING
or DELETING
states.
If the service returns an enum value that is not available in the current SDK version, consumerStatus
will return ConsumerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from consumerStatusAsString()
.
CREATING
or DELETING
states.ConsumerStatus
public final String consumerStatusAsString()
A consumer can't read data while in the CREATING
or DELETING
states.
If the service returns an enum value that is not available in the current SDK version, consumerStatus
will return ConsumerStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from consumerStatusAsString()
.
CREATING
or DELETING
states.ConsumerStatus
public final Instant consumerCreationTimestamp()
public Consumer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Consumer.Builder,Consumer>
public static Consumer.Builder builder()
public static Class<? extends Consumer.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()