Interface IngestionStreamDetail.Builder

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

  • Method Details

    • ingestionStreamId

      IngestionStreamDetail.Builder ingestionStreamId(String ingestionStreamId)

      The unique identifier of the ingestion stream.

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

    • arn

      IngestionStreamDetail.Builder arn(String arn)

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

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

    • collectionId

      IngestionStreamDetail.Builder collectionId(String collectionId)

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

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

    • ingestionStreamName

      IngestionStreamDetail.Builder ingestionStreamName(String ingestionStreamName)

      The name of the ingestion stream.

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

    • indexName

      IngestionStreamDetail.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

      IngestionStreamDetail.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

      IngestionStreamDetail.Builder source(IngestionStreamSource source)

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

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

    • source

      default IngestionStreamDetail.Builder source(Consumer<IngestionStreamSource.Builder> source)

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

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

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

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

    • roleArn

      IngestionStreamDetail.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      IngestionStreamDetail.Builder status(String status)

      The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE , or DELETING.

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

    • status

      IngestionStreamDetail.Builder status(IngestionStreamStatus status)

      The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE , or DELETING.

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

    • state

      IngestionStreamDetail.Builder state(String state)

      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.

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

    • state

      IngestionStreamDetail.Builder state(IngestionState state)

      The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.

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

    • statistics

      IngestionStreamDetail.Builder statistics(IngestionStatistics statistics)

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

      Parameters:
      statistics - Processing statistics for the ingestion stream, 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 IngestionStreamDetail.Builder statistics(Consumer<IngestionStatistics.Builder> statistics)

      Processing statistics for the ingestion stream, 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

      IngestionStreamDetail.Builder revision(Long revision)

      The revision number of the ingestion stream.

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

    • createdAt

      IngestionStreamDetail.Builder createdAt(Instant createdAt)

      The date and time when the ingestion stream was created.

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

    • updatedAt

      IngestionStreamDetail.Builder updatedAt(Instant updatedAt)

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

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

    • failureReasons

      IngestionStreamDetail.Builder failureReasons(Collection<IngestionFailureReason> failureReasons)

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

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

    • failureReasons

      IngestionStreamDetail.Builder failureReasons(IngestionFailureReason... failureReasons)

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

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

    • failureReasons

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

      The reasons that the ingestion stream 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

      IngestionStreamDetail.Builder activeAlerts(Collection<IngestionAlert> activeAlerts)

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

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

    • activeAlerts

      IngestionStreamDetail.Builder activeAlerts(IngestionAlert... activeAlerts)

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

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

    • activeAlerts

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

      Active alerts about operational issues that currently affect the ingestion stream. 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: