@Generated(value="software.amazon.awssdk:codegen") public class StreamDescription extends Object implements StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
Represents the output for DescribeStream.
Modifier and Type | Class and Description |
---|---|
static interface |
StreamDescription.Builder |
Modifier and Type | Method and Description |
---|---|
static StreamDescription.Builder |
builder() |
List<EnhancedMetrics> |
enhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
|
boolean |
equals(Object obj) |
int |
hashCode() |
Boolean |
hasMoreShards()
If set to
true , more shards in the stream are available to describe. |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
Integer |
retentionPeriodHours()
The current retention period, in hours.
|
static Class<? extends StreamDescription.Builder> |
serializableBuilderClass() |
List<Shard> |
shards()
The shards that comprise the stream.
|
String |
streamARN()
The Amazon Resource Name (ARN) for the stream being described.
|
Date |
streamCreationTimestamp()
The approximate time that the stream was created.
|
String |
streamName()
The name of the stream being described.
|
String |
streamStatus()
The current status of the stream being described.
|
StreamDescription.Builder |
toBuilder() |
String |
toString() |
public String streamName()
The name of the stream being described.
public String streamARN()
The Amazon Resource Name (ARN) for the stream being described.
public 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.
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> shards()
The shards that comprise the stream.
public Boolean hasMoreShards()
If set to true
, more shards in the stream are available to describe.
true
, more shards in the stream are available to describe.public Integer retentionPeriodHours()
The current retention period, in hours.
public Date streamCreationTimestamp()
The approximate time that the stream was created.
public List<EnhancedMetrics> enhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
public StreamDescription.Builder toBuilder()
toBuilder
in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
public static StreamDescription.Builder builder()
public static Class<? extends StreamDescription.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2017. All rights reserved.