Class MaintenanceWindow

    • Method Detail

      • 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:
        MaintenanceWindowType
      • 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:
        ApplyTimeOf
      • 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:
        ApplyTimeOf
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)