All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  CreateChatTokenRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreateChatTokenRequest	addAttributesEntry (String key, String value) Add a single Attributes entry
  CreateChatTokenRequest	clearAttributesEntries () Removes all the entries added into Attributes.
  CreateChatTokenRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  Map<String,String>	getAttributes () Application-provided attributes to encode into the token and attach to a chat session.
  List<String>	getCapabilities () Set of capabilities that the user is allowed to perform in the room.
  String	getRoomIdentifier () Identifier of the room that the client is trying to access.
  Integer	getSessionDurationInMinutes () Session duration (in minutes), after which the session expires.
  String	getUserId () Application-provided ID that uniquely identifies the user associated with this token.
  int	hashCode ()
  void	setAttributes (Map<String,String> attributes) Application-provided attributes to encode into the token and attach to a chat session.
  void	setCapabilities (Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the room.
  void	setRoomIdentifier (String roomIdentifier) Identifier of the room that the client is trying to access.
  void	setSessionDurationInMinutes (Integer sessionDurationInMinutes) Session duration (in minutes), after which the session expires.
  void	setUserId (String userId) Application-provided ID that uniquely identifies the user associated with this token.
  String	toString () Returns a string representation of this object.
  CreateChatTokenRequest	withAttributes (Map<String,String> attributes) Application-provided attributes to encode into the token and attach to a chat session.
  CreateChatTokenRequest	withCapabilities (ChatTokenCapability... capabilities) Set of capabilities that the user is allowed to perform in the room.
  CreateChatTokenRequest	withCapabilities (Collection<String> capabilities) Set of capabilities that the user is allowed to perform in the room.
  CreateChatTokenRequest	withCapabilities (String... capabilities) Set of capabilities that the user is allowed to perform in the room.
  CreateChatTokenRequest	withRoomIdentifier (String roomIdentifier) Identifier of the room that the client is trying to access.
  CreateChatTokenRequest	withSessionDurationInMinutes (Integer sessionDurationInMinutes) Session duration (in minutes), after which the session expires.
  CreateChatTokenRequest	withUserId (String userId) Application-provided ID that uniquely identifies the user associated with this token.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • CreateChatTokenRequest

    public CreateChatTokenRequest()

• Method Detail

  • setRoomIdentifier

    public void setRoomIdentifier(String roomIdentifier)

    Identifier of the room that the client is trying to access. Currently this must be an ARN.

    Parameters:

    roomIdentifier - Identifier of the room that the client is trying to access. Currently this must be an ARN.

  • getRoomIdentifier

    public String getRoomIdentifier()

    Identifier of the room that the client is trying to access. Currently this must be an ARN.

    Returns:

    Identifier of the room that the client is trying to access. Currently this must be an ARN.

  • withRoomIdentifier

    public CreateChatTokenRequest withRoomIdentifier(String roomIdentifier)

    Identifier of the room that the client is trying to access. Currently this must be an ARN.

    Parameters:

    roomIdentifier - Identifier of the room that the client is trying to access. Currently this must be an ARN.

    Returns:

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

  • setUserId

    public void setUserId(String userId)

    Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

    Parameters:

    userId - Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

  • getUserId

    public String getUserId()

    Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

    Returns:

    Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

  • withUserId

    public CreateChatTokenRequest withUserId(String userId)

    Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

    Parameters:

    userId - Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

    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 room. Default: None (the capability to view messages is implicitly included in all requests).

    Returns:

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    See Also:

    ChatTokenCapability

  • setCapabilities

    public void setCapabilities(Collection<String> capabilities)

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    Parameters:

    capabilities - Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    See Also:

    ChatTokenCapability

  • withCapabilities

    public CreateChatTokenRequest withCapabilities(String... capabilities)

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    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 room. Default: None (the capability to view messages is implicitly included in all requests).

    Returns:

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

    See Also:

    ChatTokenCapability

  • withCapabilities

    public CreateChatTokenRequest withCapabilities(Collection<String> capabilities)

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    Parameters:

    capabilities - Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    Returns:

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

    See Also:

    ChatTokenCapability

  • withCapabilities

    public CreateChatTokenRequest withCapabilities(ChatTokenCapability... capabilities)

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    Parameters:

    capabilities - Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

    Returns:

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

    See Also:

    ChatTokenCapability

  • setSessionDurationInMinutes

    public void setSessionDurationInMinutes(Integer sessionDurationInMinutes)

    Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

    Parameters:

    sessionDurationInMinutes - Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

  • getSessionDurationInMinutes

    public Integer getSessionDurationInMinutes()

    Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

    Returns:

    Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

  • withSessionDurationInMinutes

    public CreateChatTokenRequest withSessionDurationInMinutes(Integer sessionDurationInMinutes)

    Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

    Parameters:

    sessionDurationInMinutes - Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

    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 token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

    Returns:

    Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

  • setAttributes

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

    Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

    Parameters:

    attributes - Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

  • withAttributes

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

    Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

    Parameters:

    attributes - Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

    Returns:

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

  • addAttributesEntry

    public CreateChatTokenRequest addAttributesEntry(String key,
     String value)

    Add a single Attributes entry

    See Also:

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

  • clearAttributesEntries

    public CreateChatTokenRequest clearAttributesEntries()

    Removes all the entries added into Attributes.

    Returns:

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

  • 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 CreateChatTokenRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()