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

Class UpgradeDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.UpgradeDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpgradeDomainRequest.Builder,UpgradeDomainRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpgradeDomainRequest
extends OpenSearchRequest
implements ToCopyableBuilder<UpgradeDomainRequest.Builder,UpgradeDomainRequest>

Container for the request parameters to the UpgradeDomain operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpgradeDomainRequest.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	advancedOptions()	Only supports the override_main_response_version parameter and not other advanced options.
static UpgradeDomainRequest.Builder	builder()
String	domainName()	Name of the OpenSearch Service domain that you want to upgrade.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdvancedOptions()	For responses, this returns true if the service returned a value for the AdvancedOptions property.
int	hashCode()
Boolean	performCheckOnly()	When true, indicates that an upgrade eligibility check needs to be performed.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpgradeDomainRequest.Builder>	serializableBuilderClass()
String	targetVersion()	OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
UpgradeDomainRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domainName

public final String domainName()

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

Returns:

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

targetVersion

public final String targetVersion()

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

Returns:

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

performCheckOnly

public final Boolean performCheckOnly()

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

Returns:

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

hasAdvancedOptions

public final boolean hasAdvancedOptions()

For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

advancedOptions

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.

Returns:

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.

toBuilder

public UpgradeDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpgradeDomainRequest.Builder,UpgradeDomainRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static UpgradeDomainRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpgradeDomainRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo