All Implemented Interfaces:

com.openai.core.Params
```
public final class BatchCancelParams
 implements Params
                    
```
Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

Nested Class Summary

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

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

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

Constructor Detail

Method Detail

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

_additionalBodyProperties

 final Map<String, JsonValue> _additionalBodyProperties()

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

_additionalQueryParams

 final QueryParams _additionalQueryParams()

toBuilder

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

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

Class BatchCancelParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

batchId

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder