Class MaintenanceWindow

java.lang.Object
software.amazon.awssdk.services.workspacesthinclient.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>

Describes the maintenance window for a thin client device.

See Also:

  • Method Details

    • type

      public final MaintenanceWindowType type()

      An option to select the default or custom maintenance window.

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

      Returns:
      An option to select the default or custom maintenance window.
      See Also:

    • typeAsString

      public final String typeAsString()

      An option to select the default or custom maintenance window.

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

      Returns:
      An option to select the default or custom maintenance window.
      See Also:

    • startTimeHour

      public final Integer startTimeHour()

      The hour for the maintenance window start (00-23).

      Returns:
      The hour for the maintenance window start (00-23).

    • startTimeMinute

      public final Integer startTimeMinute()

      The minutes past the hour for the maintenance window start (00-59).

      Returns:
      The minutes past the hour for the maintenance window start (00-59).

    • endTimeHour

      public final Integer endTimeHour()

      The hour for the maintenance window end (00-23).

      Returns:
      The hour for the maintenance window end (00-23).

    • endTimeMinute

      public final Integer endTimeMinute()

      The minutes for the maintenance window end (00-59).

      Returns:
      The minutes for the maintenance window end (00-59).

    • daysOfTheWeek

      public final List<DayOfWeek> daysOfTheWeek()

      The days of the week during which the maintenance window is open.

      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 hasDaysOfTheWeek() method.

      Returns:
      The days of the week during which the maintenance window is open.

    • hasDaysOfTheWeek

      public final boolean hasDaysOfTheWeek()
      For responses, this returns true if the service returned a value for the DaysOfTheWeek 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.

    • daysOfTheWeekAsStrings

      public final List<String> daysOfTheWeekAsStrings()

      The days of the week during which the maintenance window is open.

      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 hasDaysOfTheWeek() method.

      Returns:
      The days of the week during which the maintenance window is open.

    • applyTimeOf

      public final ApplyTimeOf applyTimeOf()

      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

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

      Returns:
      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
      See Also:

    • applyTimeOfAsString

      public final String applyTimeOfAsString()

      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

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

      Returns:
      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
      See Also:

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