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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<ScheduledAction.Builder,ScheduledAction>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.