com.amazonaws.services.kinesisvideo.model

Class ListSignalingChannelsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.ListSignalingChannelsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListSignalingChannelsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListSignalingChannelsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ChannelNameCondition	getChannelNameCondition() Optional: Returns only the channels that satisfy a specific condition.
java.lang.Integer	getMaxResults() The maximum number of channels to return in the response.
java.lang.String	getNextToken() If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response.
int	hashCode()
void	setChannelNameCondition(ChannelNameCondition channelNameCondition) Optional: Returns only the channels that satisfy a specific condition.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of channels to return in the response.
void	setNextToken(java.lang.String nextToken) If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListSignalingChannelsRequest	withChannelNameCondition(ChannelNameCondition channelNameCondition) Optional: Returns only the channels that satisfy a specific condition.
ListSignalingChannelsRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of channels to return in the response.
ListSignalingChannelsRequest	withNextToken(java.lang.String nextToken) If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response.

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

ListSignalingChannelsRequest

public ListSignalingChannelsRequest()

Method Detail

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of channels to return in the response. The default is 500.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of channels to return in the response. The default is 500.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of channels to return in the response. The default is 500.

Constraints:
Range: 1 - 10000

Parameters:

maxResults -

The maximum number of channels to return in the response. The default is 500.

withMaxResults

public ListSignalingChannelsRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of channels to return in the response. The default is 500.

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

Constraints:
Range: 1 - 10000

Parameters:

maxResults -

The maximum number of channels to return in the response. The default is 500.

Returns:

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

getNextToken

public java.lang.String getNextToken()

If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, 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 ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

setNextToken

public void setNextToken(java.lang.String nextToken)

If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, 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 ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

withNextToken

public ListSignalingChannelsRequest withNextToken(java.lang.String nextToken)

If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, 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 ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

Returns:

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

getChannelNameCondition

public ChannelNameCondition getChannelNameCondition()

Optional: Returns only the channels that satisfy a specific condition.

Returns:

Optional: Returns only the channels that satisfy a specific condition.

setChannelNameCondition

public void setChannelNameCondition(ChannelNameCondition channelNameCondition)

Optional: Returns only the channels that satisfy a specific condition.

Parameters:

channelNameCondition -

Optional: Returns only the channels that satisfy a specific condition.

withChannelNameCondition

public ListSignalingChannelsRequest withChannelNameCondition(ChannelNameCondition channelNameCondition)

Optional: Returns only the channels that satisfy a specific condition.

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

Parameters:

channelNameCondition -

Optional: Returns only the channels that satisfy a specific condition.

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