software.amazon.awssdk.services.ivsrealtime.model

Interface Participant.Builder

All Superinterfaces:

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

Enclosing class:

Participant

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

Method Summary

Modifier and Type	Method and Description
Participant.Builder	attributes(Map<String,String> attributes) Application-provided attributes to encode into the token and attach to a stage.
Participant.Builder	firstJoinTime(Instant firstJoinTime) ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Participant.Builder	participantId(String participantId) Unique identifier for this participant, assigned by IVS.
Participant.Builder	published(Boolean published) Whether the participant ever published to the stage session.
Participant.Builder	state(ParticipantState state) Whether the participant is connected to or disconnected from the stage.
Participant.Builder	state(String state) Whether the participant is connected to or disconnected from the stage.
Participant.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

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

firstJoinTime

Participant.Builder firstJoinTime(Instant firstJoinTime)

ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Parameters:

firstJoinTime - ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

Returns:

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

participantId

Participant.Builder participantId(String participantId)

Unique identifier for this participant, assigned by IVS.

Parameters:

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

Returns:

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

published

Participant.Builder published(Boolean published)

Whether the participant ever published to the stage session.

Parameters:

published - Whether the participant ever published to the stage session.

Returns:

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

state

Participant.Builder state(String state)

Whether the participant is connected to or disconnected from the stage.

Parameters:

state - Whether the participant is connected to or disconnected from the stage.

Returns:

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

See Also:

ParticipantState, ParticipantState

state

Participant.Builder state(ParticipantState state)

Whether the participant is connected to or disconnected from the stage.

Parameters:

state - Whether the participant is connected to or disconnected from the stage.

Returns:

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

See Also:

ParticipantState, ParticipantState

userId

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