Package software.amazon.awssdk.services.opensearch.model

Class ScheduledAction

java.lang.Object

software.amazon.awssdk.services.opensearch.model.ScheduledAction

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class ScheduledAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduledAction.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduledAction.Builder	builder()
Boolean	cancellable()	Whether or not the scheduled action is cancellable.
String	description()	A description of the action to be taken.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier of the scheduled action.
Boolean	mandatory()	Whether the action is required or optional.
ScheduledBy	scheduledBy()	Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
String	scheduledByAsString()	Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
Long	scheduledTime()	The time when the change is scheduled to happen.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduledAction.Builder>	serializableBuilderClass()
ActionSeverity	severity()	The severity of the action.
String	severityAsString()	The severity of the action.
ActionStatus	status()	The current status of the scheduled action.
String	statusAsString()	The current status of the scheduled action.
ScheduledAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ActionType	type()	The type of action that will be taken on the domain.
String	typeAsString()	The type of action that will be taken on the domain.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The unique identifier of the scheduled action.

Returns:

The unique identifier of the scheduled action.

type

public final ActionType type()

The type of action that will be taken on the domain.

If the service returns an enum value that is not available in the current SDK version, type will return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of action that will be taken on the domain.

See Also:

ActionType

typeAsString

public final String typeAsString()

The type of action that will be taken on the domain.

If the service returns an enum value that is not available in the current SDK version, type will return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of action that will be taken on the domain.

See Also:

ActionType

severity

public final ActionSeverity severity()

The severity of the action.

If the service returns an enum value that is not available in the current SDK version, severity will return ActionSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

The severity of the action.

See Also:

ActionSeverity

severityAsString

public final String severityAsString()

The severity of the action.

If the service returns an enum value that is not available in the current SDK version, severity will return ActionSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

The severity of the action.

See Also:

ActionSeverity

scheduledTime

public final Long scheduledTime()

The time when the change is scheduled to happen.

Returns:

The time when the change is scheduled to happen.

description

public final String description()

A description of the action to be taken.

Returns:

A description of the action to be taken.

scheduledBy

public final ScheduledBy scheduledBy()

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).

If the service returns an enum value that is not available in the current SDK version, scheduledBy will return ScheduledBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduledByAsString().

Returns:

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

See Also:

ScheduledBy

scheduledByAsString

public final String scheduledByAsString()

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).

If the service returns an enum value that is not available in the current SDK version, scheduledBy will return ScheduledBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduledByAsString().

Returns:

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

See Also:

ScheduledBy

status

public final ActionStatus status()

The current status of the scheduled action.

If the service returns an enum value that is not available in the current SDK version, status will return ActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the scheduled action.

See Also:

ActionStatus

statusAsString

public final String statusAsString()

The current status of the scheduled action.

If the service returns an enum value that is not available in the current SDK version, status will return ActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the scheduled action.

See Also:

ActionStatus

mandatory

public final Boolean mandatory()

Whether the action is required or optional.

Returns:

Whether the action is required or optional.

cancellable

public final Boolean cancellable()

Whether or not the scheduled action is cancellable.

Returns:

Whether or not the scheduled action is cancellable.

toBuilder

public ScheduledAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>

builder

public static ScheduledAction.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo