ServiceSoftwareOptions (AWS Java SDK for Amazon Elasticsearch Service 1.12.704 API)

java.lang.Object
- com.amazonaws.services.elasticsearch.model.ServiceSoftwareOptions

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The current options of an Elasticsearch domain service software options.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServiceSoftwareOptions()

Constructors
Constructor and Description
`ServiceSoftwareOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceSoftwareOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getAutomatedUpdateDate()` Timestamp, in Epoch time, until which you can manually request a service software update.
`Boolean`	`getCancellable()` `True` if you are able to cancel your service software version update.
`String`	`getCurrentVersion()` The current service software version that is present on the domain.
`String`	`getDescription()` The description of the `UpdateStatus`.
`String`	`getNewVersion()` The new service software version if one is available.
`Boolean`	`getOptionalDeployment()` `True` if a service software is never automatically updated.
`Boolean`	`getUpdateAvailable()` `True` if you are able to update you service software version.
`String`	`getUpdateStatus()` The status of your service software update.
`int`	`hashCode()`
`Boolean`	`isCancellable()` `True` if you are able to cancel your service software version update.
`Boolean`	`isOptionalDeployment()` `True` if a service software is never automatically updated.
`Boolean`	`isUpdateAvailable()` `True` if you are able to update you service software version.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAutomatedUpdateDate(Date automatedUpdateDate)` Timestamp, in Epoch time, until which you can manually request a service software update.
`void`	`setCancellable(Boolean cancellable)` `True` if you are able to cancel your service software version update.
`void`	`setCurrentVersion(String currentVersion)` The current service software version that is present on the domain.
`void`	`setDescription(String description)` The description of the `UpdateStatus`.
`void`	`setNewVersion(String newVersion)` The new service software version if one is available.
`void`	`setOptionalDeployment(Boolean optionalDeployment)` `True` if a service software is never automatically updated.
`void`	`setUpdateAvailable(Boolean updateAvailable)` `True` if you are able to update you service software version.
`void`	`setUpdateStatus(String updateStatus)` The status of your service software update.
`String`	`toString()` Returns a string representation of this object.
`ServiceSoftwareOptions`	`withAutomatedUpdateDate(Date automatedUpdateDate)` Timestamp, in Epoch time, until which you can manually request a service software update.
`ServiceSoftwareOptions`	`withCancellable(Boolean cancellable)` `True` if you are able to cancel your service software version update.
`ServiceSoftwareOptions`	`withCurrentVersion(String currentVersion)` The current service software version that is present on the domain.
`ServiceSoftwareOptions`	`withDescription(String description)` The description of the `UpdateStatus`.
`ServiceSoftwareOptions`	`withNewVersion(String newVersion)` The new service software version if one is available.
`ServiceSoftwareOptions`	`withOptionalDeployment(Boolean optionalDeployment)` `True` if a service software is never automatically updated.
`ServiceSoftwareOptions`	`withUpdateAvailable(Boolean updateAvailable)` `True` if you are able to update you service software version.
`ServiceSoftwareOptions`	`withUpdateStatus(DeploymentStatus updateStatus)` The status of your service software update.
`ServiceSoftwareOptions`	`withUpdateStatus(String updateStatus)` The status of your service software update.

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

- Constructor Detail
  - ServiceSoftwareOptions
```
public ServiceSoftwareOptions()
```
- Method Detail
  - setCurrentVersion
```
public void setCurrentVersion(String currentVersion)
```
    The current service software version that is present on the domain.
    
    Parameters:
    
    currentVersion - The current service software version that is present on the domain.
  - getCurrentVersion
```
public String getCurrentVersion()
```
    The current service software version that is present on the domain.
    
    Returns:
    
    The current service software version that is present on the domain.
  - withCurrentVersion
```
public ServiceSoftwareOptions withCurrentVersion(String currentVersion)
```
    The current service software version that is present on the domain.
    
    Parameters:
    
    currentVersion - The current service software version that is present on the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNewVersion
```
public void setNewVersion(String newVersion)
```
    The new service software version if one is available.
    
    Parameters:
    
    newVersion - The new service software version if one is available.
  - getNewVersion
```
public String getNewVersion()
```
    The new service software version if one is available.
    
    Returns:
    
    The new service software version if one is available.
  - withNewVersion
```
public ServiceSoftwareOptions withNewVersion(String newVersion)
```
    The new service software version if one is available.
    
    Parameters:
    
    newVersion - The new service software version if one is available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateAvailable
```
public void setUpdateAvailable(Boolean updateAvailable)
```
    True if you are able to update you service software version. False if you are not able to update your service software version.
    
    Parameters:
    
    updateAvailable - True if you are able to update you service software version. False
  - getUpdateAvailable public Boolean getUpdateAvailable() True if you are able to update you service software version. False if you are not able to update your service software version.
    Returns:
    True if you are able to update you service software version. False
  - withUpdateAvailable public ServiceSoftwareOptions withUpdateAvailable(Boolean updateAvailable) True if you are able to update you service software version. False if you are not able to update your service software version.
    Parameters:
    updateAvailable - True if you are able to update you service software version. False
    Returns: Returns a reference to this object so that method calls can be chained together.
  - isUpdateAvailable public Boolean isUpdateAvailable() True if you are able to update you service software version. False if you are not able to update your service software version.
    Returns:
    True if you are able to update you service software version. False
  - setCancellable public void setCancellable(Boolean cancellable) True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
    Parameters:
    cancellable - True if you are able to cancel your service software version update. False
  - getCancellable public Boolean getCancellable() True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
    Returns:
    True if you are able to cancel your service software version update. False
  - withCancellable public ServiceSoftwareOptions withCancellable(Boolean cancellable) True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
    Parameters:
    cancellable - True if you are able to cancel your service software version update. False
    Returns: Returns a reference to this object so that method calls can be chained together.
  - isCancellable public Boolean isCancellable() True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
    Returns:
    True if you are able to cancel your service software version update. False
  setUpdateStatus public void setUpdateStatus(String updateStatus) The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Parameters: updateStatus - The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. See Also: DeploymentStatus getUpdateStatus public String getUpdateStatus() The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Returns: The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. See Also: DeploymentStatus withUpdateStatus public ServiceSoftwareOptions withUpdateStatus(String updateStatus) The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Parameters: updateStatus - The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Returns: Returns a reference to this object so that method calls can be chained together. See Also: DeploymentStatus withUpdateStatus public ServiceSoftwareOptions withUpdateStatus(DeploymentStatus updateStatus) The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Parameters: updateStatus - The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. Returns: Returns a reference to this object so that method calls can be chained together. See Also: DeploymentStatus setDescription public void setDescription(String description) The description of the UpdateStatus. Parameters: description - The description of the UpdateStatus. getDescription public String getDescription() The description of the UpdateStatus. Returns: The description of the UpdateStatus. withDescription public ServiceSoftwareOptions withDescription(String description) The description of the UpdateStatus. Parameters: description - The description of the UpdateStatus. Returns: Returns a reference to this object so that method calls can be chained together. setAutomatedUpdateDate public void setAutomatedUpdateDate(Date automatedUpdateDate) Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. Parameters: automatedUpdateDate - Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. getAutomatedUpdateDate public Date getAutomatedUpdateDate() Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. Returns: Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. withAutomatedUpdateDate public ServiceSoftwareOptions withAutomatedUpdateDate(Date automatedUpdateDate) Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. Parameters: automatedUpdateDate - Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. Returns: Returns a reference to this object so that method calls can be chained together.
  - setOptionalDeployment public void setOptionalDeployment(Boolean optionalDeployment) True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
    Parameters:
    optionalDeployment - True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate
  - getOptionalDeployment public Boolean getOptionalDeployment() True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
    Returns:
    True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate
  - withOptionalDeployment public ServiceSoftwareOptions withOptionalDeployment(Boolean optionalDeployment) True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
    Parameters:
    optionalDeployment - True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate
    Returns: Returns a reference to this object so that method calls can be chained together.
  - isOptionalDeployment public Boolean isOptionalDeployment() True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
    Returns:
    True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate
  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 ServiceSoftwareOptions clone() Overrides: clone in class Object marshall public void marshall(ProtocolMarshaller protocolMarshaller) Specified by: marshall in interface StructuredPojo

Class ServiceSoftwareOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceSoftwareOptions

Method Detail

setCurrentVersion

getCurrentVersion

withCurrentVersion

setNewVersion

getNewVersion

withNewVersion

setUpdateAvailable

getUpdateAvailable

withUpdateAvailable

isUpdateAvailable

setCancellable

getCancellable

withCancellable

isCancellable

setUpdateStatus

getUpdateStatus

withUpdateStatus

withUpdateStatus

setDescription

getDescription

withDescription

setAutomatedUpdateDate

getAutomatedUpdateDate

withAutomatedUpdateDate

setOptionalDeployment

getOptionalDeployment

withOptionalDeployment

isOptionalDeployment

toString

equals

hashCode

clone

marshall