Class StreamDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the output for DescribeStream.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Represents the current enhanced monitoring settings of the stream.If set totrue
, more shards in the stream are available to describe.The current retention period, in hours.The shards that comprise the stream.The Amazon Resource Name (ARN) for the stream being described.The name of the stream being described.The current status of the stream being described.int
hashCode()
If set totrue
, more shards in the stream are available to describe.void
setEnhancedMonitoring
(Collection<EnhancedMetrics> enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.void
setHasMoreShards
(Boolean hasMoreShards) If set totrue
, 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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withEnhancedMonitoring
(EnhancedMetrics... enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.withEnhancedMonitoring
(Collection<EnhancedMetrics> enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.withHasMoreShards
(Boolean hasMoreShards) If set totrue
, more shards in the stream are available to describe.withRetentionPeriodHours
(Integer retentionPeriodHours) The current retention period, in hours.withShards
(Shard... shards) The shards that comprise the stream.withShards
(Collection<Shard> shards) The shards that comprise the stream.withStreamARN
(String streamARN) The Amazon Resource Name (ARN) for the stream being described.withStreamName
(String streamName) The name of the stream being described.withStreamStatus
(StreamStatus streamStatus) The current status of the stream being described.withStreamStatus
(String streamStatus) The current status of the stream being described.
-
Constructor Details
-
StreamDescription
public StreamDescription()
-
-
Method Details
-
setStreamName
The name of the stream being described.
- Parameters:
streamName
- The name of the stream being described.
-
getStreamName
The name of the stream being described.
- Returns:
- The name of the stream being described.
-
withStreamName
The name of the stream being described.
- Parameters:
streamName
- The name of the stream being described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStreamARN
The Amazon Resource Name (ARN) for the stream being described.
- Parameters:
streamARN
- The Amazon Resource Name (ARN) for the stream being described.
-
getStreamARN
The Amazon Resource Name (ARN) for the stream being described.
- Returns:
- The Amazon Resource Name (ARN) for the stream being described.
-
withStreamARN
The Amazon Resource Name (ARN) for the stream being described.
- Parameters:
streamARN
- The Amazon Resource Name (ARN) for the stream being described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStreamStatus
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Parameters:
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- See Also:
-
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Returns:
- 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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- See Also:
-
withStreamStatus
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Parameters:
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStreamStatus
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Parameters:
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- See Also:
-
withStreamStatus
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Parameters:
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 setsStreamStatus
toCREATING
.DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream.UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
getShards
The shards that comprise the stream.
- Returns:
- The shards that comprise the stream.
-
setShards
The shards that comprise the stream.
- Parameters:
shards
- The shards that comprise the stream.
-
withShards
The shards that comprise the stream.
NOTE: This method appends the values to the existing list (if any). Use
setShards(java.util.Collection)
orwithShards(java.util.Collection)
if you want to override the existing values.- Parameters:
shards
- The shards that comprise the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withShards
The shards that comprise the stream.
- Parameters:
shards
- The shards that comprise the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHasMoreShards
If set to
true
, more shards in the stream are available to describe.- Parameters:
hasMoreShards
- If set totrue
, more shards in the stream are available to describe.
-
getHasMoreShards
If set to
true
, more shards in the stream are available to describe.- Returns:
- If set to
true
, more shards in the stream are available to describe.
-
withHasMoreShards
If set to
true
, more shards in the stream are available to describe.- Parameters:
hasMoreShards
- If set totrue
, more shards in the stream are available to describe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isHasMoreShards
If set to
true
, more shards in the stream are available to describe.- Returns:
- If set to
true
, more shards in the stream are available to describe.
-
setRetentionPeriodHours
The current retention period, in hours.
- Parameters:
retentionPeriodHours
- The current retention period, in hours.
-
getRetentionPeriodHours
The current retention period, in hours.
- Returns:
- The current retention period, in hours.
-
withRetentionPeriodHours
The current retention period, in hours.
- Parameters:
retentionPeriodHours
- The current retention period, in hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getEnhancedMonitoring
Represents the current enhanced monitoring settings of the stream.
- Returns:
- Represents the current enhanced monitoring settings of the stream.
-
setEnhancedMonitoring
Represents the current enhanced monitoring settings of the stream.
- Parameters:
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
-
withEnhancedMonitoring
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)
orwithEnhancedMonitoring(java.util.Collection)
if you want to override the existing values.- Parameters:
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEnhancedMonitoring
Represents the current enhanced monitoring settings of the stream.
- Parameters:
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-