Class MaintenanceWindow

java.lang.Object
software.amazon.awssdk.services.odb.model.MaintenanceWindow
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MaintenanceWindow.Builder,MaintenanceWindow>
@Generated("software.amazon.awssdk:codegen") public final class MaintenanceWindow extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MaintenanceWindow.Builder,MaintenanceWindow>

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

See Also:

  • Method Details

    • customActionTimeoutInMins

      public final Integer customActionTimeoutInMins()

      The custom action timeout in minutes for the maintenance window.

      Returns:
      The custom action timeout in minutes for the maintenance window.

    • hasDaysOfWeek

      public final boolean hasDaysOfWeek()
      For responses, this returns true if the service returned a value for the DaysOfWeek property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • daysOfWeek

      public final List<DayOfWeek> daysOfWeek()

      The days of the week when maintenance can be performed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDaysOfWeek() method.

      Returns:
      The days of the week when maintenance can be performed.

    • hasHoursOfDay

      public final boolean hasHoursOfDay()
      For responses, this returns true if the service returned a value for the HoursOfDay property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • hoursOfDay

      public final List<Integer> hoursOfDay()

      The hours of the day when maintenance can be performed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHoursOfDay() method.

      Returns:
      The hours of the day when maintenance can be performed.

    • isCustomActionTimeoutEnabled

      public final Boolean isCustomActionTimeoutEnabled()

      Indicates whether custom action timeout is enabled for the maintenance window.

      Returns:
      Indicates whether custom action timeout is enabled for the maintenance window.

    • leadTimeInWeeks

      public final Integer leadTimeInWeeks()

      The lead time in weeks before the maintenance window.

      Returns:
      The lead time in weeks before the maintenance window.

    • hasMonths

      public final boolean hasMonths()
      For responses, this returns true if the service returned a value for the Months property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • months

      public final List<Month> months()

      The months when maintenance can be performed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMonths() method.

      Returns:
      The months when maintenance can be performed.

    • patchingMode

      public final PatchingModeType patchingMode()

      The patching mode for the maintenance window.

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

      Returns:
      The patching mode for the maintenance window.
      See Also:

    • patchingModeAsString

      public final String patchingModeAsString()

      The patching mode for the maintenance window.

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

      Returns:
      The patching mode for the maintenance window.
      See Also:

    • preference

      public final PreferenceType preference()

      The preference for the maintenance window scheduling.

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

      Returns:
      The preference for the maintenance window scheduling.
      See Also:

    • preferenceAsString

      public final String preferenceAsString()

      The preference for the maintenance window scheduling.

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

      Returns:
      The preference for the maintenance window scheduling.
      See Also:

    • skipRu

      public final Boolean skipRu()

      Indicates whether to skip release updates during maintenance.

      Returns:
      Indicates whether to skip release updates during maintenance.

    • hasWeeksOfMonth

      public final boolean hasWeeksOfMonth()
      For responses, this returns true if the service returned a value for the WeeksOfMonth property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • weeksOfMonth

      public final List<Integer> weeksOfMonth()

      The weeks of the month when maintenance can be performed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWeeksOfMonth() method.

      Returns:
      The weeks of the month when maintenance can be performed.

    • toBuilder

      public MaintenanceWindow.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<MaintenanceWindow.Builder,MaintenanceWindow>
      Returns:
      a builder for type T

    • builder

      public static MaintenanceWindow.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MaintenanceWindow.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.