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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ParticipantToken.Builder,ParticipantToken>
```
@Generated("software.amazon.awssdk:codegen")
public final class ParticipantToken
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParticipantToken.Builder,ParticipantToken>
```
Object specifying a participant token in a stage.

Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ParticipantToken.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.
`static ParticipantToken.Builder`	`builder()`
`List<ParticipantTokenCapability>`	`capabilities()`	Set of capabilities that the user is allowed to perform in the stage.
`List<String>`	`capabilitiesAsStrings()`	Set of capabilities that the user is allowed to perform in the stage.
`Integer`	`duration()`	Duration (in minutes), after which the participant token expires.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`expirationTime()`	ISO 8601 timestamp (returned as a string) for when this token expires.
`<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.
`boolean`	`hasCapabilities()`	For responses, this returns true if the service returned a value for the Capabilities property.
`int`	`hashCode()`
`String`	`participantId()`	Unique identifier for this participant token, assigned by IVS.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ParticipantToken.Builder>`	`serializableBuilderClass()`
`ParticipantToken.Builder`	`toBuilder()`
`String`	`token()`	The issued client token, encrypted.
`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. 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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - capabilities
```
public final List<ParticipantTokenCapability> capabilities()
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    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 hasCapabilities() method.
    
    Returns:
    
    Set of capabilities that the user is allowed to perform in the stage.
  - hasCapabilities
```
public final boolean hasCapabilities()
```
    For responses, this returns true if the service returned a value for the Capabilities 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.
  - capabilitiesAsStrings
```
public final List<String> capabilitiesAsStrings()
```
    Set of capabilities that the user is allowed to perform in the stage.
    
    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 hasCapabilities() method.
    
    Returns:
    
    Set of capabilities that the user is allowed to perform in the stage.
  - duration
```
public final Integer duration()
```
    Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
    
    Returns:
    
    Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
  - expirationTime
```
public final Instant expirationTime()
```
    ISO 8601 timestamp (returned as a string) for when this token expires.
    
    Returns:
    
    ISO 8601 timestamp (returned as a string) for when this token expires.
  - participantId
```
public final String participantId()
```
    Unique identifier for this participant token, assigned by IVS.
    
    Returns:
    
    Unique identifier for this participant token, assigned by IVS.
  - token
```
public final String token()
```
    The issued client token, encrypted.
    
    Returns:
    
    The issued client token, encrypted.
  - 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 ParticipantToken.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ParticipantToken.Builder,ParticipantToken>
  - builder
```
public static ParticipantToken.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ParticipantToken.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

Class ParticipantToken

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAttributes

attributes

capabilities

hasCapabilities

capabilitiesAsStrings

duration

expirationTime

participantId

token

userId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields