Class BetaMessageBatch.Builder
-
- All Implemented Interfaces:
public final class BetaMessageBatch.BuilderA builder for BetaMessageBatch.
-
-
Method Summary
Modifier and Type Method Description final BetaMessageBatch.Builderid(String id)Unique object identifier. final BetaMessageBatch.Builderid(JsonField<String> id)Unique object identifier. final BetaMessageBatch.BuilderarchivedAt(OffsetDateTime archivedAt)RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. final BetaMessageBatch.BuilderarchivedAt(Optional<OffsetDateTime> archivedAt)RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. final BetaMessageBatch.BuilderarchivedAt(JsonField<OffsetDateTime> archivedAt)RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. final BetaMessageBatch.BuildercancelInitiatedAt(OffsetDateTime cancelInitiatedAt)RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. final BetaMessageBatch.BuildercancelInitiatedAt(Optional<OffsetDateTime> cancelInitiatedAt)RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. final BetaMessageBatch.BuildercancelInitiatedAt(JsonField<OffsetDateTime> cancelInitiatedAt)RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. final BetaMessageBatch.BuildercreatedAt(OffsetDateTime createdAt)RFC 3339 datetime string representing the time at which the Message Batch was created. final BetaMessageBatch.BuildercreatedAt(JsonField<OffsetDateTime> createdAt)RFC 3339 datetime string representing the time at which the Message Batch was created. final BetaMessageBatch.BuilderendedAt(OffsetDateTime endedAt)RFC 3339 datetime string representing the time at which processing for the Message Batch ended. final BetaMessageBatch.BuilderendedAt(Optional<OffsetDateTime> endedAt)RFC 3339 datetime string representing the time at which processing for the Message Batch ended. final BetaMessageBatch.BuilderendedAt(JsonField<OffsetDateTime> endedAt)RFC 3339 datetime string representing the time at which processing for the Message Batch ended. final BetaMessageBatch.BuilderexpiresAt(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.BuilderexpiresAt(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.BuilderprocessingStatus(BetaMessageBatch.ProcessingStatus processingStatus)Processing status of the Message Batch. final BetaMessageBatch.BuilderprocessingStatus(JsonField<BetaMessageBatch.ProcessingStatus> processingStatus)Processing status of the Message Batch. final BetaMessageBatch.BuilderrequestCounts(BetaMessageBatchRequestCounts requestCounts)Tallies requests within the Message Batch, categorized by their status. final BetaMessageBatch.BuilderrequestCounts(JsonField<BetaMessageBatchRequestCounts> requestCounts)Tallies requests within the Message Batch, categorized by their status. final BetaMessageBatch.BuilderresultsUrl(String resultsUrl)URL to a .jsonlfile containing the results of the Message Batch requests.final BetaMessageBatch.BuilderresultsUrl(Optional<String> resultsUrl)URL to a .jsonlfile containing the results of the Message Batch requests.final BetaMessageBatch.BuilderresultsUrl(JsonField<String> resultsUrl)URL to a .jsonlfile containing the results of the Message Batch requests.final BetaMessageBatch.Buildertype(BetaMessageBatch.Type type)Object type. final BetaMessageBatch.Buildertype(JsonField<BetaMessageBatch.Type> type)Object type. final BetaMessageBatch.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final BetaMessageBatch.BuilderputAdditionalProperty(String key, JsonValue value)final BetaMessageBatch.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final BetaMessageBatch.BuilderremoveAdditionalProperty(String key)final BetaMessageBatch.BuilderremoveAllAdditionalProperties(Set<String> keys)final BetaMessageBatchbuild()-
-
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
processingand 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
processingand 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
.jsonlfile 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_idfield to match results to requests.
-
resultsUrl
final BetaMessageBatch.Builder resultsUrl(Optional<String> resultsUrl)
URL to a
.jsonlfile 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_idfield to match results to requests.
-
resultsUrl
final BetaMessageBatch.Builder resultsUrl(JsonField<String> resultsUrl)
URL to a
.jsonlfile 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_idfield 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()
-
-
-
-