com.amazonaws.services.ivsrealtime.model

Class ParticipantTokenConfiguration

java.lang.Object

com.amazonaws.services.ivsrealtime.model.ParticipantTokenConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParticipantTokenConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Object specifying a participant token configuration in a stage.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParticipantTokenConfiguration()

Method Summary

Modifier and Type	Method and Description
ParticipantTokenConfiguration	addAttributesEntry(String key, String value) Add a single Attributes entry
ParticipantTokenConfiguration	clearAttributesEntries() Removes all the entries added into Attributes.
ParticipantTokenConfiguration	clone()
boolean	equals(Object obj)
Map<String,String>	getAttributes() Application-provided attributes to encode into the corresponding participant token and attach to a stage.
List<String>	getCapabilities() Set of capabilities that the user is allowed to perform in the stage.
Integer	getDuration() Duration (in minutes), after which the corresponding participant token expires.
String	getUserId() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributes(Map<String,String> attributes) Application-provided attributes to encode into the corresponding participant token and attach to a stage.
void	setCapabilities(Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the stage.
void	setDuration(Integer duration) Duration (in minutes), after which the corresponding participant token expires.
void	setUserId(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.
String	toString() Returns a string representation of this object.
ParticipantTokenConfiguration	withAttributes(Map<String,String> attributes) Application-provided attributes to encode into the corresponding participant token and attach to a stage.
ParticipantTokenConfiguration	withCapabilities(Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantTokenConfiguration	withCapabilities(ParticipantTokenCapability... capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantTokenConfiguration	withCapabilities(String... capabilities) Set of capabilities that the user is allowed to perform in the stage.
ParticipantTokenConfiguration	withDuration(Integer duration) Duration (in minutes), after which the corresponding participant token expires.
ParticipantTokenConfiguration	withUserId(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParticipantTokenConfiguration

public ParticipantTokenConfiguration()

Method Detail

setDuration

public void setDuration(Integer duration)

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

Parameters:

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

getDuration

public Integer getDuration()

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

Returns:

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

withDuration

public ParticipantTokenConfiguration withDuration(Integer duration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserId

public void setUserId(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.

Parameters:

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.

getUserId

public String getUserId()

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.

withUserId

public ParticipantTokenConfiguration withUserId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getAttributes

public Map<String,String> getAttributes()

Application-provided attributes to encode into the corresponding participant 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.

Returns:

Application-provided attributes to encode into the corresponding participant 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.

setAttributes

public void setAttributes(Map<String,String> attributes)

Application-provided attributes to encode into the corresponding participant 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.

Parameters:

attributes - Application-provided attributes to encode into the corresponding participant 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.

withAttributes

public ParticipantTokenConfiguration withAttributes(Map<String,String> attributes)

Application-provided attributes to encode into the corresponding participant 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.

Parameters:

attributes - Application-provided attributes to encode into the corresponding participant 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public ParticipantTokenConfiguration addAttributesEntry(String key,
                                                        String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public ParticipantTokenConfiguration clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCapabilities

public List<String> getCapabilities()

Set of capabilities that the user is allowed to perform in the stage.

Returns:

Set of capabilities that the user is allowed to perform in the stage.

See Also:

ParticipantTokenCapability

setCapabilities

public void setCapabilities(Collection<String> capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

See Also:

ParticipantTokenCapability

withCapabilities

public ParticipantTokenConfiguration withCapabilities(String... capabilities)

Set of capabilities that the user is allowed to perform in the stage.

NOTE: This method appends the values to the existing list (if any). Use setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to override the existing values.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantTokenCapability

withCapabilities

public ParticipantTokenConfiguration withCapabilities(Collection<String> capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantTokenCapability

withCapabilities

public ParticipantTokenConfiguration withCapabilities(ParticipantTokenCapability... capabilities)

Set of capabilities that the user is allowed to perform in the stage.

Parameters:

capabilities - Set of capabilities that the user is allowed to perform in the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ParticipantTokenCapability

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ParticipantTokenConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.