com.amazonaws.services.kinesis.model

Class DescribeStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.DescribeStreamRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeStreamRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Describes the specified Kinesis data stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeStreamRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeStreamRequest

public DescribeStreamRequest()

Method Detail

getStreamName

public java.lang.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(java.lang.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(java.lang.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 java.lang.Integer getLimit()

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

setLimit

public void setLimit(java.lang.Integer limit)

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Constraints:
Range: 1 - 10000

Parameters:

limit -

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

withLimit

public DescribeStreamRequest withLimit(java.lang.Integer limit)

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

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 in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Returns:

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

getExclusiveStartShardId

public java.lang.String getExclusiveStartShardId()

The shard ID of the shard to start with.

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

Returns:

The shard ID of the shard to start with.

setExclusiveStartShardId

public void setExclusiveStartShardId(java.lang.String exclusiveStartShardId)

The shard ID of the shard to start with.

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

Parameters:

exclusiveStartShardId -

The shard ID of the shard to start with.

withExclusiveStartShardId

public DescribeStreamRequest withExclusiveStartShardId(java.lang.String exclusiveStartShardId)

The shard ID of the shard to start with.

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.

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object