software.amazon.awssdk.services.ivsrealtime.model

Class CreateParticipantTokenRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest

software.amazon.awssdk.services.ivsrealtime.model.CreateParticipantTokenRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateParticipantTokenRequest.Builder,CreateParticipantTokenRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateParticipantTokenRequest
extends IvsRealTimeRequest
implements ToCopyableBuilder<CreateParticipantTokenRequest.Builder,CreateParticipantTokenRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateParticipantTokenRequest.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 CreateParticipantTokenRequest.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 token expires.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateParticipantTokenRequest.Builder>	serializableBuilderClass()
String	stageArn() ARN of the stage to which this token is scoped.
CreateParticipantTokenRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() Name that can be specified to help identify the token.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

capabilities

public final List<ParticipantTokenCapability> capabilities()

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

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. Default: PUBLISH, SUBSCRIBE.

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. Default: PUBLISH, SUBSCRIBE.

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. Default: PUBLISH, SUBSCRIBE.

duration

public final Integer duration()

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

Returns:

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

stageArn

public final String stageArn()

ARN of the stage to which this token is scoped.

Returns:

ARN of the stage to which this token is scoped.

userId

public final String userId()

Name that can be specified to help identify the token. 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:

Name that can be specified to help identify the token. 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 CreateParticipantTokenRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateParticipantTokenRequest.Builder,CreateParticipantTokenRequest>

Specified by:

toBuilder in class IvsRealTimeRequest

builder

public static CreateParticipantTokenRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo