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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • replicationType

      public final ReplicationType replicationType()

      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

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

      Returns:
      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      See Also:

    • replicationTypeAsString

      public final String replicationTypeAsString()

      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

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

      Returns:
      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      See Also:

    • replicationState

      public final ReplicationState replicationState()

      The participant's replication state.

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

      Returns:
      The participant's replication state.
      See Also:

    • replicationStateAsString

      public final String replicationStateAsString()

      The participant's replication state.

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

      Returns:
      The participant's replication state.
      See Also:

    • sourceStageArn

      public final String sourceStageArn()

      Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

      Returns:
      Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

    • sourceSessionId

      public final String sourceSessionId()

      ID of the session within the source stage, if replicationType is REPLICA.

      Returns:
      ID of the session within the source stage, if replicationType is REPLICA.

    • toBuilder

      public ParticipantSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParticipantSummary.Builder,ParticipantSummary>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.