software.amazon.awssdk.services.ivsrealtime.model

Interface CreateParticipantTokenRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateParticipantTokenRequest

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

Method Summary

Modifier and Type	Method and Description
CreateParticipantTokenRequest.Builder	attributes(Map<String,String> attributes) Application-provided attributes to encode into the token and attach to a stage.
CreateParticipantTokenRequest.Builder	capabilities(Collection<ParticipantTokenCapability> capabilities) Set of capabilities that the user is allowed to perform in the stage.
CreateParticipantTokenRequest.Builder	capabilities(ParticipantTokenCapability... capabilities) Set of capabilities that the user is allowed to perform in the stage.
CreateParticipantTokenRequest.Builder	capabilitiesWithStrings(Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the stage.
CreateParticipantTokenRequest.Builder	capabilitiesWithStrings(String... capabilities) Set of capabilities that the user is allowed to perform in the stage.
CreateParticipantTokenRequest.Builder	duration(Integer duration) Duration (in minutes), after which the token expires.
CreateParticipantTokenRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateParticipantTokenRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateParticipantTokenRequest.Builder	stageArn(String stageArn) ARN of the stage to which this token is scoped.
CreateParticipantTokenRequest.Builder	userId(String userId) Name that can be specified to help identify the token.

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

attributes

CreateParticipantTokenRequest.Builder attributes(Map<String,String> attributes)

Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Parameters:

attributes - Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

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

capabilitiesWithStrings

CreateParticipantTokenRequest.Builder capabilitiesWithStrings(Collection<String> capabilities)

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Returns:

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

capabilitiesWithStrings

CreateParticipantTokenRequest.Builder capabilitiesWithStrings(String... capabilities)

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Returns:

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

capabilities

CreateParticipantTokenRequest.Builder capabilities(Collection<ParticipantTokenCapability> capabilities)

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Returns:

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

capabilities

CreateParticipantTokenRequest.Builder capabilities(ParticipantTokenCapability... capabilities)

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Returns:

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

duration

CreateParticipantTokenRequest.Builder duration(Integer duration)

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

Parameters:

duration - Duration (in minutes), after which the token expires. Default: 720 (12 hours).

Returns:

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

stageArn

CreateParticipantTokenRequest.Builder stageArn(String stageArn)

ARN of the stage to which this token is scoped.

Parameters:

stageArn - ARN of the stage to which this token is scoped.

Returns:

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

userId

CreateParticipantTokenRequest.Builder userId(String userId)

Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Parameters:

userId - Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

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

overrideConfiguration

CreateParticipantTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder