software.amazon.awssdk.services.kinesis.model

Class Consumer

java.lang.Object

software.amazon.awssdk.services.kinesis.model.Consumer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Consumer.Builder,Consumer>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Consumer.Builder

Method Summary

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.

Methods inherited from class java.lang.Object

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 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().

Returns:

A consumer can't read data while in the CREATING or DELETING states.

See Also:

ConsumerStatus

consumerStatusAsString

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().

Returns:

A consumer can't read data while in the CREATING or DELETING states.

See Also:

ConsumerStatus

consumerCreationTimestamp

public final Instant consumerCreationTimestamp()

Returns:

toBuilder

public Consumer.Builder 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 interface ToCopyableBuilder<Consumer.Builder,Consumer>

Returns:

a builder for type T

builder

public static Consumer.Builder builder()

serializableBuilderClass

public static Class<? extends Consumer.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.