Package software.amazon.awssdk.services.opensearch.model

Interface UpgradeDomainRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpgradeDomainRequest

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

Method Summary

Modifier and Type	Method	Description
UpgradeDomainRequest.Builder	advancedOptions(Map<String,String> advancedOptions)	Only supports the override_main_response_version parameter and not other advanced options.
UpgradeDomainRequest.Builder	domainName(String domainName)	Name of the OpenSearch Service domain that you want to upgrade.
UpgradeDomainRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpgradeDomainRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpgradeDomainRequest.Builder	performCheckOnly(Boolean performCheckOnly)	When true, indicates that an upgrade eligibility check needs to be performed.
UpgradeDomainRequest.Builder	targetVersion(String targetVersion)	OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

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 Detail

domainName

UpgradeDomainRequest.Builder domainName(String domainName)

Name of the OpenSearch Service domain that you want to upgrade.

Parameters:

domainName - Name of the OpenSearch Service domain that you want to upgrade.

Returns:

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

targetVersion

UpgradeDomainRequest.Builder targetVersion(String targetVersion)

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

Parameters:

targetVersion - OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

Returns:

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

performCheckOnly

UpgradeDomainRequest.Builder performCheckOnly(Boolean performCheckOnly)

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

Parameters:

performCheckOnly - When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

Returns:

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

advancedOptions

UpgradeDomainRequest.Builder advancedOptions(Map<String,String> advancedOptions)

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Parameters:

advancedOptions - Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Returns:

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

overrideConfiguration

UpgradeDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpgradeDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder