Interface CreateIngestionJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateIngestionJobRequest.Builder,CreateIngestionJobRequest>, OpenSearchServerlessRequest.Builder, SdkBuilder<CreateIngestionJobRequest.Builder,CreateIngestionJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIngestionJobRequest

@Mutable
@NotThreadSafe
public static interface CreateIngestionJobRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateIngestionJobRequest.Builder,CreateIngestionJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateIngestionJobRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
CreateIngestionJobRequest.Builder	collectionId(String collectionId)	The unique identifier of the collection to ingest data into.
CreateIngestionJobRequest.Builder	failureIndexName(String failureIndexName)	The name of the index where documents that fail to be ingested are recorded.
CreateIngestionJobRequest.Builder	indexName(String indexName)	The name of the index to ingest documents into.
CreateIngestionJobRequest.Builder	ingestionJobName(String ingestionJobName)	The name of the ingestion job.
CreateIngestionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateIngestionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateIngestionJobRequest.Builder	source(Consumer<IngestionJobSource.Builder> source)	The Amazon S3 source to ingest data from.
CreateIngestionJobRequest.Builder	source(IngestionJobSource source)	The Amazon S3 source to ingest data from.
CreateIngestionJobRequest.Builder	tags(Collection<Tag> tags)	An arbitrary set of tags (key–value pairs) to associate with the ingestion job.
CreateIngestionJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An arbitrary set of tags (key–value pairs) to associate with the ingestion job.
CreateIngestionJobRequest.Builder	tags(Tag... tags)	An arbitrary set of tags (key–value pairs) to associate with the ingestion job.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

collectionId

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

ingestionJobName

CreateIngestionJobRequest.Builder ingestionJobName(String ingestionJobName)

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

Parameters:

ingestionJobName - The name of the ingestion job. The name must be unique within the collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexName

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

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

CreateIngestionJobRequest.Builder source(IngestionJobSource source)

The Amazon S3 source to ingest data from.

Parameters:

source - The Amazon S3 source to ingest data from.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

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

The Amazon S3 source to ingest 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:

• source(IngestionJobSource)

tags

CreateIngestionJobRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateIngestionJobRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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

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

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:

• tags(java.util.Collection<Tag>)

clientToken

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

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

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