Interface CreateIngestionStreamRequest.Builder

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

  • Method Details

    • collectionId

      CreateIngestionStreamRequest.Builder collectionId(String collectionId)

      The unique identifier of the collection to ingest data into.

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

    • ingestionStreamName

      CreateIngestionStreamRequest.Builder ingestionStreamName(String ingestionStreamName)

      The name of the ingestion stream. The name must be unique within the collection.

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

    • indexName

      CreateIngestionStreamRequest.Builder indexName(String indexName)

      The name of the index to ingest documents into.

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

    • failureIndexName

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

      CreateIngestionStreamRequest.Builder source(IngestionStreamSource source)

      The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.

      Parameters:
      source - The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

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

      The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.

      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

      CreateIngestionStreamRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source. The role must be in the same account as the collection.

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

    • tags

      CreateIngestionStreamRequest.Builder tags(Collection<Tag> tags)

      An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

      Parameters:
      tags - An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateIngestionStreamRequest.Builder tags(Tag... tags)

      An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

      Parameters:
      tags - An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateIngestionStreamRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

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

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

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

    • clientToken

      CreateIngestionStreamRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier to ensure idempotency of the request.

      Parameters:
      clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateIngestionStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateIngestionStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.