Constructor Detail

Method Detail

• body

   final SessionCreateParams.Builder body(SessionCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • user

  • workflow

  • chatkitConfiguration

  • expiresAfter

  • rateLimits

  • etc.

• user

   final SessionCreateParams.Builder user(String user)

  A free-form string that identifies your end user; ensures this Session can access other objects that have the same user scope.

• user

   final SessionCreateParams.Builder user(JsonField<String> user)

  Sets Builder.user to an arbitrary JSON value.

  You should usually call Builder.user with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• workflow

   final SessionCreateParams.Builder workflow(ChatSessionWorkflowParam workflow)

  Workflow that powers the session.

• workflow

   final SessionCreateParams.Builder workflow(JsonField<ChatSessionWorkflowParam> workflow)

  Sets Builder.workflow to an arbitrary JSON value.

  You should usually call Builder.workflow with a well-typed ChatSessionWorkflowParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• chatkitConfiguration

   final SessionCreateParams.Builder chatkitConfiguration(ChatSessionChatKitConfigurationParam chatkitConfiguration)

  Optional overrides for ChatKit runtime configuration features

• chatkitConfiguration

   final SessionCreateParams.Builder chatkitConfiguration(JsonField<ChatSessionChatKitConfigurationParam> chatkitConfiguration)

  Sets Builder.chatkitConfiguration to an arbitrary JSON value.

  You should usually call Builder.chatkitConfiguration with a well-typed ChatSessionChatKitConfigurationParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• expiresAfter

   final SessionCreateParams.Builder expiresAfter(ChatSessionExpiresAfterParam expiresAfter)

  Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.

• expiresAfter

   final SessionCreateParams.Builder expiresAfter(JsonField<ChatSessionExpiresAfterParam> expiresAfter)

  Sets Builder.expiresAfter to an arbitrary JSON value.

  You should usually call Builder.expiresAfter with a well-typed ChatSessionExpiresAfterParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• rateLimits

   final SessionCreateParams.Builder rateLimits(ChatSessionRateLimitsParam rateLimits)

  Optional override for per-minute request limits. When omitted, defaults to 10.

• rateLimits

   final SessionCreateParams.Builder rateLimits(JsonField<ChatSessionRateLimitsParam> rateLimits)

  Sets Builder.rateLimits to an arbitrary JSON value.

  You should usually call Builder.rateLimits with a well-typed ChatSessionRateLimitsParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final SessionCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final SessionCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final SessionCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final SessionCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final SessionCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final SessionCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final SessionCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final SessionCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final SessionCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final SessionCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final SessionCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final SessionCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final SessionCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final SessionCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final SessionCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final SessionCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final SessionCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final SessionCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final SessionCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final SessionCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final SessionCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final SessionCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final SessionCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final SessionCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final SessionCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final SessionCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final SessionCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final SessionCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final SessionCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final SessionCreateParams build()

  Returns an immutable instance of SessionCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .user()
  .workflow()