com.amazonaws.services.kinesis.model

Class DescribeStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.DescribeStreamRequest

All Implemented Interfaces:

Serializable

public class DescribeStreamRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeStream operation.

This operation returns the following information about the stream: the current status of the stream, the stream Amazon Resource Name (ARN), and an array of shard objects that comprise the stream. For each shard object there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in a MergeShards or SplitShard operation that created the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned by the Amazon Kinesis service when a record is put into the stream.

You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream . You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.

If there are more shards available, you can request more shards by using the shard ID of the last shard returned by the DescribeStream request, in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream . DescribeStream is a paginated operation.

DescribeStream has a limit of 10 transactions per second per account.

See Also:

AmazonKinesis.describeStream(DescribeStreamRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeStreamRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getExclusiveStartShardId() The shard ID of the shard to start with for the stream description.
Integer	getLimit() The maximum number of shards to return.
String	getStreamName() The name of the stream to describe.
int	hashCode()
void	setExclusiveStartShardId(String exclusiveStartShardId) The shard ID of the shard to start with for the stream description.
void	setLimit(Integer limit) The maximum number of shards to return.
void	setStreamName(String streamName) The name of the stream to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeStreamRequest	withExclusiveStartShardId(String exclusiveStartShardId) The shard ID of the shard to start with for the stream description.
DescribeStreamRequest	withLimit(Integer limit) The maximum number of shards to return.
DescribeStreamRequest	withStreamName(String streamName) The name of the stream to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeStreamRequest

public DescribeStreamRequest()

Method Detail

getStreamName

public String getStreamName()

The name of the stream to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream to describe.

setStreamName

public void setStreamName(String streamName)

The name of the stream to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName - The name of the stream to describe.

withStreamName

public DescribeStreamRequest withStreamName(String streamName)

The name of the stream to describe.

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 to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of shards to return.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of shards to return.

setLimit

public void setLimit(Integer limit)

The maximum number of shards to return.

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of shards to return.

withLimit

public DescribeStreamRequest withLimit(Integer limit)

The maximum number of shards to return.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of shards to return.

Returns:

A reference to this updated object so that method calls can be chained together.

getExclusiveStartShardId

public String getExclusiveStartShardId()

The shard ID of the shard to start with for the stream description.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:

The shard ID of the shard to start with for the stream description.

setExclusiveStartShardId

public void setExclusiveStartShardId(String exclusiveStartShardId)

The shard ID of the shard to start with for the stream description.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

exclusiveStartShardId - The shard ID of the shard to start with for the stream description.

withExclusiveStartShardId

public DescribeStreamRequest withExclusiveStartShardId(String exclusiveStartShardId)

The shard ID of the shard to start with for the stream description.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

exclusiveStartShardId - The shard ID of the shard to start with for the stream description.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object