@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Consumer extends Object implements Serializable, Cloneable, StructuredPojo
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
Constructor and Description |
---|
Consumer() |
Modifier and Type | Method and Description |
---|---|
Consumer |
clone() |
boolean |
equals(Object obj) |
String |
getConsumerARN()
When you register a consumer, Kinesis Data Streams generates an ARN for it.
|
Date |
getConsumerCreationTimestamp()
|
String |
getConsumerName()
The name of the consumer is something you choose when you register the consumer.
|
String |
getConsumerStatus()
A consumer can't read data while in the
CREATING or DELETING states. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setConsumerARN(String consumerARN)
When you register a consumer, Kinesis Data Streams generates an ARN for it.
|
void |
setConsumerCreationTimestamp(Date consumerCreationTimestamp)
|
void |
setConsumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
|
void |
setConsumerStatus(String consumerStatus)
A consumer can't read data while in the
CREATING or DELETING states. |
String |
toString()
Returns a string representation of this object.
|
Consumer |
withConsumerARN(String consumerARN)
When you register a consumer, Kinesis Data Streams generates an ARN for it.
|
Consumer |
withConsumerCreationTimestamp(Date consumerCreationTimestamp)
|
Consumer |
withConsumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
|
Consumer |
withConsumerStatus(ConsumerStatus consumerStatus)
A consumer can't read data while in the
CREATING or DELETING states. |
Consumer |
withConsumerStatus(String consumerStatus)
A consumer can't read data while in the
CREATING or DELETING states. |
public void setConsumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
consumerName
- The name of the consumer is something you choose when you register the consumer.public String getConsumerName()
The name of the consumer is something you choose when you register the consumer.
public Consumer withConsumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
consumerName
- The name of the consumer is something you choose when you register the consumer.public void setConsumerARN(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.
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.
public String getConsumerARN()
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 Consumer withConsumerARN(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.
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.
public void setConsumerStatus(String consumerStatus)
A consumer can't read data while in the CREATING
or DELETING
states.
consumerStatus
- A consumer can't read data while in the CREATING
or DELETING
states.ConsumerStatus
public String getConsumerStatus()
A consumer can't read data while in the CREATING
or DELETING
states.
CREATING
or DELETING
states.ConsumerStatus
public Consumer withConsumerStatus(String consumerStatus)
A consumer can't read data while in the CREATING
or DELETING
states.
consumerStatus
- A consumer can't read data while in the CREATING
or DELETING
states.ConsumerStatus
public Consumer withConsumerStatus(ConsumerStatus consumerStatus)
A consumer can't read data while in the CREATING
or DELETING
states.
consumerStatus
- A consumer can't read data while in the CREATING
or DELETING
states.ConsumerStatus
public void setConsumerCreationTimestamp(Date consumerCreationTimestamp)
consumerCreationTimestamp
- public Date getConsumerCreationTimestamp()
public Consumer withConsumerCreationTimestamp(Date consumerCreationTimestamp)
consumerCreationTimestamp
- public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.