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)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Alias for calling Builder.archivedAt with archivedAt.orElse(null).

• archivedAt

   final MessageBatch.Builder archivedAt(JsonField<OffsetDateTime> archivedAt)

  Sets Builder.archivedAt to an arbitrary JSON value.

  You should usually call Builder.archivedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Alias for calling Builder.cancelInitiatedAt with cancelInitiatedAt.orElse(null).

• cancelInitiatedAt

   final MessageBatch.Builder cancelInitiatedAt(JsonField<OffsetDateTime> cancelInitiatedAt)

  Sets Builder.cancelInitiatedAt to an arbitrary JSON value.

  You should usually call Builder.cancelInitiatedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.createdAt to an arbitrary JSON value.

  You should usually call Builder.createdAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Alias for calling Builder.endedAt with endedAt.orElse(null).

• endedAt

   final MessageBatch.Builder endedAt(JsonField<OffsetDateTime> endedAt)

  Sets Builder.endedAt to an arbitrary JSON value.

  You should usually call Builder.endedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.expiresAt to an arbitrary JSON value.

  You should usually call Builder.expiresAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• processingStatus

   final MessageBatch.Builder processingStatus(MessageBatch.ProcessingStatus processingStatus)

  Processing status of the Message Batch.

• processingStatus

   final MessageBatch.Builder processingStatus(JsonField<MessageBatch.ProcessingStatus> processingStatus)

  Sets Builder.processingStatus to an arbitrary JSON value.

  You should usually call Builder.processingStatus with a well-typed ProcessingStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Sets Builder.requestCounts to an arbitrary JSON value.

  You should usually call Builder.requestCounts with a well-typed MessageBatchRequestCounts value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• 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)

  Alias for calling Builder.resultsUrl with resultsUrl.orElse(null).

• resultsUrl

   final MessageBatch.Builder resultsUrl(JsonField<String> resultsUrl)

  Sets Builder.resultsUrl to an arbitrary JSON value.

  You should usually call Builder.resultsUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final MessageBatch.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("message_batch")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• 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()

  Returns an immutable instance of MessageBatch.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .id()
  .archivedAt()
  .cancelInitiatedAt()
  .createdAt()
  .endedAt()
  .expiresAt()
  .processingStatus()
  .requestCounts()
  .resultsUrl()