Interface StartMigrationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartMigrationRequest.Builder,StartMigrationRequest>, OpenSearchRequest.Builder, SdkBuilder<StartMigrationRequest.Builder,StartMigrationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartMigrationRequest

@Mutable
@NotThreadSafe
public static interface StartMigrationRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<StartMigrationRequest.Builder,StartMigrationRequest>

Method Summary

Modifier and Type	Method	Description
StartMigrationRequest.Builder	applicationId(String applicationId)	The unique identifier of the OpenSearch application to migrate saved objects into.
StartMigrationRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the operation completes no more than one time.
default StartMigrationRequest.Builder	migrationOptions(Consumer<MigrationOptions.Builder> migrationOptions)	The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.
StartMigrationRequest.Builder	migrationOptions(MigrationOptions migrationOptions)	The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.
StartMigrationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartMigrationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.opensearch.model.OpenSearchRequest.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

applicationId

StartMigrationRequest.Builder applicationId(String applicationId)

The unique identifier of the OpenSearch application to migrate saved objects into.

Parameters:

applicationId - The unique identifier of the OpenSearch application to migrate saved objects into.

Returns:

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

migrationOptions

StartMigrationRequest.Builder migrationOptions(MigrationOptions migrationOptions)

The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

Parameters:

migrationOptions - The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

Returns:

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

migrationOptions

default StartMigrationRequest.Builder migrationOptions(Consumer<MigrationOptions.Builder> migrationOptions)

The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

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

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

Parameters:

migrationOptions - a consumer that will call methods on MigrationOptions.Builder

Returns:

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

See Also:

• migrationOptions(MigrationOptions)

clientToken

StartMigrationRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon OpenSearch Service ignores the request but does not return an error.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon OpenSearch Service ignores the request but does not return an error.

Returns:

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

overrideConfiguration

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

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