software.amazon.awssdk.services.ivsrealtime.model

Interface ListParticipantsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>, IvsRealTimeRequest.Builder, SdkBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListParticipantsRequest

public static interface ListParticipantsRequest.Builder
extends IvsRealTimeRequest.Builder, SdkPojo, CopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>

Method Summary

Modifier and Type	Method and Description
ListParticipantsRequest.Builder	filterByPublished(Boolean filterByPublished) Filters the response list to only show participants who published during the stage session.
ListParticipantsRequest.Builder	filterByState(ParticipantState filterByState) Filters the response list to only show participants in the specified state.
ListParticipantsRequest.Builder	filterByState(String filterByState) Filters the response list to only show participants in the specified state.
ListParticipantsRequest.Builder	filterByUserId(String filterByUserId) Filters the response list to match the specified user ID.
ListParticipantsRequest.Builder	maxResults(Integer maxResults) Maximum number of results to return.
ListParticipantsRequest.Builder	nextToken(String nextToken) The first participant to retrieve.
ListParticipantsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListParticipantsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListParticipantsRequest.Builder	sessionId(String sessionId) ID of the session within the stage.
ListParticipantsRequest.Builder	stageArn(String stageArn) Stage ARN.

Methods inherited from interface software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filterByPublished

ListParticipantsRequest.Builder filterByPublished(Boolean filterByPublished)

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState 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, or filterByState can be provided per request.

Returns:

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

filterByState

ListParticipantsRequest.Builder filterByState(String filterByState)

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

Parameters:

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

Returns:

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

See Also:

ParticipantState, ParticipantState

filterByState

ListParticipantsRequest.Builder filterByState(ParticipantState filterByState)

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

Parameters:

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

Returns:

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

See Also:

ParticipantState, ParticipantState

filterByUserId

ListParticipantsRequest.Builder filterByUserId(String filterByUserId)

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState 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, or filterByState 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.

maxResults

ListParticipantsRequest.Builder maxResults(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.

nextToken

ListParticipantsRequest.Builder nextToken(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.

sessionId

ListParticipantsRequest.Builder sessionId(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.

stageArn

ListParticipantsRequest.Builder stageArn(String stageArn)

Stage ARN.

Parameters:

stageArn - Stage ARN.

Returns:

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

overrideConfiguration

ListParticipantsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListParticipantsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder