All Implemented Interfaces:


public final class Batch.Builder

A builder for Batch.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 Batch.Builder`	`id(String id)`
`final Batch.Builder`	`id(JsonField<String> id)`
`final Batch.Builder`	`completionWindow(String completionWindow)`	The time frame within which the batch should be processed.
`final Batch.Builder`	`completionWindow(JsonField<String> completionWindow)`	The time frame within which the batch should be processed.
`final Batch.Builder`	`createdAt(Long createdAt)`	The Unix timestamp (in seconds) for when the batch was created.
`final Batch.Builder`	`createdAt(JsonField<Long> createdAt)`	The Unix timestamp (in seconds) for when the batch was created.
`final Batch.Builder`	`endpoint(String endpoint)`	The OpenAI API endpoint used by the batch.
`final Batch.Builder`	`endpoint(JsonField<String> endpoint)`	The OpenAI API endpoint used by the batch.
`final Batch.Builder`	`inputFileId(String inputFileId)`	The ID of the input file for the batch.
`final Batch.Builder`	`inputFileId(JsonField<String> inputFileId)`	The ID of the input file for the batch.
`final Batch.Builder`	`object_(JsonValue object_)`	The object type, which is always `batch`.
`final Batch.Builder`	`status(Batch.Status status)`	The current status of the batch.
`final Batch.Builder`	`status(JsonField<Batch.Status> status)`	The current status of the batch.
`final Batch.Builder`	`cancelledAt(Long cancelledAt)`	The Unix timestamp (in seconds) for when the batch was cancelled.
`final Batch.Builder`	`cancelledAt(JsonField<Long> cancelledAt)`	The Unix timestamp (in seconds) for when the batch was cancelled.
`final Batch.Builder`	`cancellingAt(Long cancellingAt)`	The Unix timestamp (in seconds) for when the batch started cancelling.
`final Batch.Builder`	`cancellingAt(JsonField<Long> cancellingAt)`	The Unix timestamp (in seconds) for when the batch started cancelling.
`final Batch.Builder`	`completedAt(Long completedAt)`	The Unix timestamp (in seconds) for when the batch was completed.
`final Batch.Builder`	`completedAt(JsonField<Long> completedAt)`	The Unix timestamp (in seconds) for when the batch was completed.
`final Batch.Builder`	`errorFileId(String errorFileId)`	The ID of the file containing the outputs of requests with errors.
`final Batch.Builder`	`errorFileId(JsonField<String> errorFileId)`	The ID of the file containing the outputs of requests with errors.
`final Batch.Builder`	`errors(Batch.Errors errors)`
`final Batch.Builder`	`errors(JsonField<Batch.Errors> errors)`
`final Batch.Builder`	`expiredAt(Long expiredAt)`	The Unix timestamp (in seconds) for when the batch expired.
`final Batch.Builder`	`expiredAt(JsonField<Long> expiredAt)`	The Unix timestamp (in seconds) for when the batch expired.
`final Batch.Builder`	`expiresAt(Long expiresAt)`	The Unix timestamp (in seconds) for when the batch will expire.
`final Batch.Builder`	`expiresAt(JsonField<Long> expiresAt)`	The Unix timestamp (in seconds) for when the batch will expire.
`final Batch.Builder`	`failedAt(Long failedAt)`	The Unix timestamp (in seconds) for when the batch failed.
`final Batch.Builder`	`failedAt(JsonField<Long> failedAt)`	The Unix timestamp (in seconds) for when the batch failed.
`final Batch.Builder`	`finalizingAt(Long finalizingAt)`	The Unix timestamp (in seconds) for when the batch started finalizing.
`final Batch.Builder`	`finalizingAt(JsonField<Long> finalizingAt)`	The Unix timestamp (in seconds) for when the batch started finalizing.
`final Batch.Builder`	`inProgressAt(Long inProgressAt)`	The Unix timestamp (in seconds) for when the batch started processing.
`final Batch.Builder`	`inProgressAt(JsonField<Long> inProgressAt)`	The Unix timestamp (in seconds) for when the batch started processing.
`final Batch.Builder`	`metadata(JsonValue metadata)`	Set of 16 key-value pairs that can be attached to an object.
`final Batch.Builder`	`outputFileId(String outputFileId)`	The ID of the file containing the outputs of successfully executed requests.
`final Batch.Builder`	`outputFileId(JsonField<String> outputFileId)`	The ID of the file containing the outputs of successfully executed requests.
`final Batch.Builder`	`requestCounts(BatchRequestCounts requestCounts)`	The request counts for different statuses within the batch.
`final Batch.Builder`	`requestCounts(JsonField<BatchRequestCounts> requestCounts)`	The request counts for different statuses within the batch.
`final Batch.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final Batch.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final Batch.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final Batch.Builder`	`removeAdditionalProperty(String key)`
`final Batch.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final Batch`	`build()`

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

- Constructor Detail
- Method Detail
  - id
```
 final Batch.Builder id(String id)
```
  - id
```
 final Batch.Builder id(JsonField<String> id)
```
  - completionWindow
```
 final Batch.Builder completionWindow(String completionWindow)
```
    The time frame within which the batch should be processed.
  - completionWindow
```
 final Batch.Builder completionWindow(JsonField<String> completionWindow)
```
    The time frame within which the batch should be processed.
  - createdAt
```
 final Batch.Builder createdAt(Long createdAt)
