All Implemented Interfaces:


public final class MessageBatch

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`MessageBatch.Builder`	A builder for MessageBatch.
`public final class`	`MessageBatch.ProcessingStatus`	Processing status of the Message Batch.
`public final class`	`MessageBatch.Type`	Object type. For Message Batches, this is always `"message_batch"`.

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()`	Unique object identifier.
`final Optional<OffsetDateTime>`	`archivedAt()`	RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
`final Optional<OffsetDateTime>`	`cancelInitiatedAt()`	RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch.
`final OffsetDateTime`	`createdAt()`	RFC 3339 datetime string representing the time at which the Message Batch was created.
`final Optional<OffsetDateTime>`	`endedAt()`	RFC 3339 datetime string representing the time at which processing for the Message Batch ended.
`final OffsetDateTime`	`expiresAt()`	RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
`final MessageBatch.ProcessingStatus`	`processingStatus()`	Processing status of the Message Batch.
`final MessageBatchRequestCounts`	`requestCounts()`	Tallies requests within the Message Batch, categorized by their status.
`final Optional<String>`	`resultsUrl()`	URL to a `.jsonl` file containing the results of the Message Batch requests.
`final MessageBatch.Type`	`type()`	Object type.
`final JsonField<String>`	`_id()`	Unique object identifier.
`final JsonField<OffsetDateTime>`	`_archivedAt()`	RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
`final JsonField<OffsetDateTime>`	`_cancelInitiatedAt()`	RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch.
`final JsonField<OffsetDateTime>`	`_createdAt()`	RFC 3339 datetime string representing the time at which the Message Batch was created.
`final JsonField<OffsetDateTime>`	`_endedAt()`	RFC 3339 datetime string representing the time at which processing for the Message Batch ended.
`final JsonField<OffsetDateTime>`	`_expiresAt()`	RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
`final JsonField<MessageBatch.ProcessingStatus>`	`_processingStatus()`	Processing status of the Message Batch.
`final JsonField<MessageBatchRequestCounts>`	`_requestCounts()`	Tallies requests within the Message Batch, categorized by their status.
`final JsonField<String>`	`_resultsUrl()`	URL to a `.jsonl` file containing the results of the Message Batch requests.
`final JsonField<MessageBatch.Type>`	`_type()`	Object type.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final MessageBatch`	`validate()`
`final MessageBatch.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static MessageBatch.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()
```
    Unique object identifier.
    The format and length of IDs may change over time.
  - archivedAt
```
 final Optional<OffsetDateTime> archivedAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
  - cancelInitiatedAt
```
 final Optional<OffsetDateTime> cancelInitiatedAt()
```
    RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
  - createdAt
```
 final OffsetDateTime createdAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch was created.
  - endedAt
```
 final Optional<OffsetDateTime> endedAt()
```
    RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
    Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
  - expiresAt
```
 final OffsetDateTime expiresAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
  - processingStatus
```
 final MessageBatch.ProcessingStatus processingStatus()
```
    Processing status of the Message Batch.
  - requestCounts
```
 final MessageBatchRequestCounts requestCounts()
```
    Tallies requests within the Message Batch, categorized by their status.
    Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
  - resultsUrl
```
 final Optional<String> resultsUrl()
```
    URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
    Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.
  - type
```
 final MessageBatch.Type type()
```
    Object type.
    For Message Batches, this is always "message_batch".
  - _id
```
 final JsonField<String> _id()
```
    Unique object identifier.
    The format and length of IDs may change over time.
  - _archivedAt
```
 final JsonField<OffsetDateTime> _archivedAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
  - _cancelInitiatedAt
```
 final JsonField<OffsetDateTime> _cancelInitiatedAt()
```
    RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
  - _createdAt
```
 final JsonField<OffsetDateTime> _createdAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch was created.
  - _endedAt
```
 final JsonField<OffsetDateTime> _endedAt()
```
    RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
    Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
  - _expiresAt
```
 final JsonField<OffsetDateTime> _expiresAt()
```
    RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
  - _processingStatus
```
 final JsonField<MessageBatch.ProcessingStatus> _processingStatus()
```
    Processing status of the Message Batch.
  - _requestCounts
```
 final JsonField<MessageBatchRequestCounts> _requestCounts()
```
    Tallies requests within the Message Batch, categorized by their status.
    Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
  - _resultsUrl
```
 final JsonField<String> _resultsUrl()
```
    URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
    Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.
  - _type
```
 final JsonField<MessageBatch.Type> _type()
```
    Object type.
    For Message Batches, this is always "message_batch".
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final MessageBatch validate()
```
  - toBuilder
```
 final MessageBatch.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static MessageBatch.Builder builder()
```

Class MessageBatch

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

archivedAt

cancelInitiatedAt

createdAt

endedAt

expiresAt

processingStatus

requestCounts

resultsUrl

type

_id

_archivedAt

_cancelInitiatedAt

_createdAt

_endedAt

_expiresAt

_processingStatus

_requestCounts

_resultsUrl

_type

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder