Interface IngestionJobDetail.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IngestionJobDetail.Builder,IngestionJobDetail>, SdkBuilder<IngestionJobDetail.Builder,IngestionJobDetail>, SdkPojo
Enclosing class:
IngestionJobDetail
@Mutable @NotThreadSafe public static interface IngestionJobDetail.Builder extends SdkPojo, CopyableBuilder<IngestionJobDetail.Builder,IngestionJobDetail>

  • Method Details

    • ingestionJobId

      IngestionJobDetail.Builder ingestionJobId(String ingestionJobId)

      The unique identifier of the ingestion job.

      Parameters:
      ingestionJobId - The unique identifier of the ingestion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      IngestionJobDetail.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the ingestion job.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the ingestion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collectionId

      IngestionJobDetail.Builder collectionId(String collectionId)

      The unique identifier of the collection that the ingestion job belongs to.

      Parameters:
      collectionId - The unique identifier of the collection that the ingestion job belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ingestionJobName

      IngestionJobDetail.Builder ingestionJobName(String ingestionJobName)

      The name of the ingestion job.

      Parameters:
      ingestionJobName - The name of the ingestion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexName

      IngestionJobDetail.Builder indexName(String indexName)

      The name of the index that documents are ingested into.

      Parameters:
      indexName - The name of the index that documents are ingested into.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureIndexName

      IngestionJobDetail.Builder failureIndexName(String failureIndexName)

      The name of the index where documents that fail to be ingested are recorded.

      Parameters:
      failureIndexName - The name of the index where documents that fail to be ingested are recorded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      IngestionJobDetail.Builder source(IngestionJobSource source)

      The Amazon S3 source that the ingestion job ingests data from.

      Parameters:
      source - The Amazon S3 source that the ingestion job ingests data from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      default IngestionJobDetail.Builder source(Consumer<IngestionJobSource.Builder> source)

      The Amazon S3 source that the ingestion job ingests data from.

      This is a convenience method that creates an instance of the IngestionJobSource.Builder avoiding the need to create one manually via IngestionJobSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(IngestionJobSource).

      Parameters:
      source - a consumer that will call methods on IngestionJobSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      IngestionJobDetail.Builder status(String status)

      The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.

      Parameters:
      status - The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      IngestionJobDetail.Builder status(IngestionJobStatus status)

      The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.

      Parameters:
      status - The current lifecycle status of the ingestion job. For example, CREATING, ACTIVE, COMPLETED, or CANCELLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      IngestionJobDetail.Builder state(String state)

      The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.

      Parameters:
      state - The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      IngestionJobDetail.Builder state(IngestionState state)

      The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.

      Parameters:
      state - The current processing state of the ingestion job. For example, SCANNING, INGESTION_IN_PROGRESS, or INGESTION_COMPLETE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statistics

      IngestionJobDetail.Builder statistics(IngestionStatistics statistics)

      Processing statistics for the ingestion job, such as the number of Amazon S3 objects discovered, ingested, and failed.

      Parameters:
      statistics - Processing statistics for the ingestion job, such as the number of Amazon S3 objects discovered, ingested, and failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      default IngestionJobDetail.Builder statistics(Consumer<IngestionStatistics.Builder> statistics)

      Processing statistics for the ingestion job, such as the number of Amazon S3 objects discovered, ingested, and failed.

      This is a convenience method that creates an instance of the IngestionStatistics.Builder avoiding the need to create one manually via IngestionStatistics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statistics(IngestionStatistics).

      Parameters:
      statistics - a consumer that will call methods on IngestionStatistics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revision

      IngestionJobDetail.Builder revision(Long revision)

      The revision number of the ingestion job.

      Parameters:
      revision - The revision number of the ingestion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      IngestionJobDetail.Builder createdAt(Instant createdAt)

      The date and time when the ingestion job was created.

      Parameters:
      createdAt - The date and time when the ingestion job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      IngestionJobDetail.Builder updatedAt(Instant updatedAt)

      The date and time when the ingestion job was last updated.

      Parameters:
      updatedAt - The date and time when the ingestion job was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReasons

      IngestionJobDetail.Builder failureReasons(Collection<IngestionFailureReason> failureReasons)

      The reasons that the ingestion job reached a terminal failure state, if applicable.

      Parameters:
      failureReasons - The reasons that the ingestion job reached a terminal failure state, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReasons

      IngestionJobDetail.Builder failureReasons(IngestionFailureReason... failureReasons)

      The reasons that the ingestion job reached a terminal failure state, if applicable.

      Parameters:
      failureReasons - The reasons that the ingestion job reached a terminal failure state, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReasons

      IngestionJobDetail.Builder failureReasons(Consumer<IngestionFailureReason.Builder>... failureReasons)

      The reasons that the ingestion job reached a terminal failure state, if applicable.

      This is a convenience method that creates an instance of the IngestionFailureReason.Builder avoiding the need to create one manually via IngestionFailureReason.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureReasons(List<IngestionFailureReason>).

      Parameters:
      failureReasons - a consumer that will call methods on IngestionFailureReason.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • activeAlerts

      IngestionJobDetail.Builder activeAlerts(Collection<IngestionAlert> activeAlerts)

      Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.

      Parameters:
      activeAlerts - Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeAlerts

      IngestionJobDetail.Builder activeAlerts(IngestionAlert... activeAlerts)

      Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.

      Parameters:
      activeAlerts - Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeAlerts

      IngestionJobDetail.Builder activeAlerts(Consumer<IngestionAlert.Builder>... activeAlerts)

      Active alerts about operational issues that currently affect the ingestion job. Alerts are cleared when the issue is resolved.

      This is a convenience method that creates an instance of the IngestionAlert.Builder avoiding the need to create one manually via IngestionAlert.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to activeAlerts(List<IngestionAlert>).

      Parameters:
      activeAlerts - a consumer that will call methods on IngestionAlert.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: