SessionCancelParams

All Implemented Interfaces:

com.openai.core.Params
```
public final class SessionCancelParams
 implements Params
                    
```
Cancel an active ChatKit session and return its most recent metadata.
Cancelling prevents new requests from using the issued client secret.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`SessionCancelParams.Builder`	A builder for SessionCancelParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`sessionId()`
`final Map<String, JsonValue>`	`_additionalBodyProperties()`	Additional body properties to send with the request.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final SessionCancelParams.Builder`	`toBuilder()`
`final Optional<Map<String, JsonValue>>`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static SessionCancelParams`	`none()`
`final static SessionCancelParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of SessionCancelParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - sessionId
```
 final Optional<String> sessionId()
```
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
    Additional body properties to send with the request.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final SessionCancelParams.Builder toBuilder()
```
  - _body
```
 final Optional<Map<String, JsonValue>> _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static SessionCancelParams none()
```
  - builder
```
 final static SessionCancelParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of SessionCancelParams.