java.lang.Object
- software.amazon.awssdk.services.ivsrealtime.model.Participant

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Participant.Builder,Participant>

@Generated("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 Description

static interface Participant.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`attributes()`	Application-provided attributes to encode into the token and attach to a stage.
`String`	`browserName()`	The participant’s browser.
`String`	`browserVersion()`	The participant’s browser version.
`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`	`ispName()`	The participant’s Internet Service Provider.
`String`	`osName()`	The participant’s operating system.
`String`	`osVersion()`	The participant’s operating system version.
`String`	`participantId()`	Unique identifier for this participant, assigned by IVS.
`ParticipantProtocol`	`protocol()`	Type of ingest protocol that the participant employs for broadcasting.
`String`	`protocolAsString()`	Type of ingest protocol that the participant employs for broadcasting.
`Boolean`	`published()`	Whether the participant ever published to the stage session.
`String`	`recordingS3BucketName()`	Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or `""` (empty string), if recording is not enabled.
`String`	`recordingS3Prefix()`	S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or `""` (empty string), if recording is not enabled.
`ParticipantRecordingState`	`recordingState()`	The participant’s recording state.
`String`	`recordingStateAsString()`	The participant’s recording state.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`sdkVersion()`	The participant’s SDK version.
`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
  - 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.
  - 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.
  - published
```
public final Boolean published()
```
    Whether the participant ever published to the stage session.
    
    Returns:
    
    Whether the participant ever published to the stage session.
  - ispName
```
public final String ispName()
```
    The participant’s Internet Service Provider.
    
    Returns:
    
    The participant’s Internet Service Provider.
  - osName
```
public final String osName()
```
    The participant’s operating system.
    
    Returns:
    
    The participant’s operating system.
  - osVersion
```
public final String osVersion()
```
    The participant’s operating system version.
    
    Returns:
    
    The participant’s operating system version.
  - browserName
```
public final String browserName()
```
    The participant’s browser.
    
    Returns:
    
    The participant’s browser.
  - browserVersion
```
public final String browserVersion()
```
    The participant’s browser version.
    
    Returns:
    
    The participant’s browser version.
  - sdkVersion
```
public final String sdkVersion()
```
    The participant’s SDK version.
    
    Returns:
    
    The participant’s SDK version.
  - recordingS3BucketName
```
public final String recordingS3BucketName()
```
    Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
    
    Returns:
    
    Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
  - recordingS3Prefix
```
public final String recordingS3Prefix()
```
    S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
    
    Returns:
    
    S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
  - 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
  - protocol
```
public final ParticipantProtocol protocol()
```
    Type of ingest protocol that the participant employs for broadcasting.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ParticipantProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    Type of ingest protocol that the participant employs for broadcasting.
    
    See Also:
    
    ParticipantProtocol
  - protocolAsString
```
public final String protocolAsString()
```
    Type of ingest protocol that the participant employs for broadcasting.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ParticipantProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().
    
    Returns:
    
    Type of ingest protocol that the participant employs for broadcasting.
    
    See Also:
    
    ParticipantProtocol
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Participant

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

participantId

userId

state

stateAsString

firstJoinTime

hasAttributes

attributes

published

ispName

osName

osVersion

browserName

browserVersion

sdkVersion

recordingS3BucketName

recordingS3Prefix

recordingState

recordingStateAsString

protocol

protocolAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField