software.amazon.awssdk.services.elasticsearch.model

Class ServiceSoftwareOptions

java.lang.Object

software.amazon.awssdk.services.elasticsearch.model.ServiceSoftwareOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceSoftwareOptions.Builder,ServiceSoftwareOptions>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceSoftwareOptions.Builder

Method Summary

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	newVersion() The new service software version if one is available.
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceSoftwareOptions.Builder>	serializableBuilderClass()
ServiceSoftwareOptions.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

currentVersion

public String currentVersion()

The current service software version that is present on the domain.

Returns:

The current service software version that is present on the domain.

newVersion

public String newVersion()

The new service software version if one is available.

Returns:

The new service software version if one is available.

updateAvailable

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

Returns:

True if you are able to update you service software version. False

cancellable

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

Returns:

True if you are able to cancel your service software version update. False

updateStatus

public 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().

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

updateStatusAsString

public 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().

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

description

public String description()

The description of the UpdateStatus.

Returns:

The description of the UpdateStatus.

automatedUpdateDate

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

Returns:

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

toBuilder

public ServiceSoftwareOptions.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceSoftwareOptions.Builder,ServiceSoftwareOptions>

Returns:

a builder for type T

builder

public static ServiceSoftwareOptions.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.