public static interface StreamDescription.Builder extends software.amazon.awssdk.utils.builder.CopyableBuilder<StreamDescription.Builder,StreamDescription>
Modifier and Type | Method and Description |
---|---|
StreamDescription.Builder |
enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription.Builder |
enhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription.Builder |
hasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available to describe. |
StreamDescription.Builder |
retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
|
StreamDescription.Builder |
shards(Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription.Builder |
shards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription.Builder |
streamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
StreamDescription.Builder |
streamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
|
StreamDescription.Builder |
streamName(String streamName)
The name of the stream being described.
|
StreamDescription.Builder |
streamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
StreamDescription.Builder |
streamStatus(String streamStatus)
The current status of the stream being described.
|
copy
apply, build
StreamDescription.Builder streamName(String streamName)
The name of the stream being described.
streamName
- The name of the stream being described.StreamDescription.Builder streamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.StreamDescription.Builder streamStatus(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.
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
StreamDescription.Builder streamStatus(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.
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
StreamDescription.Builder shards(Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.StreamDescription.Builder shards(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)
or #withShards(java.util.Collection)
if you want to override
the existing values.
shards
- The shards that comprise the stream.StreamDescription.Builder hasMoreShards(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.StreamDescription.Builder retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
retentionPeriodHours
- The current retention period, in hours.StreamDescription.Builder streamCreationTimestamp(Date streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.StreamDescription.Builder enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.StreamDescription.Builder enhancedMonitoring(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)
or #withEnhancedMonitoring(java.util.Collection)
if you want to override the existing values.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.Copyright © 2017. All rights reserved.