Class StreamDescriptionSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamDescriptionSummary.Builder,
StreamDescriptionSummary>
Represents the output for DescribeStreamSummary
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Integer
The number of enhanced fan-out consumers registered with the stream.final EncryptionType
The encryption type used.final String
The encryption type used.final List
<EnhancedMetrics> Represents the current enhanced monitoring settings of the stream.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EnhancedMonitoring property.final int
hashCode()
final String
keyId()
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.final Integer
The number of open shards in the stream.final Integer
The current retention period, in hours.static Class
<? extends StreamDescriptionSummary.Builder> final String
The Amazon Resource Name (ARN) for the stream being described.final Instant
The approximate time that the stream was created.final StreamModeDetails
Specifies the capacity mode to which you want to set your data stream.final String
The name of the stream being described.final StreamStatus
The current status of the stream being described.final String
The current status of the stream being described.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
streamName
The name of the stream being described.
- Returns:
- The name of the stream being described.
-
streamARN
The Amazon Resource Name (ARN) for the stream being described.
- Returns:
- The Amazon Resource Name (ARN) for the stream being described.
-
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 setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream. -
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
If the service returns an enum value that is not available in the current SDK version,
streamStatus
will returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- Returns:
- 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 setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream. -
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
-
- See Also:
-
-
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 setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream. -
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
If the service returns an enum value that is not available in the current SDK version,
streamStatus
will returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- Returns:
- 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 setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream. -
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
-
- See Also:
-
-
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 ycapacity mode and a provisioned capacity mode for your data streams.
- Returns:
- 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 ycapacity mode and a provisioned capacity mode for your data streams.
-
retentionPeriodHours
The current retention period, in hours.
- Returns:
- The current retention period, in hours.
-
streamCreationTimestamp
The approximate time that the stream was created.
- Returns:
- The approximate time that the stream was created.
-
hasEnhancedMonitoring
public final boolean hasEnhancedMonitoring()For responses, this returns true if the service returned a value for the EnhancedMonitoring property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- Represents the current enhanced monitoring settings of the stream.
-
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 returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- The encryption type used. This value is one of the following:
-
KMS
-
NONE
-
- See Also:
-
-
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 returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- The encryption type used. This value is one of the following:
-
KMS
-
NONE
-
- See Also:
-
-
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
- Returns:
- 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
-
-
-
openShardCount
The number of open shards in the stream.
- Returns:
- The number of open shards in the stream.
-
consumerCount
The number of enhanced fan-out consumers registered with the stream.
- Returns:
- The number of enhanced fan-out consumers registered with the stream.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StreamDescriptionSummary.Builder,
StreamDescriptionSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-