UpgradeDomainResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.opensearch.model.UpgradeDomainResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpgradeDomainResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Container for response returned by UpgradeDomain operation.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpgradeDomainResult()

Constructors
Constructor and Description
`UpgradeDomainResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpgradeDomainResult`	`addAdvancedOptionsEntry(String key, String value)` Add a single AdvancedOptions entry
`UpgradeDomainResult`	`clearAdvancedOptionsEntries()` Removes all the entries added into AdvancedOptions.
`UpgradeDomainResult`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAdvancedOptions()`
`ChangeProgressDetails`	`getChangeProgressDetails()`
`String`	`getDomainName()`
`Boolean`	`getPerformCheckOnly()` When true, indicates that an upgrade eligibility check needs to be performed.
`String`	`getTargetVersion()` The version of OpenSearch that you intend to upgrade the domain to.
`String`	`getUpgradeId()`
`int`	`hashCode()`
`Boolean`	`isPerformCheckOnly()` When true, indicates that an upgrade eligibility check needs to be performed.
`void`	`setAdvancedOptions(Map<String,String> advancedOptions)`
`void`	`setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)`
`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 that you intend to upgrade the domain to.
`void`	`setUpgradeId(String upgradeId)`
`String`	`toString()` Returns a string representation of this object.
`UpgradeDomainResult`	`withAdvancedOptions(Map<String,String> advancedOptions)`
`UpgradeDomainResult`	`withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)`
`UpgradeDomainResult`	`withDomainName(String domainName)`
`UpgradeDomainResult`	`withPerformCheckOnly(Boolean performCheckOnly)` When true, indicates that an upgrade eligibility check needs to be performed.
`UpgradeDomainResult`	`withTargetVersion(String targetVersion)` The version of OpenSearch that you intend to upgrade the domain to.
`UpgradeDomainResult`	`withUpgradeId(String upgradeId)`

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpgradeDomainResult
```
public UpgradeDomainResult()
```
- Method Detail
  - setUpgradeId
```
public void setUpgradeId(String upgradeId)
```
    Parameters:
    
    upgradeId -
  - getUpgradeId
```
public String getUpgradeId()
```
    Returns:
  - withUpgradeId
```
public UpgradeDomainResult withUpgradeId(String upgradeId)
```
    Parameters:
    
    upgradeId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomainName
```
public void setDomainName(String domainName)
```
    Parameters:
    
    domainName -
  - getDomainName
```
public String getDomainName()
```
    Returns:
  - withDomainName
```
public UpgradeDomainResult 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 that you intend to upgrade the domain to.
    
    Parameters:
    
    targetVersion - The version of OpenSearch that you intend to upgrade the domain to.
  - getTargetVersion
```
public String getTargetVersion()
```
    The version of OpenSearch that you intend to upgrade the domain to.
    
    Returns:
    
    The version of OpenSearch that you intend to upgrade the domain to.
  - withTargetVersion
```
public UpgradeDomainResult withTargetVersion(String targetVersion)
```
    The version of OpenSearch that you intend to upgrade the domain to.
    
    Parameters:
    
    targetVersion - The version of OpenSearch that 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 UpgradeDomainResult 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 UpgradeDomainResult withAdvancedOptions(Map<String,String> advancedOptions)
```
    Parameters:
    
    advancedOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAdvancedOptionsEntry
```
public UpgradeDomainResult addAdvancedOptionsEntry(String key,
                                                   String value)
```
    Add a single AdvancedOptions entry
    
    See Also:
    
    withAdvancedOptions(java.util.Map<java.lang.String, java.lang.String>)
  - clearAdvancedOptionsEntries
```
public UpgradeDomainResult clearAdvancedOptionsEntries()
```
    Removes all the entries added into AdvancedOptions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChangeProgressDetails
```
public void setChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
```
    Parameters:
    
    changeProgressDetails -
  - getChangeProgressDetails
```
public ChangeProgressDetails getChangeProgressDetails()
```
    Returns:
  - withChangeProgressDetails
```
public UpgradeDomainResult withChangeProgressDetails(ChangeProgressDetails changeProgressDetails)
```
    Parameters:
    
    changeProgressDetails -
    
    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 UpgradeDomainResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class UpgradeDomainResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

UpgradeDomainResult

Method Detail

setUpgradeId

getUpgradeId

withUpgradeId

setDomainName

getDomainName

withDomainName

setTargetVersion

getTargetVersion

withTargetVersion

setPerformCheckOnly

getPerformCheckOnly

withPerformCheckOnly

isPerformCheckOnly

getAdvancedOptions

setAdvancedOptions

withAdvancedOptions

addAdvancedOptionsEntry

clearAdvancedOptionsEntries

setChangeProgressDetails

getChangeProgressDetails

withChangeProgressDetails

toString

equals

hashCode

clone