@Generated(value="software.amazon.awssdk:codegen") public final class StreamDescriptionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>
Represents the output for DescribeStreamSummary
Modifier and Type | Class and Description |
---|---|
static interface |
StreamDescriptionSummary.Builder |
Modifier and Type | Method and Description |
---|---|
static StreamDescriptionSummary.Builder |
builder() |
Integer |
consumerCount()
The number of enhanced fan-out consumers registered with the stream.
|
EncryptionType |
encryptionType()
The encryption type used.
|
String |
encryptionTypeAsString()
The encryption type used.
|
List<EnhancedMetrics> |
enhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyId()
The GUID for the customer-managed AWS KMS key to use for encryption.
|
Integer |
openShardCount()
The number of open shards in the stream.
|
Integer |
retentionPeriodHours()
The current retention period, in hours.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StreamDescriptionSummary.Builder> |
serializableBuilderClass() |
String |
streamARN()
The Amazon Resource Name (ARN) for the stream being described.
|
Instant |
streamCreationTimestamp()
The approximate time that the stream was created.
|
String |
streamName()
The name of the stream being described.
|
StreamStatus |
streamStatus()
The current status of the stream being described.
|
String |
streamStatusAsString()
The current status of the stream being described.
|
StreamDescriptionSummary.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String streamName()
The name of the stream being described.
public String streamARN()
The Amazon Resource Name (ARN) for the stream being described.
public 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. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Kinesis Data Streams 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.
If the service returns an enum value that is not available in the current SDK version, streamStatus
will
return StreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
streamStatusAsString()
.
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis Data Streams 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 String streamStatusAsString()
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Kinesis Data Streams 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.
If the service returns an enum value that is not available in the current SDK version, streamStatus
will
return StreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
streamStatusAsString()
.
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis Data Streams 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 Integer retentionPeriodHours()
The current retention period, in hours.
public Instant streamCreationTimestamp()
The approximate time that the stream was created.
public List<EnhancedMetrics> enhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public EncryptionType encryptionType()
The encryption type used. This value is one of the following:
KMS
NONE
If the service returns an enum value that is not available in the current SDK version, encryptionType
will return EncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encryptionTypeAsString()
.
KMS
NONE
EncryptionType
public String encryptionTypeAsString()
The encryption type used. This value is one of the following:
KMS
NONE
If the service returns an enum value that is not available in the current SDK version, encryptionType
will return EncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encryptionTypeAsString()
.
KMS
NONE
EncryptionType
public String keyId()
The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique
identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also
use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis
.
Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
aws/kinesis
.
Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
public Integer openShardCount()
The number of open shards in the stream.
public Integer consumerCount()
The number of enhanced fan-out consumers registered with the stream.
public StreamDescriptionSummary.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>
public static StreamDescriptionSummary.Builder builder()
public static Class<? extends StreamDescriptionSummary.Builder> serializableBuilderClass()
public String toString()
Copyright © 2019. All rights reserved.