```
    The Unix timestamp (in seconds) for when the batch was created.
  - createdAt
```
 final Batch.Builder createdAt(JsonField<Long> createdAt)
```
    The Unix timestamp (in seconds) for when the batch was created.
  - endpoint
```
 final Batch.Builder endpoint(String endpoint)
```
    The OpenAI API endpoint used by the batch.
  - endpoint
```
 final Batch.Builder endpoint(JsonField<String> endpoint)
```
    The OpenAI API endpoint used by the batch.
  - inputFileId
```
 final Batch.Builder inputFileId(String inputFileId)
```
    The ID of the input file for the batch.
  - inputFileId
```
 final Batch.Builder inputFileId(JsonField<String> inputFileId)
```
    The ID of the input file for the batch.
  - object_
```
 final Batch.Builder object_(JsonValue object_)
```
    The object type, which is always batch.
  - status
```
 final Batch.Builder status(Batch.Status status)
```
    The current status of the batch.
  - status
```
 final Batch.Builder status(JsonField<Batch.Status> status)
```
    The current status of the batch.
  - cancelledAt
```
 final Batch.Builder cancelledAt(Long cancelledAt)
```
    The Unix timestamp (in seconds) for when the batch was cancelled.
  - cancelledAt
```
 final Batch.Builder cancelledAt(JsonField<Long> cancelledAt)
```
    The Unix timestamp (in seconds) for when the batch was cancelled.
  - cancellingAt
```
 final Batch.Builder cancellingAt(Long cancellingAt)
```
    The Unix timestamp (in seconds) for when the batch started cancelling.
  - cancellingAt
```
 final Batch.Builder cancellingAt(JsonField<Long> cancellingAt)
```
    The Unix timestamp (in seconds) for when the batch started cancelling.
  - completedAt
```
 final Batch.Builder completedAt(Long completedAt)
```
    The Unix timestamp (in seconds) for when the batch was completed.
  - completedAt
```
 final Batch.Builder completedAt(JsonField<Long> completedAt)
```
    The Unix timestamp (in seconds) for when the batch was completed.
  - errorFileId
```
 final Batch.Builder errorFileId(String errorFileId)
```
    The ID of the file containing the outputs of requests with errors.
  - errorFileId
```
 final Batch.Builder errorFileId(JsonField<String> errorFileId)
```
    The ID of the file containing the outputs of requests with errors.
  - errors
```
 final Batch.Builder errors(Batch.Errors errors)
```
  - errors
```
 final Batch.Builder errors(JsonField<Batch.Errors> errors)
```
  - expiredAt
```
 final Batch.Builder expiredAt(Long expiredAt)
```
    The Unix timestamp (in seconds) for when the batch expired.
  - expiredAt
```
 final Batch.Builder expiredAt(JsonField<Long> expiredAt)
```
    The Unix timestamp (in seconds) for when the batch expired.
  - expiresAt
```
 final Batch.Builder expiresAt(Long expiresAt)
```
    The Unix timestamp (in seconds) for when the batch will expire.
  - expiresAt
```
 final Batch.Builder expiresAt(JsonField<Long> expiresAt)
```
    The Unix timestamp (in seconds) for when the batch will expire.
  - failedAt
```
 final Batch.Builder failedAt(Long failedAt)
```
    The Unix timestamp (in seconds) for when the batch failed.
  - failedAt
```
 final Batch.Builder failedAt(JsonField<Long> failedAt)
```
    The Unix timestamp (in seconds) for when the batch failed.
  - finalizingAt
```
 final Batch.Builder finalizingAt(Long finalizingAt)
```
    The Unix timestamp (in seconds) for when the batch started finalizing.
  - finalizingAt
```
 final Batch.Builder finalizingAt(JsonField<Long> finalizingAt)
```
    The Unix timestamp (in seconds) for when the batch started finalizing.
  - inProgressAt
```
 final Batch.Builder inProgressAt(Long inProgressAt)
```
    The Unix timestamp (in seconds) for when the batch started processing.
  - inProgressAt
```
 final Batch.Builder inProgressAt(JsonField<Long> inProgressAt)
```
    The Unix timestamp (in seconds) for when the batch started processing.
  - metadata
```
 final Batch.Builder metadata(JsonValue 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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
  - outputFileId
```
 final Batch.Builder outputFileId(String outputFileId)
```
    The ID of the file containing the outputs of successfully executed requests.
  - outputFileId
```
 final Batch.Builder outputFileId(JsonField<String> outputFileId)
```
    The ID of the file containing the outputs of successfully executed requests.
  - requestCounts
```
 final Batch.Builder requestCounts(BatchRequestCounts requestCounts)
```
    The request counts for different statuses within the batch.
  - requestCounts
```
 final Batch.Builder requestCounts(JsonField<BatchRequestCounts> requestCounts)
```
    The request counts for different statuses within the batch.
  - additionalProperties
```
 final Batch.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final Batch.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final Batch.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final Batch.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final Batch.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final Batch build()
```

Class Batch.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

id

completionWindow

completionWindow

createdAt

createdAt

endpoint

endpoint

inputFileId

inputFileId

object_

status

status

cancelledAt

cancelledAt

cancellingAt

cancellingAt

completedAt

completedAt

errorFileId

errorFileId

errors

errors

expiredAt

expiredAt

expiresAt

expiresAt

failedAt

failedAt

finalizingAt

finalizingAt

inProgressAt

inProgressAt

metadata

outputFileId

outputFileId

requestCounts

requestCounts

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build