All Implemented Interfaces:

com.openai.core.Params
```
public final class ResponseCancelParams
 implements Params
                    
```
Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

Nested Class Summary

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

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>`	`responseId()`
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ResponseCancelParams.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 ResponseCancelParams`	`none()`
`final static ResponseCancelParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ResponseCancelParams.

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

Constructor Detail

Method Detail

responseId
```
 final Optional<String> responseId()
```

_additionalBodyProperties

 final Map<String, JsonValue> _additionalBodyProperties()

_additionalHeaders
```
 final Headers _additionalHeaders()
```

_additionalQueryParams

 final QueryParams _additionalQueryParams()

toBuilder

 final ResponseCancelParams.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 ResponseCancelParams none()

builder
```
 final static ResponseCancelParams.Builder builder()
```
Returns a mutable builder for constructing an instance of ResponseCancelParams.

Class ResponseCancelParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

responseId

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder