java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ivschat.model.IvschatRequest
    - - software.amazon.awssdk.services.ivschat.model.CreateChatTokenRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateChatTokenRequest
extends IvschatRequest
implements ToCopyableBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateChatTokenRequest.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 chat session.
`static CreateChatTokenRequest.Builder`	`builder()`
`List<ChatTokenCapability>`	`capabilities()`	Set of capabilities that the user is allowed to perform in the room.
`List<String>`	`capabilitiesAsStrings()`	Set of capabilities that the user is allowed to perform in the room.
`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()`
`String`	`roomIdentifier()`	Identifier of the room that the client is trying to access.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateChatTokenRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`sessionDurationInMinutes()`	Session duration (in minutes), after which the session expires.
`CreateChatTokenRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userId()`	Application-provided ID that uniquely identifies the user associated with this 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
  - roomIdentifier
```
public final String roomIdentifier()
```
    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.
  - userId
```
public final String userId()
```
    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.
  - capabilities
```
public final List<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).
    
    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 room. Default: None (the capability to view messages is implicitly included in all requests).
  - 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 room. Default: None (the capability to view messages is implicitly included in all requests).
    
    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 room. Default: None (the capability to view messages is implicitly included in all requests).
  - sessionDurationInMinutes
```
public final Integer sessionDurationInMinutes()
```
    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).
  - 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 chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
    
    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 chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
  - toBuilder
```
public CreateChatTokenRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateChatTokenRequest.Builder,CreateChatTokenRequest>
    
    Specified by:
    
    toBuilder in class IvschatRequest
  - builder
```
public static CreateChatTokenRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateChatTokenRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateChatTokenRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

roomIdentifier

userId

capabilities

hasCapabilities

capabilitiesAsStrings

sessionDurationInMinutes

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField