Class IosUpdateConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class IosUpdateConfiguration
    extends DeviceConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “IOS Update Configuration, allows you to configure time window within week to install iOS updates”
    • Field Detail

      • activeHoursEnd

        protected LocalTime activeHoursEnd
      • activeHoursStart

        protected LocalTime activeHoursStart
      • customUpdateTimeWindowsNextLink

        protected String customUpdateTimeWindowsNextLink
      • desiredOsVersion

        protected String desiredOsVersion
      • enforcedSoftwareUpdateDelayInDays

        protected Integer enforcedSoftwareUpdateDelayInDays
      • isEnabled

        protected Boolean isEnabled
      • scheduledInstallDays

        protected List<DayOfWeek> scheduledInstallDays
      • scheduledInstallDaysNextLink

        protected String scheduledInstallDaysNextLink
      • utcTimeOffsetInMinutes

        protected Integer utcTimeOffsetInMinutes
    • Constructor Detail

      • IosUpdateConfiguration

        protected IosUpdateConfiguration()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class DeviceConfiguration
      • builderIosUpdateConfiguration

        public static IosUpdateConfiguration.Builder builderIosUpdateConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class DeviceConfiguration
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class DeviceConfiguration
      • getActiveHoursEnd

        public Optional<LocalTime> getActiveHoursEnd()
        “Active Hours End (active hours mean the time window when updates install should not happen)”
        Returns:
        property activeHoursEnd
      • withActiveHoursEnd

        public IosUpdateConfiguration withActiveHoursEnd​(LocalTime activeHoursEnd)
        Returns an immutable copy of this with just the activeHoursEnd field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Active Hours End (active hours mean the time window when updates install should not happen)”

        Parameters:
        activeHoursEnd - new value of activeHoursEnd field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activeHoursEnd field changed
      • getActiveHoursStart

        public Optional<LocalTime> getActiveHoursStart()
        “Active Hours Start (active hours mean the time window when updates install should not happen)”
        Returns:
        property activeHoursStart
      • withActiveHoursStart

        public IosUpdateConfiguration withActiveHoursStart​(LocalTime activeHoursStart)
        Returns an immutable copy of this with just the activeHoursStart field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Active Hours Start (active hours mean the time window when updates install should not happen)”

        Parameters:
        activeHoursStart - new value of activeHoursStart field (as defined in service metadata)
        Returns:
        immutable copy of this with just the activeHoursStart field changed
      • getCustomUpdateTimeWindows

        public com.github.davidmoten.odata.client.CollectionPage<CustomUpdateTimeWindow> getCustomUpdateTimeWindows()
        “If update schedule type is set to use time window scheduling, custom time windows when updates will be scheduled. This collection can contain a maximum of 20 elements.”
        Returns:
        property customUpdateTimeWindows
      • withCustomUpdateTimeWindows

        public IosUpdateConfiguration withCustomUpdateTimeWindows​(List<CustomUpdateTimeWindow> customUpdateTimeWindows)
        Returns an immutable copy of this with just the customUpdateTimeWindows field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If update schedule type is set to use time window scheduling, custom time windows when updates will be scheduled. This collection can contain a maximum of 20 elements.”

        Parameters:
        customUpdateTimeWindows - new value of customUpdateTimeWindows field (as defined in service metadata)
        Returns:
        immutable copy of this with just the customUpdateTimeWindows field changed
      • getCustomUpdateTimeWindows

        public com.github.davidmoten.odata.client.CollectionPage<CustomUpdateTimeWindow> getCustomUpdateTimeWindows​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “If update schedule type is set to use time window scheduling, custom time windows when updates will be scheduled. This collection can contain a maximum of 20 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property customUpdateTimeWindows
      • getDesiredOsVersion

        public Optional<String> getDesiredOsVersion()
        “If left unspecified, devices will update to the latest version of the OS.”
        Returns:
        property desiredOsVersion
      • withDesiredOsVersion

        public IosUpdateConfiguration withDesiredOsVersion​(String desiredOsVersion)
        Returns an immutable copy of this with just the desiredOsVersion field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “If left unspecified, devices will update to the latest version of the OS.”

        Parameters:
        desiredOsVersion - new value of desiredOsVersion field (as defined in service metadata)
        Returns:
        immutable copy of this with just the desiredOsVersion field changed
      • getEnforcedSoftwareUpdateDelayInDays

        public Optional<Integer> getEnforcedSoftwareUpdateDelayInDays()
        “Days before software updates are visible to iOS devices ranging from 0 to 90 inclusive”
        Returns:
        property enforcedSoftwareUpdateDelayInDays
      • withEnforcedSoftwareUpdateDelayInDays

        public IosUpdateConfiguration withEnforcedSoftwareUpdateDelayInDays​(Integer enforcedSoftwareUpdateDelayInDays)
        Returns an immutable copy of this with just the enforcedSoftwareUpdateDelayInDays field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Days before software updates are visible to iOS devices ranging from 0 to 90 inclusive”

        Parameters:
        enforcedSoftwareUpdateDelayInDays - new value of enforcedSoftwareUpdateDelayInDays field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enforcedSoftwareUpdateDelayInDays field changed
      • getIsEnabled

        public Optional<Boolean> getIsEnabled()
        “Is setting enabled in UI”
        Returns:
        property isEnabled
      • withIsEnabled

        public IosUpdateConfiguration withIsEnabled​(Boolean isEnabled)
        Returns an immutable copy of this with just the isEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Is setting enabled in UI”

        Parameters:
        isEnabled - new value of isEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the isEnabled field changed
      • getScheduledInstallDays

        public com.github.davidmoten.odata.client.CollectionPage<DayOfWeek> getScheduledInstallDays()
        “Days in week for which active hours are configured. This collection can contain a maximum of 7 elements.”
        Returns:
        property scheduledInstallDays
      • withScheduledInstallDays

        public IosUpdateConfiguration withScheduledInstallDays​(List<DayOfWeek> scheduledInstallDays)
        Returns an immutable copy of this with just the scheduledInstallDays field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Days in week for which active hours are configured. This collection can contain a maximum of 7 elements.”

        Parameters:
        scheduledInstallDays - new value of scheduledInstallDays field (as defined in service metadata)
        Returns:
        immutable copy of this with just the scheduledInstallDays field changed
      • getScheduledInstallDays

        public com.github.davidmoten.odata.client.CollectionPage<DayOfWeek> getScheduledInstallDays​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Days in week for which active hours are configured. This collection can contain a maximum of 7 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property scheduledInstallDays
      • withUpdateScheduleType

        public IosUpdateConfiguration withUpdateScheduleType​(IosSoftwareUpdateScheduleType updateScheduleType)
        Returns an immutable copy of this with just the updateScheduleType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Update schedule type”

        Parameters:
        updateScheduleType - new value of updateScheduleType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the updateScheduleType field changed
      • getUtcTimeOffsetInMinutes

        public Optional<Integer> getUtcTimeOffsetInMinutes()
        “UTC Time Offset indicated in minutes”
        Returns:
        property utcTimeOffsetInMinutes
      • withUtcTimeOffsetInMinutes

        public IosUpdateConfiguration withUtcTimeOffsetInMinutes​(Integer utcTimeOffsetInMinutes)
        Returns an immutable copy of this with just the utcTimeOffsetInMinutes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “UTC Time Offset indicated in minutes”

        Parameters:
        utcTimeOffsetInMinutes - new value of utcTimeOffsetInMinutes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the utcTimeOffsetInMinutes field changed
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class DeviceConfiguration
      • patch

        public IosUpdateConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public IosUpdateConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected