Package software.amazon.awssdk.services.ivsrealtime.model

Class ParticipantSummary

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.ParticipantSummary

All Implemented Interfaces:

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

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

Summary object describing a participant that has joined a stage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParticipantSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ParticipantSummary.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)
int	hashCode()
String	participantId()	Unique identifier for this participant, assigned by IVS.
Boolean	published()	Whether the participant ever published to the stage session.
ParticipantRecordingState	recordingState()	The participant’s recording state.
String	recordingStateAsString()	The participant’s recording state.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ParticipantSummary.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.
ParticipantSummary.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

participantId

public final String participantId()

Unique identifier for this participant, assigned by IVS.

Returns:

Unique identifier for this participant, assigned by IVS.

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.

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

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.

published

public final Boolean published()

Whether the participant ever published to the stage session.

Returns:

Whether the participant ever published to the stage session.

recordingState

public final ParticipantRecordingState recordingState()

The participant’s recording state.

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

Returns:

The participant’s recording state.

See Also:

ParticipantRecordingState

recordingStateAsString

public final String recordingStateAsString()

The participant’s recording state.

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

Returns:

The participant’s recording state.

See Also:

ParticipantRecordingState

toBuilder

public ParticipantSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParticipantSummary.Builder,ParticipantSummary>

builder

public static ParticipantSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ParticipantSummary.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo