com.amazonaws.services.opensearch.model

Class UpgradeDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearch.model.UpgradeDomainRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpgradeDomainRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the request parameters to UpgradeDomain operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpgradeDomainRequest()

Method Summary

Modifier and Type	Method and Description
UpgradeDomainRequest	addAdvancedOptionsEntry(String key, String value) Add a single AdvancedOptions entry
UpgradeDomainRequest	clearAdvancedOptionsEntries() Removes all the entries added into AdvancedOptions.
UpgradeDomainRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAdvancedOptions()
String	getDomainName()
Boolean	getPerformCheckOnly() When true, indicates that an upgrade eligibility check needs to be performed.
String	getTargetVersion() The version of OpenSearch you intend to upgrade the domain to.
int	hashCode()
Boolean	isPerformCheckOnly() When true, indicates that an upgrade eligibility check needs to be performed.
void	setAdvancedOptions(Map<String,String> advancedOptions)
void	setDomainName(String domainName)
void	setPerformCheckOnly(Boolean performCheckOnly) When true, indicates that an upgrade eligibility check needs to be performed.
void	setTargetVersion(String targetVersion) The version of OpenSearch you intend to upgrade the domain to.
String	toString() Returns a string representation of this object.
UpgradeDomainRequest	withAdvancedOptions(Map<String,String> advancedOptions)
UpgradeDomainRequest	withDomainName(String domainName)
UpgradeDomainRequest	withPerformCheckOnly(Boolean performCheckOnly) When true, indicates that an upgrade eligibility check needs to be performed.
UpgradeDomainRequest	withTargetVersion(String targetVersion) The version of OpenSearch you intend to upgrade the domain to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpgradeDomainRequest

public UpgradeDomainRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

Parameters:

domainName -

getDomainName

public String getDomainName()

Returns:

withDomainName

public UpgradeDomainRequest withDomainName(String domainName)

Parameters:

domainName -

Returns:

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

setTargetVersion

public void setTargetVersion(String targetVersion)

The version of OpenSearch you intend to upgrade the domain to.

Parameters:

targetVersion - The version of OpenSearch you intend to upgrade the domain to.

getTargetVersion

public String getTargetVersion()

The version of OpenSearch you intend to upgrade the domain to.

Returns:

The version of OpenSearch you intend to upgrade the domain to.

withTargetVersion

public UpgradeDomainRequest withTargetVersion(String targetVersion)

The version of OpenSearch you intend to upgrade the domain to.

Parameters:

targetVersion - The version of OpenSearch you intend to upgrade the domain to.

Returns:

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

setPerformCheckOnly

public void setPerformCheckOnly(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.

getPerformCheckOnly

public Boolean getPerformCheckOnly()

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.

withPerformCheckOnly

public UpgradeDomainRequest withPerformCheckOnly(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.

isPerformCheckOnly

public Boolean isPerformCheckOnly()

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.

getAdvancedOptions

public Map<String,String> getAdvancedOptions()

Returns:

setAdvancedOptions

public void setAdvancedOptions(Map<String,String> advancedOptions)

Parameters:

advancedOptions -

withAdvancedOptions

public UpgradeDomainRequest withAdvancedOptions(Map<String,String> advancedOptions)

Parameters:

advancedOptions -

Returns:

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

addAdvancedOptionsEntry

public UpgradeDomainRequest addAdvancedOptionsEntry(String key,
                                                    String value)

Add a single AdvancedOptions entry

See Also:

withAdvancedOptions(java.util.Map<java.lang.String, java.lang.String>)

clearAdvancedOptionsEntries

public UpgradeDomainRequest clearAdvancedOptionsEntries()

Removes all the entries added into AdvancedOptions.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpgradeDomainRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()