@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ParticipantToken extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
ParticipantToken() |
Modifier and Type | Method and Description |
---|---|
ParticipantToken |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
ParticipantToken |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
ParticipantToken |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
Application-provided attributes to encode into the 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 participant token expires.
|
Date |
getExpirationTime()
ISO 8601 timestamp (returned as a string) for when this token expires.
|
String |
getParticipantId()
Unique identifier for this participant token, assigned by IVS.
|
String |
getToken()
The issued client token, encrypted.
|
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 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 participant token expires.
|
void |
setExpirationTime(Date expirationTime)
ISO 8601 timestamp (returned as a string) for when this token expires.
|
void |
setParticipantId(String participantId)
Unique identifier for this participant token, assigned by IVS.
|
void |
setToken(String token)
The issued client token, encrypted.
|
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.
|
ParticipantToken |
withAttributes(Map<String,String> attributes)
Application-provided attributes to encode into the token and attach to a stage.
|
ParticipantToken |
withCapabilities(Collection<String> capabilities)
Set of capabilities that the user is allowed to perform in the stage.
|
ParticipantToken |
withCapabilities(ParticipantTokenCapability... capabilities)
Set of capabilities that the user is allowed to perform in the stage.
|
ParticipantToken |
withCapabilities(String... capabilities)
Set of capabilities that the user is allowed to perform in the stage.
|
ParticipantToken |
withDuration(Integer duration)
Duration (in minutes), after which the participant token expires.
|
ParticipantToken |
withExpirationTime(Date expirationTime)
ISO 8601 timestamp (returned as a string) for when this token expires.
|
ParticipantToken |
withParticipantId(String participantId)
Unique identifier for this participant token, assigned by IVS.
|
ParticipantToken |
withToken(String token)
The issued client token, encrypted.
|
ParticipantToken |
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.
|
public void setParticipantId(String participantId)
Unique identifier for this participant token, assigned by IVS.
participantId
- Unique identifier for this participant token, assigned by IVS.public String getParticipantId()
Unique identifier for this participant token, assigned by IVS.
public ParticipantToken withParticipantId(String participantId)
Unique identifier for this participant token, assigned by IVS.
participantId
- Unique identifier for this participant token, assigned by IVS.public void setToken(String token)
The issued client token, encrypted.
token
- The issued client token, encrypted.public String getToken()
The issued client token, encrypted.
public ParticipantToken withToken(String token)
The issued client token, encrypted.
token
- The issued client token, encrypted.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.
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.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.
public ParticipantToken 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.
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.public Map<String,String> getAttributes()
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.
public void setAttributes(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.
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.public ParticipantToken withAttributes(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.
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.public ParticipantToken addAttributesEntry(String key, String value)
public ParticipantToken clearAttributesEntries()
public void setDuration(Integer duration)
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
duration
- Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).public Integer getDuration()
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
public ParticipantToken withDuration(Integer duration)
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
duration
- Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).public List<String> getCapabilities()
Set of capabilities that the user is allowed to perform in the stage.
ParticipantTokenCapability
public void setCapabilities(Collection<String> capabilities)
Set of capabilities that the user is allowed to perform in the stage.
capabilities
- Set of capabilities that the user is allowed to perform in the stage.ParticipantTokenCapability
public ParticipantToken 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.
capabilities
- Set of capabilities that the user is allowed to perform in the stage.ParticipantTokenCapability
public ParticipantToken withCapabilities(Collection<String> capabilities)
Set of capabilities that the user is allowed to perform in the stage.
capabilities
- Set of capabilities that the user is allowed to perform in the stage.ParticipantTokenCapability
public ParticipantToken withCapabilities(ParticipantTokenCapability... capabilities)
Set of capabilities that the user is allowed to perform in the stage.
capabilities
- Set of capabilities that the user is allowed to perform in the stage.ParticipantTokenCapability
public void setExpirationTime(Date expirationTime)
ISO 8601 timestamp (returned as a string) for when this token expires.
expirationTime
- ISO 8601 timestamp (returned as a string) for when this token expires.public Date getExpirationTime()
ISO 8601 timestamp (returned as a string) for when this token expires.
public ParticipantToken withExpirationTime(Date expirationTime)
ISO 8601 timestamp (returned as a string) for when this token expires.
expirationTime
- ISO 8601 timestamp (returned as a string) for when this token expires.public String toString()
toString
in class Object
Object.toString()
public ParticipantToken clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.