public class ListStreamsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ListStreams operation
.
Lists your streams.
The number of streams may be too large to return from a single call
to ListStreams
. You can limit the number of returned
streams using the Limit
parameter. If you do not specify
a value for the Limit
parameter, Amazon Kinesis uses the
default limit, which is currently 10.
You can detect if there are more streams available to list by using
the HasMoreStreams
flag from the returned output. If
there are more streams available, you can request more streams by
using the name of the last stream returned by the
ListStreams
request in the
ExclusiveStartStreamName
parameter in a subsequent
request to ListStreams
. The group of stream names
returned by the subsequent request is then added to the list. You can
continue this process until all the stream names have been collected
in the list.
ListStreams has a limit of 5 transactions per second per account.
NOOP
Constructor and Description |
---|
ListStreamsRequest() |
Modifier and Type | Method and Description |
---|---|
ListStreamsRequest |
clone() |
boolean |
equals(Object obj) |
String |
getExclusiveStartStreamName()
The name of the stream to start the list with.
|
Integer |
getLimit()
The maximum number of streams to list.
|
int |
hashCode() |
void |
setExclusiveStartStreamName(String exclusiveStartStreamName)
The name of the stream to start the list with.
|
void |
setLimit(Integer limit)
The maximum number of streams to list.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListStreamsRequest |
withExclusiveStartStreamName(String exclusiveStartStreamName)
The name of the stream to start the list with.
|
ListStreamsRequest |
withLimit(Integer limit)
The maximum number of streams to list.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public Integer getLimit()
Constraints:
Range: 1 - 10000
public void setLimit(Integer limit)
Constraints:
Range: 1 - 10000
limit
- The maximum number of streams to list.public ListStreamsRequest withLimit(Integer limit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 10000
limit
- The maximum number of streams to list.public String getExclusiveStartStreamName()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setExclusiveStartStreamName(String exclusiveStartStreamName)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
exclusiveStartStreamName
- The name of the stream to start the list with.public ListStreamsRequest withExclusiveStartStreamName(String exclusiveStartStreamName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
exclusiveStartStreamName
- The name of the stream to start the list with.public String toString()
toString
in class Object
Object.toString()
public ListStreamsRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.