StreamDescriptionSummary (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.kinesis.model.StreamDescriptionSummary

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>

@Generated(value="software.amazon.awssdk:codegen")
public class StreamDescriptionSummary
extends Object
implements StructuredPojo, ToCopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>

Represents the output for DescribeStreamSummary

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StreamDescriptionSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StreamDescriptionSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StreamDescriptionSummary.Builder`	`builder()`
`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 KMS key to use for encryption.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`Integer`	`openShardCount()` The number of open shards in the stream.
`Integer`	`retentionPeriodHours()` The current retention period, in hours.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - streamName
```
public String streamName()
```
    The name of the stream being described.
    
    Returns:
    
    The name of the stream being described.
  - streamARN
```
public String streamARN()
```
    The Amazon Resource Name (ARN) for the stream being described.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the stream being described.
  - streamStatus
```
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().
    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 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.
    See Also:
    
    StreamStatus
  - streamStatusAsString
```
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().
    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 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.
    See Also:
    
    StreamStatus
  - retentionPeriodHours
```
public Integer retentionPeriodHours()
```
    The current retention period, in hours.
    
    Returns:
    
    The current retention period, in hours.
  - streamCreationTimestamp
```
public Instant streamCreationTimestamp()
```
    The approximate time that the stream was created.
    
    Returns:
    
    The approximate time that the stream was created.
  - enhancedMonitoring
```
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.
    
    Returns:
    
    Represents the current enhanced monitoring settings of the stream.
  - encryptionType
```
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().
    Returns:
    The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    See Also:
    
    EncryptionType
  - encryptionTypeAsString
```
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().
    Returns:
    The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    See Also:
    
    EncryptionType
  - keyId
```
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: alias/aws/kinesis
    Returns:
    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: alias/aws/kinesis
  - openShardCount
```
public Integer openShardCount()
```
    The number of open shards in the stream.
    
    Returns:
    
    The number of open shards in the stream.
  - toBuilder
```
public StreamDescriptionSummary.Builder 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 interface ToCopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>
    
    Returns:
    
    a builder for type T
  - builder
```
public static StreamDescriptionSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StreamDescriptionSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class StreamDescriptionSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

streamName

streamARN

streamStatus

streamStatusAsString

retentionPeriodHours

streamCreationTimestamp

enhancedMonitoring

encryptionType

encryptionTypeAsString

keyId

openShardCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall