StreamDescription (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class StreamDescription
extends Object
implements Serializable
```
Represents the output of a DescribeStream operation.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamDescription()

Constructors
Constructor and Description
`StreamDescription()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getHasMoreShards()` If set to `true` there are more shards in the stream available to describe.
`List<Shard>`	`getShards()` The shards that comprise the stream.
`String`	`getStreamARN()` The Amazon Resource Name (ARN) for the stream being described.
`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` there are more shards in the stream available to describe.
`void`	`setHasMoreShards(Boolean hasMoreShards)` If set to `true` there are more shards in the stream available to describe.
`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`	`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`	`withHasMoreShards(Boolean hasMoreShards)` If set to `true` there are more shards in the stream available to describe.
`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`	`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
  - getStreamName
```
public String getStreamName()
```
    The name of the stream being described.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The name of the stream being described.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream being described.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream being described.
  - withStreamName
```
public StreamDescription withStreamName(String streamName)
```
    The name of the stream being described.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream being described.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withStreamARN
```
public StreamDescription withStreamARN(String streamARN)
```
    The Amazon Resource Name (ARN) for the stream being described.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    streamARN - The Amazon Resource Name (ARN) for the stream being described.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. After a DeleteStream request, 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.
    Constraints:
    Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    Returns:
    The current status of the stream being described.
    The stream status is one of the following states:
    
    CREATING - The stream is being created. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. After a DeleteStream request, 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
  - 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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. After a DeleteStream request, 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.
    Constraints:
    Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. After a DeleteStream request, 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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. After a DeleteStream request, 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. After a DeleteStream request, 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:
    A reference to this updated 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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. After a DeleteStream request, 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.
    Constraints:
    Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. After a DeleteStream request, 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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    - DELETING - The stream is being deleted. After a DeleteStream request, 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
    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. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
    
    DELETING - The stream is being deleted. After a DeleteStream request, 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:
    A reference to this updated 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    shards - The shards that comprise the stream.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withShards
```
public StreamDescription withShards(Collection<Shard> shards)
```
    The shards that comprise the stream.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    shards - The shards that comprise the stream.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isHasMoreShards
```
public Boolean isHasMoreShards()
```
    If set to true there are more shards in the stream available to describe.
    
    Returns:
    If set to true there are more shards in the stream available to describe.
  - setHasMoreShards
```
public void setHasMoreShards(Boolean hasMoreShards)
```
    If set to true there are more shards in the stream available to describe.
    
    Parameters:
    hasMoreShards - If set to true there are more shards in the stream available to describe.
  - withHasMoreShards
```
public StreamDescription withHasMoreShards(Boolean hasMoreShards)
```
    If set to true there are more shards in the stream available to describe.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    hasMoreShards - If set to true there are more shards in the stream available to describe.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getHasMoreShards
```
public Boolean getHasMoreShards()
```
    If set to true there are more shards in the stream available to describe.
    
    Returns:
    If set to true there are more shards in the stream available to describe.
  - 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class StreamDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamDescription

Method Detail

getStreamName

setStreamName

withStreamName

getStreamARN

setStreamARN

withStreamARN

getStreamStatus

setStreamStatus

withStreamStatus

setStreamStatus

withStreamStatus

getShards

setShards

withShards

withShards

isHasMoreShards

setHasMoreShards

withHasMoreShards

getHasMoreShards

toString

hashCode

equals