All Implemented Interfaces:


public final class Batch

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Batch.Builder`	A builder for Batch.
`public final class`	`Batch.Status`	The current status of the batch.
`public final class`	`Batch.Errors`

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`	`id()`
`final String`	`completionWindow()`	The time frame within which the batch should be processed.
`final Long`	`createdAt()`	The Unix timestamp (in seconds) for when the batch was created.
`final String`	`endpoint()`	The OpenAI API endpoint used by the batch.
`final String`	`inputFileId()`	The ID of the input file for the batch.
`final JsonValue`	`_object_()`	The object type, which is always `batch`.
`final Batch.Status`	`status()`	The current status of the batch.
`final Optional<Long>`	`cancelledAt()`	The Unix timestamp (in seconds) for when the batch was cancelled.
`final Optional<Long>`	`cancellingAt()`	The Unix timestamp (in seconds) for when the batch started cancelling.
`final Optional<Long>`	`completedAt()`	The Unix timestamp (in seconds) for when the batch was completed.
`final Optional<String>`	`errorFileId()`	The ID of the file containing the outputs of requests with errors.
`final Optional<Batch.Errors>`	`errors()`
`final Optional<Long>`	`expiredAt()`	The Unix timestamp (in seconds) for when the batch expired.
`final Optional<Long>`	`expiresAt()`	The Unix timestamp (in seconds) for when the batch will expire.
`final Optional<Long>`	`failedAt()`	The Unix timestamp (in seconds) for when the batch failed.
`final Optional<Long>`	`finalizingAt()`	The Unix timestamp (in seconds) for when the batch started finalizing.
`final Optional<Long>`	`inProgressAt()`	The Unix timestamp (in seconds) for when the batch started processing.
`final Optional<Metadata>`	`metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final Optional<String>`	`outputFileId()`	The ID of the file containing the outputs of successfully executed requests.
`final Optional<BatchRequestCounts>`	`requestCounts()`	The request counts for different statuses within the batch.
`final JsonField<String>`	`_id()`
`final JsonField<String>`	`_completionWindow()`	The time frame within which the batch should be processed.
`final JsonField<Long>`	`_createdAt()`	The Unix timestamp (in seconds) for when the batch was created.
`final JsonField<String>`	`_endpoint()`	The OpenAI API endpoint used by the batch.
`final JsonField<String>`	`_inputFileId()`	The ID of the input file for the batch.
`final JsonField<Batch.Status>`	`_status()`	The current status of the batch.
`final JsonField<Long>`	`_cancelledAt()`	The Unix timestamp (in seconds) for when the batch was cancelled.
`final JsonField<Long>`	`_cancellingAt()`	The Unix timestamp (in seconds) for when the batch started cancelling.
`final JsonField<Long>`	`_completedAt()`	The Unix timestamp (in seconds) for when the batch was completed.
`final JsonField<String>`	`_errorFileId()`	The ID of the file containing the outputs of requests with errors.
`final JsonField<Batch.Errors>`	`_errors()`
`final JsonField<Long>`	`_expiredAt()`	The Unix timestamp (in seconds) for when the batch expired.
`final JsonField<Long>`	`_expiresAt()`	The Unix timestamp (in seconds) for when the batch will expire.
`final JsonField<Long>`	`_failedAt()`	The Unix timestamp (in seconds) for when the batch failed.
`final JsonField<Long>`	`_finalizingAt()`	The Unix timestamp (in seconds) for when the batch started finalizing.
`final JsonField<Long>`	`_inProgressAt()`	The Unix timestamp (in seconds) for when the batch started processing.
`final JsonField<Metadata>`	`_metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final JsonField<String>`	`_outputFileId()`	The ID of the file containing the outputs of successfully executed requests.
`final JsonField<BatchRequestCounts>`	`_requestCounts()`	The request counts for different statuses within the batch.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final Batch`	`validate()`
`final Batch.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Batch.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
  - completionWindow
```
 final String completionWindow()
```
    The time frame within which the batch should be processed.
  - createdAt
```
 final Long createdAt()
```
    The Unix timestamp (in seconds) for when the batch was created.
  - endpoint
```
 final String endpoint()
```
    The OpenAI API endpoint used by the batch.
  - inputFileId
```
 final String inputFileId()
```
    The ID of the input file for the batch.
  - _object_
```
 final JsonValue _object_()
```
    The object type, which is always batch.
  - status
```
 final Batch.Status status()
```
    The current status of the batch.
  - cancelledAt
