@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StreamDescription extends Object implements Serializable, Cloneable, StructuredPojo
Represents the output for DescribeStream.
Constructor and Description |
---|
StreamDescription() |
Modifier and Type | Method and Description |
---|---|
StreamDescription |
clone() |
boolean |
equals(Object obj) |
List<EnhancedMetrics> |
getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
|
Boolean |
getHasMoreShards()
If set to
true , more shards in the stream are available to describe. |
Integer |
getRetentionPeriodHours()
The current retention period, in hours.
|
List<Shard> |
getShards()
The shards that comprise the stream.
|
String |
getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
|
Date |
getStreamCreationTimestamp()
The approximate time that the stream was created.
|
String |
getStreamName()
The name of the stream being described.
|
String |
getStreamStatus()
The current status of the stream being described.
|
int |
hashCode() |
Boolean |
isHasMoreShards()
If set to
true , more shards in the stream are available to describe. |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
void |
setHasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available to describe. |
void |
setRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
|
void |
setShards(Collection<Shard> shards)
The shards that comprise the stream.
|
void |
setStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
void |
setStreamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
|
void |
setStreamName(String streamName)
The name of the stream being described.
|
void |
setStreamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
void |
setStreamStatus(String streamStatus)
The current status of the stream being described.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
StreamDescription |
withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription |
withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription |
withHasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available to describe. |
StreamDescription |
withRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
|
StreamDescription |
withShards(Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription |
withShards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription |
withStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
StreamDescription |
withStreamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
|
StreamDescription |
withStreamName(String streamName)
The name of the stream being described.
|
StreamDescription |
withStreamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
StreamDescription |
withStreamStatus(String streamStatus)
The current status of the stream being described.
|
public void setStreamName(String streamName)
The name of the stream being described.
streamName
- The name of the stream being described.public String getStreamName()
The name of the stream being described.
public StreamDescription withStreamName(String streamName)
The name of the stream being described.
streamName
- The name of the stream being described.public void setStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.public String getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
public StreamDescription withStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.public void setStreamStatus(String streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue
to work while the stream is in the UPDATING
state.
StreamStatus
public String getStreamStatus()
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
StreamStatus
public StreamDescription withStreamStatus(String streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue
to work while the stream is in the UPDATING
state.
StreamStatus
public void setStreamStatus(StreamStatus streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue
to work while the stream is in the UPDATING
state.
StreamStatus
public StreamDescription withStreamStatus(StreamStatus streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Amazon Kinesis completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue
to work while the stream is in the UPDATING
state.
StreamStatus
public List<Shard> getShards()
The shards that comprise the stream.
public void setShards(Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.public StreamDescription withShards(Shard... shards)
The shards that comprise the stream.
NOTE: This method appends the values to the existing list (if any). Use
setShards(java.util.Collection)
or withShards(java.util.Collection)
if you want to override the
existing values.
shards
- The shards that comprise the stream.public StreamDescription withShards(Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.public void setHasMoreShards(Boolean hasMoreShards)
If set to true
, more shards in the stream are available to describe.
hasMoreShards
- If set to true
, more shards in the stream are available to describe.public Boolean getHasMoreShards()
If set to true
, more shards in the stream are available to describe.
true
, more shards in the stream are available to describe.public StreamDescription withHasMoreShards(Boolean hasMoreShards)
If set to true
, more shards in the stream are available to describe.
hasMoreShards
- If set to true
, more shards in the stream are available to describe.public Boolean isHasMoreShards()
If set to true
, more shards in the stream are available to describe.
true
, more shards in the stream are available to describe.public void setRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
retentionPeriodHours
- The current retention period, in hours.public Integer getRetentionPeriodHours()
The current retention period, in hours.
public StreamDescription withRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
retentionPeriodHours
- The current retention period, in hours.public void setStreamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.public Date getStreamCreationTimestamp()
The approximate time that the stream was created.
public StreamDescription withStreamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.public List<EnhancedMetrics> getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
public void setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.public StreamDescription withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
NOTE: This method appends the values to the existing list (if any). Use
setEnhancedMonitoring(java.util.Collection)
or withEnhancedMonitoring(java.util.Collection)
if
you want to override the existing values.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.public StreamDescription withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.public String toString()
toString
in class Object
Object.toString()
public StreamDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2017. All rights reserved.