Package software.amazon.awssdk.services.iot.model

Class SchedulingConfig

    • Method Detail

      • startTime

        public final String startTime()

        The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.

        For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.

        Returns:
        The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.

        For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.

      • endTime

        public final String endTime()

        The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.

        For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.

        Returns:
        The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.

        For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.

      • endBehavior

        public final JobEndBehavior endBehavior()

        Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

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

        Returns:
        Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
        See Also:
        JobEndBehavior

      • endBehaviorAsString

        public final String endBehaviorAsString()

        Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

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

        Returns:
        Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
        See Also:
        JobEndBehavior

      • hasMaintenanceWindows

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

      • maintenanceWindows

        public final List<MaintenanceWindow> maintenanceWindows()

        An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

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

        Returns:
        An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

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