@Generated(value="software.amazon.awssdk:codegen") public final class StreamDescription extends Object implements SdkPojo, Serializable, 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() |
EncryptionType |
encryptionType()
The server-side encryption type used on the stream.
|
String |
encryptionTypeAsString()
The server-side encryption type used on the stream.
|
List<EnhancedMetrics> |
enhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEnhancedMonitoring()
For responses, this returns true if the service returned a value for the EnhancedMonitoring property.
|
int |
hashCode() |
Boolean |
hasMoreShards()
If set to
true , more shards in the stream are available to describe. |
boolean |
hasShards()
For responses, this returns true if the service returned a value for the Shards property.
|
String |
keyId()
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
Integer |
retentionPeriodHours()
The current retention period, in hours.
|
List<SdkField<?>> |
sdkFields() |
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.
|
Instant |
streamCreationTimestamp()
The approximate time that the stream was created.
|
StreamModeDetails |
streamModeDetails()
Specifies the capacity mode to which you want to set your data stream.
|
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.
|
StreamDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String streamName()
The name of the stream being described.
public final String streamARN()
The Amazon Resource Name (ARN) for the stream being described.
public final 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 final 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 final StreamModeDetails streamModeDetails()
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
public final boolean hasShards()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Shard> shards()
The shards that comprise the stream.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasShards()
method.
public final 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 final Integer retentionPeriodHours()
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
public final Instant streamCreationTimestamp()
The approximate time that the stream was created.
public final boolean hasEnhancedMonitoring()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnhancedMonitoring()
method.
public final EncryptionType encryptionType()
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
Services KMS key.
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()
.
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon
Web Services KMS key.
EncryptionType
public final String encryptionTypeAsString()
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
Services KMS key.
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()
.
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon
Web Services KMS key.
EncryptionType
public final String keyId()
The GUID for the customer-managed Amazon Web Services 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 StreamDescription.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
public static StreamDescription.Builder builder()
public static Class<? extends StreamDescription.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.