All Implemented Interfaces:


public final class BetaMessageBatch.Builder

A builder for BetaMessageBatch.

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

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