Class StreamDescription

java.lang.Object
com.amazonaws.services.kinesis.model.StreamDescription
All Implemented Interfaces:
Serializable, Cloneable
public class StreamDescription extends Object implements Serializable, Cloneable

Represents the output for DescribeStream.

See Also:

  • Constructor Details

    • StreamDescription

      public StreamDescription()

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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.

    • 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.

    • 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:

    • 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