```
 final Optional<Long> cancelledAt()
```
    The Unix timestamp (in seconds) for when the batch was cancelled.
  - cancellingAt
```
 final Optional<Long> cancellingAt()
```
    The Unix timestamp (in seconds) for when the batch started cancelling.
  - completedAt
```
 final Optional<Long> completedAt()
```
    The Unix timestamp (in seconds) for when the batch was completed.
  - errorFileId
```
 final Optional<String> errorFileId()
```
    The ID of the file containing the outputs of requests with errors.
  - errors
```
 final Optional<Batch.Errors> errors()
```
  - expiredAt
```
 final Optional<Long> expiredAt()
```
    The Unix timestamp (in seconds) for when the batch expired.
  - expiresAt
```
 final Optional<Long> expiresAt()
```
    The Unix timestamp (in seconds) for when the batch will expire.
  - failedAt
```
 final Optional<Long> failedAt()
```
    The Unix timestamp (in seconds) for when the batch failed.
  - finalizingAt
```
 final Optional<Long> finalizingAt()
```
    The Unix timestamp (in seconds) for when the batch started finalizing.
  - inProgressAt
```
 final Optional<Long> inProgressAt()
```
    The Unix timestamp (in seconds) for when the batch started processing.
  - metadata
```
 final Optional<Metadata> metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - outputFileId
```
 final Optional<String> outputFileId()
```
    The ID of the file containing the outputs of successfully executed requests.
  - requestCounts
```
 final Optional<BatchRequestCounts> requestCounts()
```
    The request counts for different statuses within the batch.
  - _id
```
 final JsonField<String> _id()
```
  - _completionWindow
```
 final JsonField<String> _completionWindow()
```
    The time frame within which the batch should be processed.
  - _createdAt
```
 final JsonField<Long> _createdAt()
```
    The Unix timestamp (in seconds) for when the batch was created.
  - _endpoint
```
 final JsonField<String> _endpoint()
```
    The OpenAI API endpoint used by the batch.
  - _inputFileId
```
 final JsonField<String> _inputFileId()
```
    The ID of the input file for the batch.
  - _status
```
 final JsonField<Batch.Status> _status()
```
    The current status of the batch.
  - _cancelledAt
```
 final JsonField<Long> _cancelledAt()
```
    The Unix timestamp (in seconds) for when the batch was cancelled.
  - _cancellingAt
```
 final JsonField<Long> _cancellingAt()
```
    The Unix timestamp (in seconds) for when the batch started cancelling.
  - _completedAt
```
 final JsonField<Long> _completedAt()
```
    The Unix timestamp (in seconds) for when the batch was completed.
  - _errorFileId
```
 final JsonField<String> _errorFileId()
```
    The ID of the file containing the outputs of requests with errors.
  - _errors
```
 final JsonField<Batch.Errors> _errors()
```
  - _expiredAt
```
 final JsonField<Long> _expiredAt()
```
    The Unix timestamp (in seconds) for when the batch expired.
  - _expiresAt
```
 final JsonField<Long> _expiresAt()
```
    The Unix timestamp (in seconds) for when the batch will expire.
  - _failedAt
```
 final JsonField<Long> _failedAt()
```
    The Unix timestamp (in seconds) for when the batch failed.
  - _finalizingAt
```
 final JsonField<Long> _finalizingAt()
```
    The Unix timestamp (in seconds) for when the batch started finalizing.
  - _inProgressAt
```
 final JsonField<Long> _inProgressAt()
```
    The Unix timestamp (in seconds) for when the batch started processing.
  - _metadata
```
 final JsonField<Metadata> _metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - _outputFileId
```
 final JsonField<String> _outputFileId()
```
    The ID of the file containing the outputs of successfully executed requests.
  - _requestCounts
```
 final JsonField<BatchRequestCounts> _requestCounts()
```
    The request counts for different statuses within the batch.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final Batch validate()
```
  - toBuilder
```
 final Batch.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static Batch.Builder builder()
```

Class Batch

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

completionWindow

createdAt

endpoint

inputFileId

_object_

status

cancelledAt

cancellingAt

completedAt

errorFileId

errors

expiredAt

expiresAt

failedAt

finalizingAt

inProgressAt

metadata

outputFileId

requestCounts

_id

_completionWindow

_createdAt

_endpoint

_inputFileId

_status

_cancelledAt

_cancellingAt

_completedAt

_errorFileId

_errors

_expiredAt

_expiresAt

_failedAt

_finalizingAt

_inProgressAt

_metadata

_outputFileId

_requestCounts

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder