com.amazonaws.services.kinesis.model

Class ListStreamsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.ListStreamsRequest

All Implemented Interfaces:

Serializable

public class ListStreamsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListStreams operation.

This operation returns an array of the names of all the streams that are associated with the AWS account making the ListStreams request. A given AWS account can have many streams active at one time.

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.

See Also:

AmazonKinesis.listStreams(ListStreamsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListStreamsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

ListStreamsRequest

public ListStreamsRequest()

Method Detail

getLimit

public Integer getLimit()

The maximum number of streams to list.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of streams to list.

setLimit

public void setLimit(Integer limit)

The maximum number of streams to list.

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of streams to list.

withLimit

public ListStreamsRequest withLimit(Integer limit)

The maximum number of streams to list.

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

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of streams to list.

Returns:

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

getExclusiveStartStreamName

public String getExclusiveStartStreamName()

The name of the stream to start the list with.

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

Returns:

The name of the stream to start the list with.

setExclusiveStartStreamName

public void setExclusiveStartStreamName(String exclusiveStartStreamName)

The name of the stream to start the list with.

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

Parameters:

exclusiveStartStreamName - The name of the stream to start the list with.

withExclusiveStartStreamName

public ListStreamsRequest withExclusiveStartStreamName(String exclusiveStartStreamName)

The name of the stream to start the list 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:

exclusiveStartStreamName - The name of the stream to start the list with.

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