Class StreamDescription
- java.lang.Object
-
- com.amazonaws.services.kinesis.model.StreamDescription
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class StreamDescription extends Object implements Serializable, Cloneable
Represents the output for DescribeStream.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description StreamDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StreamDescription
clone()
boolean
equals(Object obj)
List<EnhancedMetrics>
getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.Boolean
getHasMoreShards()
If set totrue
, 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.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 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.String
toString()
Returns a string representation of this object; useful for testing and debugging.StreamDescription
withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.StreamDescription
withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.StreamDescription
withHasMoreShards(Boolean hasMoreShards)
If set totrue
, more shards in the stream are available to describe.StreamDescription
withRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.StreamDescription
withShards(Shard... shards)
The shards that comprise the stream.StreamDescription
withShards(Collection<Shard> shards)
The shards that comprise the stream.StreamDescription
withStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.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.
-
-
-
Method Detail
-
setStreamName
public void setStreamName(String streamName)
The name of the stream being described.
- Parameters:
streamName
- The name of the stream being described.
-
getStreamName
public String getStreamName()
The name of the stream being described.
- Returns:
- The name of the stream being described.
-
withStreamName
public StreamDescription withStreamName(String streamName)
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
public void setStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
- Parameters:
streamARN
- The Amazon Resource Name (ARN) for the stream being described.
-
getStreamARN
public String getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
- Returns:
- The Amazon Resource Name (ARN) for the stream being described.
-
withStreamARN
public StreamDescription withStreamARN(String streamARN)
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
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 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:
StreamStatus
-
getStreamStatus
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 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:
StreamStatus
-
withStreamStatus
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 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:
StreamStatus
-
setStreamStatus
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 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:
StreamStatus
-
withStreamStatus
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 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:
StreamStatus
-
getShards
public List<Shard> getShards()
The shards that comprise the stream.
- Returns:
- The shards that comprise the stream.
-
setShards
public void setShards(Collection<Shard> shards)
The shards that comprise the stream.
- Parameters:
shards
- The shards that comprise the stream.
-
withShards
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)
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
public StreamDescription withShards(Collection<Shard> shards)
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
public void setHasMoreShards(Boolean hasMoreShards)
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
public Boolean 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
public StreamDescription withHasMoreShards(Boolean hasMoreShards)
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
public Boolean 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
public void setRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
- Parameters:
retentionPeriodHours
- The current retention period, in hours.
-
getRetentionPeriodHours
public Integer getRetentionPeriodHours()
The current retention period, in hours.
- Returns:
- The current retention period, in hours.
-
withRetentionPeriodHours
public StreamDescription withRetentionPeriodHours(Integer retentionPeriodHours)
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
public List<EnhancedMetrics> getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
- Returns:
- Represents the current enhanced monitoring settings of the stream.
-
setEnhancedMonitoring
public void setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
- Parameters:
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
-
withEnhancedMonitoring
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)
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
public StreamDescription withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public StreamDescription clone()
-
-