ConsumerDescription (AWS Java SDK for Amazon Kinesis 1.12.666 API)

java.lang.Object
- com.amazonaws.services.kinesis.model.ConsumerDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConsumerDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConsumerDescription()

Constructors
Constructor and Description
`ConsumerDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConsumerDescription`	`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.
`String`	`getStreamARN()` The ARN of the stream with which you registered the consumer.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller 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.
`void`	`setStreamARN(String streamARN)` The ARN of the stream with which you registered the consumer.
`String`	`toString()` Returns a string representation of this object.
`ConsumerDescription`	`withConsumerARN(String consumerARN)` When you register a consumer, Kinesis Data Streams generates an ARN for it.
`ConsumerDescription`	`withConsumerCreationTimestamp(Date consumerCreationTimestamp)`
`ConsumerDescription`	`withConsumerName(String consumerName)` The name of the consumer is something you choose when you register the consumer.
`ConsumerDescription`	`withConsumerStatus(ConsumerStatus consumerStatus)` A consumer can't read data while in the `CREATING` or `DELETING` states.
`ConsumerDescription`	`withConsumerStatus(String consumerStatus)` A consumer can't read data while in the `CREATING` or `DELETING` states.
`ConsumerDescription`	`withStreamARN(String streamARN)` The ARN of the stream with which you registered the consumer.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConsumerDescription
```
public ConsumerDescription()
```
- Method Detail
  - setConsumerName
```
public void setConsumerName(String consumerName)
```
    The name of the consumer is something you choose when you register the consumer.
    
    Parameters:
    
    consumerName - The name of the consumer is something you choose when you register the consumer.
  - getConsumerName
```
public String getConsumerName()
```
    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.
  - withConsumerName
```
public ConsumerDescription withConsumerName(String consumerName)
```
    The name of the consumer is something you choose when you register the consumer.
    
    Parameters:
    
    consumerName - The name of the consumer is something you choose when you register the consumer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumerARN
```
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.
    
    Parameters:
    
    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.
  - getConsumerARN
```
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.
    
    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.
  - withConsumerARN
```
public ConsumerDescription 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumerStatus
```
public void setConsumerStatus(String consumerStatus)
```
    A consumer can't read data while in the CREATING or DELETING states.
    
    Parameters:
    
    consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
    
    See Also:
    
    ConsumerStatus
  - getConsumerStatus
```
public String getConsumerStatus()
```
    A consumer can't read data while in the CREATING or DELETING states.
    
    Returns:
    
    A consumer can't read data while in the CREATING or DELETING states.
    
    See Also:
    
    ConsumerStatus
  - withConsumerStatus
```
public ConsumerDescription withConsumerStatus(String consumerStatus)
```
    A consumer can't read data while in the CREATING or DELETING states.
    
    Parameters:
    
    consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConsumerStatus
  - withConsumerStatus
```
public ConsumerDescription withConsumerStatus(ConsumerStatus consumerStatus)
```
    A consumer can't read data while in the CREATING or DELETING states.
    
    Parameters:
    
    consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConsumerStatus
  - setConsumerCreationTimestamp
```
public void setConsumerCreationTimestamp(Date consumerCreationTimestamp)
```
    Parameters:
    
    consumerCreationTimestamp -
  - getConsumerCreationTimestamp
```
public Date getConsumerCreationTimestamp()
```
    Returns:
  - withConsumerCreationTimestamp
```
public ConsumerDescription withConsumerCreationTimestamp(Date consumerCreationTimestamp)
```
    Parameters:
    
    consumerCreationTimestamp -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamARN
```
public void setStreamARN(String streamARN)
```
    The ARN of the stream with which you registered the consumer.
    
    Parameters:
    
    streamARN - The ARN of the stream with which you registered the consumer.
  - getStreamARN
```
public String getStreamARN()
```
    The ARN of the stream with which you registered the consumer.
    
    Returns:
    
    The ARN of the stream with which you registered the consumer.
  - withStreamARN
```
public ConsumerDescription withStreamARN(String streamARN)
```
    The ARN of the stream with which you registered the consumer.
    
    Parameters:
    
    streamARN - The ARN of the stream with which you registered the consumer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConsumerDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ConsumerDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumerDescription

Method Detail

setConsumerName

getConsumerName

withConsumerName

setConsumerARN

getConsumerARN

withConsumerARN

setConsumerStatus

getConsumerStatus

withConsumerStatus

withConsumerStatus

setConsumerCreationTimestamp

getConsumerCreationTimestamp

withConsumerCreationTimestamp

setStreamARN

getStreamARN

withStreamARN

toString

equals

hashCode

clone

marshall