public class StreamDescription extends Object implements Serializable
Represents the output for DescribeStream.
Constructor and Description |
---|
StreamDescription() |
Modifier and Type | Method and Description |
---|---|
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.
|
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 |
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 |
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 |
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 String getStreamName()
The name of the stream being described.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
The name of the stream being described.
public void setStreamName(String streamName)
The name of the stream being described.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream being described.
public StreamDescription withStreamName(String streamName)
The name of the stream being described.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream being described.
public String getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
The Amazon Resource Name (ARN) for 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 StreamDescription withStreamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
Returns a reference to this object so that method calls can be chained together.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.
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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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(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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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(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.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
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.
Returns a reference to this object so that method calls can be chained together.
shards
- The shards that comprise the stream.
public StreamDescription withShards(Collection<Shard> shards)
The shards that comprise the stream.
Returns a reference to this object so that method calls can be chained together.
shards
- The shards that comprise the stream.
public Boolean isHasMoreShards()
If set to true
, more shards in the stream are available to
describe.
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.
If set to true
, more shards in the stream are
available to describe.
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 StreamDescription withHasMoreShards(Boolean hasMoreShards)
If set to true
, more shards in the stream are available to
describe.
Returns a reference to this object so that method calls can be chained together.
hasMoreShards
-
If set to true
, more shards in the stream are
available to describe.
public Integer getRetentionPeriodHours()
The current retention period, in hours.
Constraints:
Range: 24 - 168
The current retention period, in hours.
public void setRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
Constraints:
Range: 24 - 168
retentionPeriodHours
- The current retention period, in hours.
public StreamDescription withRetentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 24 - 168
retentionPeriodHours
- The current retention period, in hours.
public List<EnhancedMetrics> getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
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.
Returns a reference to this object so that method calls can be chained together.
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.
Returns a reference to this object so that method calls can be chained together.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2017. All rights reserved.