StreamDescriptionSummary (AWS Java SDK for Amazon Kinesis 1.11.498 API)

java.lang.Object
- com.amazonaws.services.kinesis.model.StreamDescriptionSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StreamDescriptionSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents the output for DescribeStreamSummary

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamDescriptionSummary()

Constructors
Constructor and Description
`StreamDescriptionSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamDescriptionSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getConsumerCount()` The number of enhanced fan-out consumers registered with the stream.
`String`	`getEncryptionType()` The encryption type used.
`List<EnhancedMetrics>`	`getEnhancedMonitoring()` Represents the current enhanced monitoring settings of the stream.
`String`	`getKeyId()` The GUID for the customer-managed AWS KMS key to use for encryption.
`Integer`	`getOpenShardCount()` The number of open shards in the stream.
`Integer`	`getRetentionPeriodHours()` The current retention period, in hours.
`String`	`getStreamARN()` The Amazon Resource Name (ARN) for the stream being described.
`Date`	`getStreamCreationTimestamp()` The approximate time that the stream was created.
`String`	`getStreamName()` The name of the stream being described.
`String`	`getStreamStatus()` The current status of the stream being described.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setConsumerCount(Integer consumerCount)` The number of enhanced fan-out consumers registered with the stream.
`void`	`setEncryptionType(String encryptionType)` The encryption type used.
`void`	`setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`void`	`setKeyId(String keyId)` The GUID for the customer-managed AWS KMS key to use for encryption.
`void`	`setOpenShardCount(Integer openShardCount)` The number of open shards in the stream.
`void`	`setRetentionPeriodHours(Integer retentionPeriodHours)` The current retention period, in hours.
`void`	`setStreamARN(String streamARN)` The Amazon Resource Name (ARN) for the stream being described.
`void`	`setStreamCreationTimestamp(Date streamCreationTimestamp)` The approximate time that the stream was created.
`void`	`setStreamName(String streamName)` The name of the stream being described.
`void`	`setStreamStatus(String streamStatus)` The current status of the stream being described.
`String`	`toString()` Returns a string representation of this object.
`StreamDescriptionSummary`	`withConsumerCount(Integer consumerCount)` The number of enhanced fan-out consumers registered with the stream.
`StreamDescriptionSummary`	`withEncryptionType(EncryptionType encryptionType)` The encryption type used.
`StreamDescriptionSummary`	`withEncryptionType(String encryptionType)` The encryption type used.
`StreamDescriptionSummary`	`withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`StreamDescriptionSummary`	`withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`StreamDescriptionSummary`	`withKeyId(String keyId)` The GUID for the customer-managed AWS KMS key to use for encryption.
`StreamDescriptionSummary`	`withOpenShardCount(Integer openShardCount)` The number of open shards in the stream.
`StreamDescriptionSummary`	`withRetentionPeriodHours(Integer retentionPeriodHours)` The current retention period, in hours.
`StreamDescriptionSummary`	`withStreamARN(String streamARN)` The Amazon Resource Name (ARN) for the stream being described.
`StreamDescriptionSummary`	`withStreamCreationTimestamp(Date streamCreationTimestamp)` The approximate time that the stream was created.
`StreamDescriptionSummary`	`withStreamName(String streamName)` The name of the stream being described.
`StreamDescriptionSummary`	`withStreamStatus(StreamStatus streamStatus)` The current status of the stream being described.
`StreamDescriptionSummary`	`withStreamStatus(String streamStatus)` The current status of the stream being described.

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

- Constructor Detail
  - StreamDescriptionSummary
```
public StreamDescriptionSummary()
```
- Method Detail
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream being described.
    
    Parameters:
    
    streamName - The name of the stream being described.
  - getStreamName
```
public String getStreamName()
```
    The name of the stream being described.
    
    Returns:
    
    The name of the stream being described.
  - withStreamName
```
public StreamDescriptionSummary withStreamName(String streamName)
```
    The name of the stream being described.
    
    Parameters:
    
    streamName - The name of the stream being described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamARN
```
public void setStreamARN(String streamARN)
```
    The Amazon Resource Name (ARN) for the stream being described.
    
    Parameters:
    
    streamARN - The Amazon Resource Name (ARN) for the stream being described.
  - getStreamARN
```
public String getStreamARN()
```
    The Amazon Resource Name (ARN) for the stream being described.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the stream being described.
  - withStreamARN
```
public StreamDescriptionSummary withStreamARN(String streamARN)
```
    The Amazon Resource Name (ARN) for the stream being described.
    
    Parameters:
    
    streamARN - The Amazon Resource Name (ARN) for the stream being described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamStatus
```
public void setStreamStatus(String 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.
    Parameters:
    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.
    See Also:
    
    StreamStatus
  - getStreamStatus
```
public String getStreamStatus()
```
    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.
    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 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.
    See Also:
    
    StreamStatus
  - withStreamStatus
```
public StreamDescriptionSummary withStreamStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamStatus
  - withStreamStatus
