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) |
Boolean |
getHasMoreShards()
If set to
true , more shards in the stream are available
to describe. |
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 |
setHasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available
to describe. |
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 |
withHasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available
to describe. |
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()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setStreamName(String streamName)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream being described.public StreamDescription withStreamName(String streamName)
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()
public void setStreamARN(String streamARN)
streamARN
- The Amazon Resource Name (ARN) for the stream being described.public StreamDescription withStreamARN(String streamARN)
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 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 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 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 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 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 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()
public void setShards(Collection<Shard> shards)
shards
- The shards that comprise the stream.public StreamDescription withShards(Shard... shards)
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)
Returns a reference to this object so that method calls can be chained together.
shards
- The shards that comprise the stream.public Boolean isHasMoreShards()
true
, more shards in the stream are available
to describe.true
, more shards in the stream are available
to describe.public void setHasMoreShards(Boolean hasMoreShards)
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)
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 Boolean getHasMoreShards()
true
, more shards in the stream are available
to describe.true
, more shards in the stream are available
to describe.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.