software.amazon.awssdk.services.ivsrealtime.model

Interface ParticipantToken.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ParticipantToken.Builder,ParticipantToken>, SdkBuilder<ParticipantToken.Builder,ParticipantToken>, SdkPojo

Enclosing class:

ParticipantToken

public static interface ParticipantToken.Builder
extends SdkPojo, CopyableBuilder<ParticipantToken.Builder,ParticipantToken>

Method Summary

Modifier and Type	Method and Description
ParticipantToken.Builder	attributes(Map<String,String> attributes) Application-provided attributes to encode into the token and attach to a stage.
ParticipantToken.Builder	capabilities(Collection<ParticipantTokenCapability> capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantToken.Builder	capabilities(ParticipantTokenCapability... capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantToken.Builder	capabilitiesWithStrings(Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantToken.Builder	capabilitiesWithStrings(String... capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantToken.Builder	duration(Integer duration) Duration (in minutes), after which the participant token expires.
ParticipantToken.Builder	expirationTime(Instant expirationTime) ISO 8601 timestamp (returned as a string) for when this token expires.
ParticipantToken.Builder	participantId(String participantId) Unique identifier for this participant token, assigned by IVS.
ParticipantToken.Builder	token(String token) The issued client token, encrypted.
ParticipantToken.Builder	userId(String userId) 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.

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

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

Application-provided attributes to encode into the token and attach to a stage. 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. 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

ParticipantToken.Builder capabilitiesWithStrings(Collection<String> capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

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

capabilitiesWithStrings

ParticipantToken.Builder capabilitiesWithStrings(String... capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

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

capabilities

ParticipantToken.Builder capabilities(Collection<ParticipantTokenCapability> capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

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

capabilities

ParticipantToken.Builder capabilities(ParticipantTokenCapability... capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

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

duration

ParticipantToken.Builder duration(Integer duration)

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

Parameters:

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

Returns:

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

expirationTime

ParticipantToken.Builder expirationTime(Instant expirationTime)

ISO 8601 timestamp (returned as a string) for when this token expires.

Parameters:

expirationTime - ISO 8601 timestamp (returned as a string) for when this token expires.

Returns:

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

participantId

ParticipantToken.Builder participantId(String participantId)

Unique identifier for this participant token, assigned by IVS.

Parameters:

participantId - Unique identifier for this participant token, assigned by IVS.

Returns:

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

token

ParticipantToken.Builder token(String token)

The issued client token, encrypted.

Parameters:

token - The issued client token, encrypted.

Returns:

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

userId

ParticipantToken.Builder userId(String userId)

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. 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 - 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. 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.