Interface ListParticipantEventsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListParticipantEventsRequest.Builder,
,ListParticipantEventsRequest> IvsRealTimeRequest.Builder
,SdkBuilder<ListParticipantEventsRequest.Builder,
,ListParticipantEventsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListParticipantEventsRequest
public static interface ListParticipantEventsRequest.Builder
extends IvsRealTimeRequest.Builder, SdkPojo, CopyableBuilder<ListParticipantEventsRequest.Builder,ListParticipantEventsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) Maximum number of results to return.The first participant event to retrieve.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.participantId
(String participantId) Unique identifier for this participant.ID of a session within the stage.Stage ARN.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The first participant event to retrieve. This is used for pagination; see the
nextToken
response field.- Parameters:
nextToken
- The first participant event to retrieve. This is used for pagination; see thenextToken
response field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
participantId
Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
- Parameters:
participantId
- Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionId
ID of a session within the stage.
- Parameters:
sessionId
- ID of a session within the stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stageArn
Stage ARN.
- Parameters:
stageArn
- Stage ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListParticipantEventsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListParticipantEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-