All Implemented Interfaces:


public final class MessageBatch.Builder

A builder for MessageBatch.

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 MessageBatch.Builder`	`id(String id)`	Unique object identifier.
`final MessageBatch.Builder`	`id(JsonField<String> id)`	Unique object identifier.
`final MessageBatch.Builder`	`archivedAt(OffsetDateTime archivedAt)`	RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
`final MessageBatch.Builder`	`archivedAt(Optional<OffsetDateTime> archivedAt)`	RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
`final MessageBatch.Builder`	`archivedAt(JsonField<OffsetDateTime> archivedAt)`	RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
`final MessageBatch.Builder`	`cancelInitiatedAt(OffsetDateTime cancelInitiatedAt)`	RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch.
`final MessageBatch.Builder`	`cancelInitiatedAt(Optional<OffsetDateTime> cancelInitiatedAt)`	RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch.
`final MessageBatch.Builder`	`cancelInitiatedAt(JsonField<OffsetDateTime> cancelInitiatedAt)`	RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch.
`final MessageBatch.Builder`	`createdAt(OffsetDateTime createdAt)`	RFC 3339 datetime string representing the time at which the Message Batch was created.
`final MessageBatch.Builder`	`createdAt(JsonField<OffsetDateTime> createdAt)`	RFC 3339 datetime string representing the time at which the Message Batch was created.
`final MessageBatch.Builder`	`endedAt(OffsetDateTime endedAt)`	RFC 3339 datetime string representing the time at which processing for the Message Batch ended.
`final MessageBatch.Builder`	`endedAt(Optional<OffsetDateTime> endedAt)`	RFC 3339 datetime string representing the time at which processing for the Message Batch ended.
`final MessageBatch.Builder`	`endedAt(JsonField<OffsetDateTime> endedAt)`	RFC 3339 datetime string representing the time at which processing for the Message Batch ended.
`final MessageBatch.Builder`	`expiresAt(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.Builder`	`expiresAt(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 MessageBatch.Builder`	`processingStatus(MessageBatch.ProcessingStatus processingStatus)`	Processing status of the Message Batch.
`final MessageBatch.Builder`	`processingStatus(JsonField<MessageBatch.ProcessingStatus> processingStatus)`	Processing status of the Message Batch.
`final MessageBatch.Builder`	`requestCounts(MessageBatchRequestCounts requestCounts)`	Tallies requests within the Message Batch, categorized by their status.
`final MessageBatch.Builder`	`requestCounts(JsonField<MessageBatchRequestCounts> requestCounts)`	Tallies requests within the Message Batch, categorized by their status.
`final MessageBatch.Builder`	`resultsUrl(String resultsUrl)`	URL to a `.jsonl` file containing the results of the Message Batch requests.
`final MessageBatch.Builder`	`resultsUrl(Optional<String> resultsUrl)`	URL to a `.jsonl` file containing the results of the Message Batch requests.
`final MessageBatch.Builder`	`resultsUrl(JsonField<String> resultsUrl)`	URL to a `.jsonl` file containing the results of the Message Batch requests.
`final MessageBatch.Builder`	`type(MessageBatch.Type type)`	Object type.
`final MessageBatch.Builder`	`type(JsonField<MessageBatch.Type> type)`	Object type.
`final MessageBatch.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final MessageBatch.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final MessageBatch.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final MessageBatch.Builder`	`removeAdditionalProperty(String key)`
`final MessageBatch.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final MessageBatch`	`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 MessageBatch.Builder id(String id)
```
    Unique object identifier.
    The format and length of IDs may change over time.
  - id
```
 final MessageBatch.Builder id(JsonField<String> id)
```
    Unique object identifier.
    The format and length of IDs may change over time.
  - archivedAt
```
 final MessageBatch.Builder archivedAt(OffsetDateTime archivedAt)
```
    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
  - archivedAt
```
 final MessageBatch.Builder archivedAt(Optional<OffsetDateTime> archivedAt)
```
    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
  - archivedAt
```
 final MessageBatch.Builder archivedAt(JsonField<OffsetDateTime> archivedAt)
```
    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
  - cancelInitiatedAt
```
 final MessageBatch.Builder cancelInitiatedAt(OffsetDateTime cancelInitiatedAt)
```
    RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
  - cancelInitiatedAt
```
 final MessageBatch.Builder cancelInitiatedAt(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.
  - cancelInitiatedAt
```
 final MessageBatch.Builder cancelInitiatedAt(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 MessageBatch.Builder createdAt(OffsetDateTime createdAt)
```
    RFC 3339 datetime string representing the time at which the Message Batch was created.
  - createdAt
```
 final MessageBatch.Builder createdAt(JsonField<OffsetDateTime> createdAt)
```
    RFC 3339 datetime string representing the time at which the Message Batch was created.
  - endedAt
```
 final MessageBatch.Builder endedAt(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.
  - endedAt
```
 final MessageBatch.Builder endedAt(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.
  - endedAt
```
 final MessageBatch.Builder endedAt(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 MessageBatch.Builder expiresAt(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.
  - expiresAt
```
 final MessageBatch.Builder expiresAt(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 MessageBatch.Builder processingStatus(MessageBatch.ProcessingStatus processingStatus)
```
    Processing status of the Message Batch.
  - processingStatus
```
 final MessageBatch.Builder processingStatus(JsonField<MessageBatch.ProcessingStatus> processingStatus)
```
    Processing status of the Message Batch.
  - requestCounts
```
 final MessageBatch.Builder requestCounts(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.
  - requestCounts
```
 final MessageBatch.Builder requestCounts(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 MessageBatch.Builder resultsUrl(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.
  - resultsUrl
```
 final MessageBatch.Builder resultsUrl(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.
  - resultsUrl
```
 final MessageBatch.Builder resultsUrl(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 MessageBatch.Builder type(MessageBatch.Type type)
```
    Object type.
    For Message Batches, this is always "message_batch".
  - type
```
 final MessageBatch.Builder type(JsonField<MessageBatch.Type> type)
```
    Object type.
    For Message Batches, this is always "message_batch".
  - additionalProperties
```
 final MessageBatch.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final MessageBatch.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final MessageBatch.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final MessageBatch.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final MessageBatch.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final MessageBatch build()
```

Class MessageBatch.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

archivedAt

archivedAt

archivedAt

cancelInitiatedAt

cancelInitiatedAt

cancelInitiatedAt

createdAt

createdAt

endedAt

endedAt

endedAt

expiresAt

expiresAt

processingStatus

processingStatus

requestCounts

requestCounts

resultsUrl

resultsUrl

resultsUrl

type

type

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build