public class DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable
Describes the specified Amazon Kinesis stream.
The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. 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 creating the shard. A sequence number is the identifier associated with every record ingested in the stream. The sequence number is assigned 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.
DescribeStream
is a paginated operation. If there are more
shards available, you can request them using the shard ID of the last shard
returned. Specify this ID in the ExclusiveStartShardId
parameter
in a subsequent request to DescribeStream
.
There are no guarantees about the chronological order shards returned in
DescribeStream
results. If you want to process shards in
chronological order, use ParentShardId
to track lineage to the
oldest shard.
DescribeStream has a limit of 10 transactions per second per account.
Constructor and Description |
---|
DescribeStreamRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getExclusiveStartShardId()
The shard ID of the shard to start with.
|
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.
|
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.
|
DescribeStreamRequest |
withLimit(Integer limit)
The maximum number of shards to return.
|
DescribeStreamRequest |
withStreamName(String streamName)
The name of the stream to describe.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStreamName()
The name of the stream to describe.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
The name of the stream to describe.
public void setStreamName(String streamName)
The name of the stream to describe.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream to describe.
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_.-]+
streamName
- The name of the stream to describe.
public Integer getLimit()
The maximum number of shards to return.
Constraints:
Range: 1 - 10000
The maximum number of shards to return.
public void setLimit(Integer limit)
The maximum number of shards to return.
Constraints:
Range: 1 - 10000
limit
- The maximum number of shards to return.
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
limit
- The maximum number of shards to return.
public String getExclusiveStartShardId()
The shard ID of the shard to start with.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
The shard ID of the shard to start with.
public void setExclusiveStartShardId(String exclusiveStartShardId)
The shard ID of the shard to start with.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
exclusiveStartShardId
- The shard ID of the shard to start with.
public DescribeStreamRequest withExclusiveStartShardId(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_.-]+
exclusiveStartShardId
- The shard ID of the shard to start with.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2017. All rights reserved.