@Generated(value="software.amazon.awssdk:codegen") public final class StreamDescription extends Object implements StructuredPojo, 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Boolean |
hasMoreShards()
If set to
true , more shards in the stream are available to describe. |
String |
keyId()
The GUID for the customer-managed KMS key to use for encryption.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
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.
|
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.
|
StreamDescription.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
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 Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Kinesis 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 Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis 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 Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state
until Kinesis 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 Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis 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 List<Shard> shards()
The shards that comprise the stream.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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 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 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 KMS
key.
EncryptionType
public 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 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 KMS
key.
EncryptionType
public String keyId()
The GUID for the customer-managed 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 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 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 Streams: alias/aws/kinesis
public StreamDescription.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StreamDescription.Builder,StreamDescription>
public static StreamDescription.Builder builder()
public static Class<? extends StreamDescription.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.