```
public StreamDescriptionSummary withStreamStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamStatus
  - setRetentionPeriodHours
```
public void setRetentionPeriodHours(Integer retentionPeriodHours)
```
    The current retention period, in hours.
    
    Parameters:
    
    retentionPeriodHours - The current retention period, in hours.
  - getRetentionPeriodHours
```
public Integer getRetentionPeriodHours()
```
    The current retention period, in hours.
    
    Returns:
    
    The current retention period, in hours.
  - withRetentionPeriodHours
```
public StreamDescriptionSummary withRetentionPeriodHours(Integer retentionPeriodHours)
```
    The current retention period, in hours.
    
    Parameters:
    
    retentionPeriodHours - The current retention period, in hours.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamCreationTimestamp
```
public void setStreamCreationTimestamp(Date streamCreationTimestamp)
```
    The approximate time that the stream was created.
    
    Parameters:
    
    streamCreationTimestamp - The approximate time that the stream was created.
  - getStreamCreationTimestamp
```
public Date getStreamCreationTimestamp()
```
    The approximate time that the stream was created.
    
    Returns:
    
    The approximate time that the stream was created.
  - withStreamCreationTimestamp
```
public StreamDescriptionSummary withStreamCreationTimestamp(Date streamCreationTimestamp)
```
    The approximate time that the stream was created.
    
    Parameters:
    
    streamCreationTimestamp - The approximate time that the stream was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnhancedMonitoring
```
public List<EnhancedMetrics> getEnhancedMonitoring()
```
    Represents the current enhanced monitoring settings of the stream.
    
    Returns:
    
    Represents the current enhanced monitoring settings of the stream.
  - setEnhancedMonitoring
```
public void setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
```
    Represents the current enhanced monitoring settings of the stream.
    
    Parameters:
    
    enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
  - withEnhancedMonitoring
```
public StreamDescriptionSummary withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
```
    Represents the current enhanced monitoring settings of the stream.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnhancedMonitoring(java.util.Collection) or withEnhancedMonitoring(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnhancedMonitoring
```
public StreamDescriptionSummary withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
```
    Represents the current enhanced monitoring settings of the stream.
    
    Parameters:
    
    enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncryptionType
```
public void setEncryptionType(String encryptionType)
```
    The encryption type used. This value is one of the following:
    - KMS
    - NONE
    Parameters:
    encryptionType - The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    See Also:
    
    EncryptionType
  - getEncryptionType
```
public String getEncryptionType()
```
    The encryption type used. This value is one of the following:
    - KMS
    - NONE
    Returns:
    The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public StreamDescriptionSummary withEncryptionType(String encryptionType)
```
    The encryption type used. This value is one of the following:
    - KMS
    - NONE
    Parameters:
    encryptionType - The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public StreamDescriptionSummary withEncryptionType(EncryptionType encryptionType)
```
    The encryption type used. This value is one of the following:
    - KMS
    - NONE
    Parameters:
    encryptionType - The encryption type used. This value is one of the following:
    
    KMS
    
    NONE
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - setKeyId
```
public void setKeyId(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
    Parameters:
    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
  - getKeyId
```
public String getKeyId()
```
    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
    Returns:
    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
  - withKeyId
```
public StreamDescriptionSummary withKeyId(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpenShardCount
```
public void setOpenShardCount(Integer openShardCount)
```
    The number of open shards in the stream.
    
    Parameters:
    
    openShardCount - The number of open shards in the stream.
  - getOpenShardCount
```
public Integer getOpenShardCount()
```
    The number of open shards in the stream.
    
    Returns:
    
    The number of open shards in the stream.
  - withOpenShardCount
```
public StreamDescriptionSummary withOpenShardCount(Integer openShardCount)
```
    The number of open shards in the stream.
    
    Parameters:
    
    openShardCount - The number of open shards in the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumerCount
```
public void setConsumerCount(Integer consumerCount)
```
    The number of enhanced fan-out consumers registered with the stream.
    
    Parameters:
    
    consumerCount - The number of enhanced fan-out consumers registered with the stream.
  - getConsumerCount
```
public Integer getConsumerCount()
```
    The number of enhanced fan-out consumers registered with the stream.
    
    Returns:
    
    The number of enhanced fan-out consumers registered with the stream.
  - withConsumerCount
```
public StreamDescriptionSummary withConsumerCount(Integer consumerCount)
```
    The number of enhanced fan-out consumers registered with the stream.
    
    Parameters:
    
    consumerCount - The number of enhanced fan-out consumers registered with the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StreamDescriptionSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class StreamDescriptionSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamDescriptionSummary

Method Detail

setStreamName

getStreamName

withStreamName

setStreamARN

getStreamARN

withStreamARN

setStreamStatus

getStreamStatus

withStreamStatus

withStreamStatus

setRetentionPeriodHours

getRetentionPeriodHours

withRetentionPeriodHours

setStreamCreationTimestamp

getStreamCreationTimestamp

withStreamCreationTimestamp

getEnhancedMonitoring

setEnhancedMonitoring

withEnhancedMonitoring

withEnhancedMonitoring

setEncryptionType

getEncryptionType

withEncryptionType

withEncryptionType

setKeyId

getKeyId

withKeyId

setOpenShardCount

getOpenShardCount

withOpenShardCount

setConsumerCount

getConsumerCount

withConsumerCount

toString

equals

hashCode

clone

marshall