BatchCancelParams 0.32.0 API

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 String`	`batchId()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`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.
`final String`	`getPathParam(Integer index)`
`final BatchCancelParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`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 String batchId()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _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.
  - getPathParam
```
 final String getPathParam(Integer index)
```
  - toBuilder
```
 final BatchCancelParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BatchCancelParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BatchCancelParams.
    The following fields are required:
    .batchId()