com.amazonaws.services.kinesisvideo.model

Class ListStreamsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.ListStreamsRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ListStreamsRequest
extends AmazonWebServiceRequest
implements Serializable

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListStreamsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of streams to return in the response.
String	getNextToken() If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response.
StreamNameCondition	getStreamNameCondition() Optional: Returns only streams that satisfy a specific condition.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of streams to return in the response.
void	setNextToken(String nextToken) If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response.
void	setStreamNameCondition(StreamNameCondition streamNameCondition) Optional: Returns only streams that satisfy a specific condition.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListStreamsRequest	withMaxResults(Integer maxResults) The maximum number of streams to return in the response.
ListStreamsRequest	withNextToken(String nextToken) If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response.
ListStreamsRequest	withStreamNameCondition(StreamNameCondition streamNameCondition) Optional: Returns only streams that satisfy a specific condition.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListStreamsRequest

public ListStreamsRequest()

Method Detail

getMaxResults

public Integer getMaxResults()

The maximum number of streams to return in the response. The default is 10,000.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of streams to return in the response. The default is 10,000.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of streams to return in the response. The default is 10,000.

Constraints:
Range: 1 - 10000

Parameters:

maxResults -

The maximum number of streams to return in the response. The default is 10,000.

withMaxResults

public ListStreamsRequest withMaxResults(Integer maxResults)

The maximum number of streams to return in the response. The default is 10,000.

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

Constraints:
Range: 1 - 10000

Parameters:

maxResults -

The maximum number of streams to return in the response. The default is 10,000.

Returns:

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

getNextToken

public String getNextToken()

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

Returns:

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

setNextToken

public void setNextToken(String nextToken)

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

Parameters:

nextToken -

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

withNextToken

public ListStreamsRequest withNextToken(String nextToken)

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

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

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

Parameters:

nextToken -

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

Returns:

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

getStreamNameCondition

public StreamNameCondition getStreamNameCondition()

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Returns:

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

setStreamNameCondition

public void setStreamNameCondition(StreamNameCondition streamNameCondition)

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Parameters:

streamNameCondition -

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

withStreamNameCondition

public ListStreamsRequest withStreamNameCondition(StreamNameCondition streamNameCondition)

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

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

Parameters:

streamNameCondition -

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

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