Interface UpgradeDomainRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpgradeDomainRequest.Builder,
,UpgradeDomainRequest> OpenSearchRequest.Builder
,SdkBuilder<UpgradeDomainRequest.Builder,
,UpgradeDomainRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpgradeDomainRequest
public static interface UpgradeDomainRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<UpgradeDomainRequest.Builder,UpgradeDomainRequest>
-
Method Summary
Modifier and TypeMethodDescriptionadvancedOptions
(Map<String, String> advancedOptions) Only supports theoverride_main_response_version
parameter and not other advanced options.domainName
(String domainName) Name of the OpenSearch Service domain that you want to upgrade.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.performCheckOnly
(Boolean performCheckOnly) When true, indicates that an upgrade eligibility check needs to be performed.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, sdkFields
-
Method Details
-
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
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
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
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 theoverride_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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpgradeDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-