StreamDescription (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Represents the output for DescribeStream.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamDescription()

Constructors
Constructor and Description
`StreamDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEncryptionType()` The server-side encryption type used on the stream.
`List<EnhancedMetrics>`	`getEnhancedMonitoring()` Represents the current enhanced monitoring settings of the stream.
`Boolean`	`getHasMoreShards()` If set to `true`, more shards in the stream are available to describe.
`String`	`getKeyId()` The GUID for the customer-managed KMS key used for encryption on the stream.
`Integer`	`getRetentionPeriodHours()` The current retention period, in hours.
`List<Shard>`	`getShards()` The shards that comprise the stream.
`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()`
`Boolean`	`isHasMoreShards()` If set to `true`, more shards in the stream are available to describe.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEncryptionType(EncryptionType encryptionType)` The server-side encryption type used on the stream.
`void`	`setEncryptionType(String encryptionType)` The server-side encryption type used on the stream.
`void`	`setEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`void`	`setHasMoreShards(Boolean hasMoreShards)` If set to `true`, more shards in the stream are available to describe.
`void`	`setKeyId(String keyId)` The GUID for the customer-managed KMS key used for encryption on the stream.
`void`	`setRetentionPeriodHours(Integer retentionPeriodHours)` The current retention period, in hours.
`void`	`setShards(Collection<Shard> shards)` The shards that comprise the stream.
`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(StreamStatus streamStatus)` The current status 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; useful for testing and debugging.
`StreamDescription`	`withEncryptionType(EncryptionType encryptionType)` The server-side encryption type used on the stream.
`StreamDescription`	`withEncryptionType(String encryptionType)` The server-side encryption type used on the stream.
`StreamDescription`	`withEnhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`StreamDescription`	`withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)` Represents the current enhanced monitoring settings of the stream.
`StreamDescription`	`withHasMoreShards(Boolean hasMoreShards)` If set to `true`, more shards in the stream are available to describe.
`StreamDescription`	`withKeyId(String keyId)` The GUID for the customer-managed KMS key used for encryption on the stream.
`StreamDescription`	`withRetentionPeriodHours(Integer retentionPeriodHours)` The current retention period, in hours.
`StreamDescription`	`withShards(Collection<Shard> shards)` The shards that comprise the stream.
`StreamDescription`	`withShards(Shard... shards)` The shards that comprise the stream.
`StreamDescription`	`withStreamARN(String streamARN)` The Amazon Resource Name (ARN) for the stream being described.
`StreamDescription`	`withStreamCreationTimestamp(Date streamCreationTimestamp)` The approximate time that the stream was created.
`StreamDescription`	`withStreamName(String streamName)` The name of the stream being described.
`StreamDescription`	`withStreamStatus(StreamStatus streamStatus)` The current status of the stream being described.
`StreamDescription`	`withStreamStatus(String streamStatus)` The current status of the stream being described.

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

- Constructor Detail
  - StreamDescription
```
public StreamDescription()
```
- 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 StreamDescription 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 StreamDescription 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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 StreamDescription 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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
  - setStreamStatus
```
public void setStreamStatus(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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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 StreamDescription 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis 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
  - getShards
```
public List<Shard> getShards()
```
    The shards that comprise the stream.
    
    Returns:
    
    The shards that comprise the stream.
  - setShards
```
public void setShards(Collection<Shard> shards)
```
    The shards that comprise the stream.
    
    Parameters:
    
    shards - The shards that comprise the stream.
  - withShards
```
public StreamDescription withShards(Shard... shards)
```
    The shards that comprise the stream.
    
    NOTE: This method appends the values to the existing list (if any). Use setShards(java.util.Collection) or withShards(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    shards - The shards that comprise the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withShards
```
public StreamDescription withShards(Collection<Shard> shards)
```
    The shards that comprise the stream.
    
    Parameters:
    
    shards - The shards that comprise the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHasMoreShards
```
public void setHasMoreShards(Boolean hasMoreShards)
```
    If set to true, more shards in the stream are available to describe.
    
    Parameters:
    
    hasMoreShards - If set to true, more shards in the stream are available to describe.
  - getHasMoreShards
```
public Boolean getHasMoreShards()
```
    If set to true, more shards in the stream are available to describe.
    
    Returns:
    
    If set to true, more shards in the stream are available to describe.
  - withHasMoreShards
```
public StreamDescription withHasMoreShards(Boolean hasMoreShards)
```
    If set to true, more shards in the stream are available to describe.
    
    Parameters:
    
    hasMoreShards - If set to true, more shards in the stream are available to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHasMoreShards
```
public Boolean isHasMoreShards()
```
    If set to true, more shards in the stream are available to describe.
    
    Returns:
    
    If set to true, more shards in the stream are available to describe.
  - 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 StreamDescription 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 StreamDescription 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 StreamDescription 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 StreamDescription 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 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.
    Parameters:
    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.
    See Also:
    
    EncryptionType
  - getEncryptionType
```
public String getEncryptionType()
```
    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.
    Returns:
    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.
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public StreamDescription withEncryptionType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - setEncryptionType
```
public void setEncryptionType(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.
    Parameters:
    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.
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public StreamDescription withEncryptionType(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.
    Parameters:
    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.
    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 KMS key used for encryption on the stream.
    
    Parameters:
    
    keyId - The GUID for the customer-managed KMS key used for encryption on the stream.
  - getKeyId
```
public String getKeyId()
```
    The GUID for the customer-managed KMS key used for encryption on the stream.
    
    Returns:
    
    The GUID for the customer-managed KMS key used for encryption on the stream.
  - withKeyId
```
public StreamDescription withKeyId(String keyId)
```
    The GUID for the customer-managed KMS key used for encryption on the stream.
    
    Parameters:
    
    keyId - The GUID for the customer-managed KMS key used for encryption on 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; useful for testing and debugging.
    
    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 StreamDescription clone()
```
    Overrides:
    
    clone in class Object
  - 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.

Did this page help you?

Class StreamDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamDescription

Method Detail

setStreamName

getStreamName

withStreamName

setStreamARN

getStreamARN

withStreamARN

setStreamStatus

getStreamStatus

withStreamStatus

setStreamStatus

withStreamStatus

getShards

setShards

withShards

withShards

setHasMoreShards

getHasMoreShards

withHasMoreShards

isHasMoreShards

setRetentionPeriodHours

getRetentionPeriodHours

withRetentionPeriodHours

setStreamCreationTimestamp

getStreamCreationTimestamp

withStreamCreationTimestamp

getEnhancedMonitoring

setEnhancedMonitoring

withEnhancedMonitoring

withEnhancedMonitoring

setEncryptionType

getEncryptionType

withEncryptionType

setEncryptionType

withEncryptionType

setKeyId

getKeyId

withKeyId

toString

equals

hashCode

clone

marshall