com.amazonaws.services.ivsrealtime.model

Class ListParticipantsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ivsrealtime.model.ListParticipantsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListParticipantsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListParticipantsRequest()

Method Summary

Modifier and Type	Method and Description
ListParticipantsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getFilterByPublished() Filters the response list to only show participants who published during the stage session.
String	getFilterByRecordingState() Filters the response list to only show participants with the specified recording state.
String	getFilterByState() Filters the response list to only show participants in the specified state.
String	getFilterByUserId() Filters the response list to match the specified user ID.
Integer	getMaxResults() Maximum number of results to return.
String	getNextToken() The first participant to retrieve.
String	getSessionId() ID of the session within the stage.
String	getStageArn() Stage ARN.
int	hashCode()
Boolean	isFilterByPublished() Filters the response list to only show participants who published during the stage session.
void	setFilterByPublished(Boolean filterByPublished) Filters the response list to only show participants who published during the stage session.
void	setFilterByRecordingState(String filterByRecordingState) Filters the response list to only show participants with the specified recording state.
void	setFilterByState(String filterByState) Filters the response list to only show participants in the specified state.
void	setFilterByUserId(String filterByUserId) Filters the response list to match the specified user ID.
void	setMaxResults(Integer maxResults) Maximum number of results to return.
void	setNextToken(String nextToken) The first participant to retrieve.
void	setSessionId(String sessionId) ID of the session within the stage.
void	setStageArn(String stageArn) Stage ARN.
String	toString() Returns a string representation of this object.
ListParticipantsRequest	withFilterByPublished(Boolean filterByPublished) Filters the response list to only show participants who published during the stage session.
ListParticipantsRequest	withFilterByRecordingState(ParticipantRecordingFilterByRecordingState filterByRecordingState) Filters the response list to only show participants with the specified recording state.
ListParticipantsRequest	withFilterByRecordingState(String filterByRecordingState) Filters the response list to only show participants with the specified recording state.
ListParticipantsRequest	withFilterByState(ParticipantState filterByState) Filters the response list to only show participants in the specified state.
ListParticipantsRequest	withFilterByState(String filterByState) Filters the response list to only show participants in the specified state.
ListParticipantsRequest	withFilterByUserId(String filterByUserId) Filters the response list to match the specified user ID.
ListParticipantsRequest	withMaxResults(Integer maxResults) Maximum number of results to return.
ListParticipantsRequest	withNextToken(String nextToken) The first participant to retrieve.
ListParticipantsRequest	withSessionId(String sessionId) ID of the session within the stage.
ListParticipantsRequest	withStageArn(String stageArn) Stage ARN.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListParticipantsRequest

public ListParticipantsRequest()

Method Detail

setStageArn

public void setStageArn(String stageArn)

Stage ARN.

Parameters:

stageArn - Stage ARN.

getStageArn

public String getStageArn()

Stage ARN.

Returns:

Stage ARN.

withStageArn

public ListParticipantsRequest withStageArn(String stageArn)

Stage ARN.

Parameters:

stageArn - Stage ARN.

Returns:

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

setSessionId

public void setSessionId(String sessionId)

ID of the session within the stage.

Parameters:

sessionId - ID of the session within the stage.

getSessionId

public String getSessionId()

ID of the session within the stage.

Returns:

ID of the session within the stage.

withSessionId

public ListParticipantsRequest withSessionId(String sessionId)

ID of the session within the stage.

Parameters:

sessionId - ID of the session within the stage.

Returns:

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

setFilterByUserId

public void setFilterByUserId(String filterByUserId)

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Parameters:

filterByUserId - Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

getFilterByUserId

public String getFilterByUserId()

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Returns:

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

withFilterByUserId

public ListParticipantsRequest withFilterByUserId(String filterByUserId)

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Parameters:

filterByUserId - Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Returns:

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

setFilterByPublished

public void setFilterByPublished(Boolean filterByPublished)

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByPublished - Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

getFilterByPublished

public Boolean getFilterByPublished()

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

withFilterByPublished

public ListParticipantsRequest withFilterByPublished(Boolean filterByPublished)

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByPublished - Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

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

isFilterByPublished

public Boolean isFilterByPublished()

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

setFilterByState

public void setFilterByState(String filterByState)

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByState - Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

See Also:

ParticipantState

getFilterByState

public String getFilterByState()

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

See Also:

ParticipantState

withFilterByState

public ListParticipantsRequest withFilterByState(String filterByState)

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByState - Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

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

See Also:

ParticipantState

withFilterByState

public ListParticipantsRequest withFilterByState(ParticipantState filterByState)

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByState - Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

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

See Also:

ParticipantState

setNextToken

public void setNextToken(String nextToken)

The first participant to retrieve. This is used for pagination; see the nextToken response field.

Parameters:

nextToken - The first participant to retrieve. This is used for pagination; see the nextToken response field.

getNextToken

public String getNextToken()

The first participant to retrieve. This is used for pagination; see the nextToken response field.

Returns:

The first participant to retrieve. This is used for pagination; see the nextToken response field.

withNextToken

public ListParticipantsRequest withNextToken(String nextToken)

The first participant to retrieve. This is used for pagination; see the nextToken response field.

Parameters:

nextToken - The first participant to retrieve. This is used for pagination; see the nextToken response field.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Maximum number of results to return. Default: 50.

Parameters:

maxResults - Maximum number of results to return. Default: 50.

getMaxResults

public Integer getMaxResults()

Maximum number of results to return. Default: 50.

Returns:

Maximum number of results to return. Default: 50.

withMaxResults

public ListParticipantsRequest withMaxResults(Integer maxResults)

Maximum number of results to return. Default: 50.

Parameters:

maxResults - Maximum number of results to return. Default: 50.

Returns:

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

setFilterByRecordingState

public void setFilterByRecordingState(String filterByRecordingState)

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByRecordingState - Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

See Also:

ParticipantRecordingFilterByRecordingState

getFilterByRecordingState

public String getFilterByRecordingState()

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

See Also:

ParticipantRecordingFilterByRecordingState

withFilterByRecordingState

public ListParticipantsRequest withFilterByRecordingState(String filterByRecordingState)

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByRecordingState - Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

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

See Also:

ParticipantRecordingFilterByRecordingState

withFilterByRecordingState

public ListParticipantsRequest withFilterByRecordingState(ParticipantRecordingFilterByRecordingState filterByRecordingState)

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Parameters:

filterByRecordingState - Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Returns:

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

See Also:

ParticipantRecordingFilterByRecordingState

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListParticipantsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()