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

Class UpdateScheduledActionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearch.model.OpenSearchRequest
software.amazon.awssdk.services.opensearch.model.UpdateScheduledActionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateScheduledActionRequest.Builder,UpdateScheduledActionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateScheduledActionRequest extends OpenSearchRequest implements ToCopyableBuilder<UpdateScheduledActionRequest.Builder,UpdateScheduledActionRequest>

  • Method Details

    • domainName

      public final String domainName()

      The name of the domain to reschedule an action for.

      Returns:
      The name of the domain to reschedule an action for.

    • actionID

      public final String actionID()

      The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

      Returns:
      The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

    • actionType

      public final ActionType actionType()

      The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

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

      Returns:
      The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.
      See Also:

    • actionTypeAsString

      public final String actionTypeAsString()

      The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

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

      Returns:
      The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.
      See Also:

    • scheduleAt

      public final ScheduleAt scheduleAt()

      When to schedule the action.

      • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

      • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

      • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

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

      Returns:
      When to schedule the action.

      • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

      • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

      • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

      See Also:

    • scheduleAtAsString

      public final String scheduleAtAsString()

      When to schedule the action.

      • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

      • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

      • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

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

      Returns:
      When to schedule the action.

      • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

      • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

      • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

      See Also:

    • desiredStartTime

      public final Long desiredStartTime()

      The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

      Returns:
      The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

    • toBuilder

      public UpdateScheduledActionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateScheduledActionRequest.Builder,UpdateScheduledActionRequest>
      Specified by:
      toBuilder in class OpenSearchRequest

    • builder

      public static UpdateScheduledActionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • 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