SchedulingConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.SchedulingConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SchedulingConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SchedulingConfig()

Constructors
Constructor and Description
`SchedulingConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SchedulingConfig`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEndBehavior()` Specifies the end behavior for all job executions after a job reaches the selected `endTime`.
`String`	`getEndTime()` The time a job will stop rollout of the job document to all devices in the target group for a job.
`List<MaintenanceWindow>`	`getMaintenanceWindows()` 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.
`String`	`getStartTime()` The time a job will begin rollout of the job document to all devices in the target group for a job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndBehavior(String endBehavior)` Specifies the end behavior for all job executions after a job reaches the selected `endTime`.
`void`	`setEndTime(String endTime)` The time a job will stop rollout of the job document to all devices in the target group for a job.
`void`	`setMaintenanceWindows(Collection<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.
`void`	`setStartTime(String startTime)` The time a job will begin rollout of the job document to all devices in the target group for a job.
`String`	`toString()` Returns a string representation of this object.
`SchedulingConfig`	`withEndBehavior(JobEndBehavior endBehavior)` Specifies the end behavior for all job executions after a job reaches the selected `endTime`.
`SchedulingConfig`	`withEndBehavior(String endBehavior)` Specifies the end behavior for all job executions after a job reaches the selected `endTime`.
`SchedulingConfig`	`withEndTime(String endTime)` The time a job will stop rollout of the job document to all devices in the target group for a job.
`SchedulingConfig`	`withMaintenanceWindows(Collection<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.
`SchedulingConfig`	`withMaintenanceWindows(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.
`SchedulingConfig`	`withStartTime(String startTime)` The time a job will begin rollout of the job document to all devices in the target group for a job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SchedulingConfig
```
public SchedulingConfig()
```
- Method Detail
  - setStartTime
```
public void setStartTime(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.
    
    Parameters:
    
    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.
  - getStartTime
```
public String getStartTime()
```
    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.
  - withStartTime
```
public SchedulingConfig withStartTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(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.
    
    Parameters:
    
    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.
  - getEndTime
```
public String getEndTime()
```
    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.
  - withEndTime
```
public SchedulingConfig withEndTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndBehavior
```
public void setEndBehavior(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    JobEndBehavior
  - getEndBehavior
```
public String getEndBehavior()
```
    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.
    
    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
  - withEndBehavior
```
public SchedulingConfig withEndBehavior(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobEndBehavior
  - withEndBehavior
```
public SchedulingConfig withEndBehavior(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobEndBehavior
  - getMaintenanceWindows
```
public List<MaintenanceWindow> getMaintenanceWindows()
```
    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.
    
    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.
  - setMaintenanceWindows
```
public void setMaintenanceWindows(Collection<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.
    
    Parameters:
    
    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.
  - withMaintenanceWindows
```
public SchedulingConfig withMaintenanceWindows(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMaintenanceWindows(java.util.Collection) or withMaintenanceWindows(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMaintenanceWindows
```
public SchedulingConfig withMaintenanceWindows(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SchedulingConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class SchedulingConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchedulingConfig

Method Detail

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setEndBehavior

getEndBehavior

withEndBehavior

withEndBehavior

getMaintenanceWindows

setMaintenanceWindows

withMaintenanceWindows

withMaintenanceWindows

toString

equals

hashCode

clone

marshall