Class SessionCreateParams.Body
- 
                    
                    
- All Implemented Interfaces:
 
public final class SessionCreateParams.BodyParameters for provisioning a new ChatKit session.
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSessionCreateParams.Body.BuilderA builder for Body.
 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final Stringuser()A free-form string that identifies your end user; ensures this Session can access other objects that have the same userscope.final ChatSessionWorkflowParamworkflow()Workflow that powers the session. final Optional<ChatSessionChatKitConfigurationParam>chatkitConfiguration()Optional overrides for ChatKit runtime configuration features final Optional<ChatSessionExpiresAfterParam>expiresAfter()Optional override for session expiration timing in seconds from creation. final Optional<ChatSessionRateLimitsParam>rateLimits()Optional override for per-minute request limits. final JsonField<String>_user()Returns the raw JSON value of user. final JsonField<ChatSessionWorkflowParam>_workflow()Returns the raw JSON value of workflow. final JsonField<ChatSessionChatKitConfigurationParam>_chatkitConfiguration()Returns the raw JSON value of chatkitConfiguration. final JsonField<ChatSessionExpiresAfterParam>_expiresAfter()Returns the raw JSON value of expiresAfter. final JsonField<ChatSessionRateLimitsParam>_rateLimits()Returns the raw JSON value of rateLimits. final Map<String, JsonValue>_additionalProperties()final SessionCreateParams.Body.BuildertoBuilder()final SessionCreateParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static SessionCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
user
final String user()
A free-form string that identifies your end user; ensures this Session can access other objects that have the same
userscope. 
- 
                                        
workflow
final ChatSessionWorkflowParam workflow()
Workflow that powers the session.
 
- 
                                        
chatkitConfiguration
final Optional<ChatSessionChatKitConfigurationParam> chatkitConfiguration()
Optional overrides for ChatKit runtime configuration features
 
- 
                                        
expiresAfter
final Optional<ChatSessionExpiresAfterParam> expiresAfter()
Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.
 
- 
                                        
rateLimits
final Optional<ChatSessionRateLimitsParam> rateLimits()
Optional override for per-minute request limits. When omitted, defaults to 10.
 
- 
                                        
_user
final JsonField<String> _user()
Returns the raw JSON value of user.
Unlike user, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_workflow
final JsonField<ChatSessionWorkflowParam> _workflow()
Returns the raw JSON value of workflow.
Unlike workflow, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_chatkitConfiguration
final JsonField<ChatSessionChatKitConfigurationParam> _chatkitConfiguration()
Returns the raw JSON value of chatkitConfiguration.
Unlike chatkitConfiguration, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_expiresAfter
final JsonField<ChatSessionExpiresAfterParam> _expiresAfter()
Returns the raw JSON value of expiresAfter.
Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_rateLimits
final JsonField<ChatSessionRateLimitsParam> _rateLimits()
Returns the raw JSON value of rateLimits.
Unlike rateLimits, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final SessionCreateParams.Body.Builder toBuilder()
 
- 
                                        
validate
final SessionCreateParams.Body validate()
 
- 
                                        
builder
final static SessionCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.user() .workflow() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -