software.amazon.awssdk.services.ivsrealtime.model

Class Participant

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.Participant

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Participant.Builder,Participant>

@Generated(value="software.amazon.awssdk:codegen")
public final class Participant
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Participant.Builder,Participant>

Object describing a participant that has joined a stage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Participant.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributes() Application-provided attributes to encode into the token and attach to a stage.
static Participant.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	firstJoinTime() ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	participantId() Unique identifier for this participant, assigned by IVS.
Boolean	published() Whether the participant ever published to the stage session.
List<SdkField<?>>	sdkFields()
static Class<? extends Participant.Builder>	serializableBuilderClass()
ParticipantState	state() Whether the participant is connected to or disconnected from the stage.
String	stateAsString() Whether the participant is connected to or disconnected from the stage.
Participant.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributes

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

Returns:

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.

firstJoinTime

public final Instant firstJoinTime()

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

Returns:

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

participantId

public final String participantId()

Unique identifier for this participant, assigned by IVS.

Returns:

Unique identifier for this participant, assigned by IVS.

published

public final Boolean published()

Whether the participant ever published to the stage session.

Returns:

Whether the participant ever published to the stage session.

state

public final ParticipantState state()

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

If the service returns an enum value that is not available in the current SDK version, state will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

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

See Also:

ParticipantState

stateAsString

public final String stateAsString()

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

If the service returns an enum value that is not available in the current SDK version, state will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

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

See Also:

ParticipantState

userId

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

Returns:

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.

toBuilder

public Participant.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Participant.Builder,Participant>

builder

public static Participant.Builder builder()

serializableBuilderClass

public static Class<? extends Participant.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo