Class StartServiceSoftwareUpdateRequest

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.StartServiceSoftwareUpdateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartServiceSoftwareUpdateRequest extends OpenSearchRequest implements ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>

Container for the request parameters to the StartServiceSoftwareUpdate operation.

  • Method Details

    • domainName

      public final String domainName()

      The name of the domain that you want to update to the latest service software.

      Returns:
      The name of the domain that you want to update to the latest service software.

    • scheduleAt

      public final ScheduleAt scheduleAt()

      When to start the service software update.

      • 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

      Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

      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 start the service software update.

      • 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

      Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

      See Also:

    • scheduleAtAsString

      public final String scheduleAtAsString()

      When to start the service software update.

      • 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

      Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

      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 start the service software update.

      • 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

      Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

      See Also:

    • desiredStartTime

      public final Long desiredStartTime()

      The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

      Returns:
      The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

    • toBuilder

      public StartServiceSoftwareUpdateRequest.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<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>
      Specified by:
      toBuilder in class OpenSearchRequest
      Returns:
      a builder for type T

    • builder

      public static StartServiceSoftwareUpdateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartServiceSoftwareUpdateRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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