Interface DisconnectParticipantRequest.Builder

All Superinterfaces:

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

Enclosing class:

DisconnectParticipantRequest

@Mutable
@NotThreadSafe
public static interface DisconnectParticipantRequest.Builder
extends IvsRealTimeRequest.Builder, SdkPojo, CopyableBuilder<DisconnectParticipantRequest.Builder,DisconnectParticipantRequest>

Method Summary

Modifier and Type	Method	Description
DisconnectParticipantRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DisconnectParticipantRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DisconnectParticipantRequest.Builder	participantId(String participantId)	Identifier of the participant to be disconnected.
DisconnectParticipantRequest.Builder	reason(String reason)	Description of why this participant is being disconnected.
DisconnectParticipantRequest.Builder	stageArn(String stageArn)	ARN of the stage to which the participant is attached.

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, sdkFieldNameToField, sdkFields

Method Details

stageArn

DisconnectParticipantRequest.Builder stageArn(String stageArn)

ARN of the stage to which the participant is attached.

Parameters:

stageArn - ARN of the stage to which the participant is attached.

Returns:

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

participantId

DisconnectParticipantRequest.Builder participantId(String participantId)

Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).

Parameters:

participantId - Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).

Returns:

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

reason

DisconnectParticipantRequest.Builder reason(String reason)

Description of why this participant is being disconnected.

Parameters:

reason - Description of why this participant is being disconnected.

Returns:

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

overrideConfiguration

DisconnectParticipantRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.