@Generated(value="software.amazon.awssdk:codegen") public final class ServiceSoftwareOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceSoftwareOptions.Builder,ServiceSoftwareOptions>
The current options of an Elasticsearch domain service software options.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ServiceSoftwareOptions.Builder |
| Modifier and Type | Method and Description |
|---|---|
Instant |
automatedUpdateDate()
Timestamp, in Epoch time, until which you can manually request a service software update.
|
static ServiceSoftwareOptions.Builder |
builder() |
Boolean |
cancellable()
True if you are able to cancel your service software version update. |
String |
currentVersion()
The current service software version that is present on the domain.
|
String |
description()
The description of the
UpdateStatus. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
newVersion()
The new service software version if one is available.
|
Boolean |
optionalDeployment()
True if a service software is never automatically updated. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ServiceSoftwareOptions.Builder> |
serializableBuilderClass() |
ServiceSoftwareOptions.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
updateAvailable()
True if you are able to update you service software version. |
DeploymentStatus |
updateStatus()
The status of your service software update.
|
String |
updateStatusAsString()
The status of your service software update.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String currentVersion()
The current service software version that is present on the domain.
public final String newVersion()
The new service software version if one is available.
public final 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.
Falsepublic final 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.
Falsepublic final 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.
If the service returns an enum value that is not available in the current SDK version, updateStatus will
return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
updateStatusAsString().
ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and
NOT_ELIGIBLE.DeploymentStatuspublic final String updateStatusAsString()
The status of your service software update. This field can take the following values: ELIGIBLE,
PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
If the service returns an enum value that is not available in the current SDK version, updateStatus will
return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
updateStatusAsString().
ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and
NOT_ELIGIBLE.DeploymentStatuspublic final String description()
The description of the UpdateStatus.
UpdateStatus.public final Instant automatedUpdateDate()
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
public final Boolean optionalDeployment()
True if a service software is never automatically updated. False if a service software
is automatically updated after AutomatedUpdateDate.
False if a service
software is automatically updated after AutomatedUpdateDatepublic ServiceSoftwareOptions.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ServiceSoftwareOptions.Builder,ServiceSoftwareOptions>public static ServiceSoftwareOptions.Builder builder()
public static Class<? extends ServiceSoftwareOptions.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2022. All rights reserved.