/*
* Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.iot.model;
import java.io.Serializable;
/**
* <p>
* The <code>Job</code> object contains details about a job.
* </p>
*/
public class Job implements Serializable {
/**
* <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
*/
private String jobArn;
/**
* <p>
* The unique identifier you assigned to this job when it was created.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 64<br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*/
private String jobId;
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*/
private String targetSelection;
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*/
private String status;
/**
* <p>
* Will be <code>true</code> if the job was canceled with the optional
* <code>force</code> parameter set to <code>true</code>.
* </p>
*/
private Boolean forceCanceled;
/**
* <p>
* If the job was updated, provides the reason code for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 128<br/>
* <b>Pattern: </b>[\p{Upper}\p{Digit}_]+<br/>
*/
private String reasonCode;
/**
* <p>
* If the job was updated, describes the reason for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*/
private String comment;
/**
* <p>
* A list of IoT things and thing groups to which the job should be sent.
* </p>
*/
private java.util.List<String> targets;
/**
* <p>
* A short text description of the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*/
private String description;
/**
* <p>
* Configuration for pre-signed S3 URLs.
* </p>
*/
private PresignedUrlConfig presignedUrlConfig;
/**
* <p>
* Allows you to create a staged rollout of a job.
* </p>
*/
private JobExecutionsRolloutConfig jobExecutionsRolloutConfig;
/**
* <p>
* Configuration for criteria to abort the job.
* </p>
*/
private AbortConfig abortConfig;
/**
* <p>
* The time, in seconds since the epoch, when the job was created.
* </p>
*/
private java.util.Date createdAt;
/**
* <p>
* The time, in seconds since the epoch, when the job was last updated.
* </p>
*/
private java.util.Date lastUpdatedAt;
/**
* <p>
* The time, in seconds since the epoch, when the job was completed.
* </p>
*/
private java.util.Date completedAt;
/**
* <p>
* Details about the job process.
* </p>
*/
private JobProcessDetails jobProcessDetails;
/**
* <p>
* Specifies the amount of time each device has to finish its execution of
* the job. A timer is started when the job execution status is set to
* <code>IN_PROGRESS</code>. If the job execution status is not set to
* another terminal state before the timer expires, it will be automatically
* set to <code>TIMED_OUT</code>.
* </p>
*/
private TimeoutConfig timeoutConfig;
/**
* <p>
* The namespace used to indicate that a job is a customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web Services IoT Core
* sends jobs notifications to MQTT topics that contain the value in the
* following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*/
private String namespaceId;
/**
* <p>
* The ARN of the job template used to create the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1600<br/>
* <b>Pattern: </b>^arn:[!-~]+$<br/>
*/
private String jobTemplateArn;
/**
* <p>
* The configuration for the criteria to retry the job.
* </p>
*/
private JobExecutionsRetryConfig jobExecutionsRetryConfig;
/**
* <p>
* A key-value map that pairs the patterns that need to be replaced in a
* managed template job document schema. You can use the description of each
* key as a guidance to specify the inputs during runtime when creating a
* job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating jobs from
* Amazon Web Services managed templates. This parameter can't be used with
* custom job templates or to create jobs from them.
* </p>
* </note>
*/
private java.util.Map<String, String> documentParameters;
/**
* <p>
* Indicates whether a job is concurrent. Will be true when a job is rolling
* out new job executions or canceling previously created executions,
* otherwise false.
* </p>
*/
private Boolean isConcurrent;
/**
* <p>
* The configuration that allows you to schedule a job for a future date and
* time in addition to specifying the end behavior for each job execution.
* </p>
*/
private SchedulingConfig schedulingConfig;
/**
* <p>
* Displays the next seven maintenance window occurrences and their start
* times.
* </p>
*/
private java.util.List<ScheduledJobRollout> scheduledJobRollouts;
/**
* <p>
* The package version Amazon Resource Names (ARNs) that are installed on
* the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single string.
* Up to five strings are allowed.
* </p>
*/
private java.util.List<String> destinationPackageVersions;
/**
* <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
*
* @return <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
*/
public String getJobArn() {
return jobArn;
}
/**
* <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
*
* @param jobArn <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
*/
public void setJobArn(String jobArn) {
this.jobArn = jobArn;
}
/**
* <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param jobArn <p>
* An ARN identifying the job with format
* "arn:aws:iot:region:account:job/jobId".
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobArn(String jobArn) {
this.jobArn = jobArn;
return this;
}
/**
* <p>
* The unique identifier you assigned to this job when it was created.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 64<br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @return <p>
* The unique identifier you assigned to this job when it was
* created.
* </p>
*/
public String getJobId() {
return jobId;
}
/**
* <p>
* The unique identifier you assigned to this job when it was created.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 64<br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @param jobId <p>
* The unique identifier you assigned to this job when it was
* created.
* </p>
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
* <p>
* The unique identifier you assigned to this job when it was created.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 64<br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @param jobId <p>
* The unique identifier you assigned to this job when it was
* created.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobId(String jobId) {
this.jobId = jobId;
return this;
}
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*
* @return <p>
* Specifies whether the job will continue to run (CONTINUOUS), or
* will be complete after all those things specified as targets have
* completed the job (SNAPSHOT). If continuous, the job may also be
* run on a thing when a change is detected in a target. For
* example, a job will run on a device when the thing representing
* the device is added to a target group, even after the job was
* completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot
* jobs for dynamic thing group targets. By using continuous jobs,
* devices that join the group receive the job execution even after
* the job has been created.
* </p>
* </note>
* @see TargetSelection
*/
public String getTargetSelection() {
return targetSelection;
}
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*
* @param targetSelection <p>
* Specifies whether the job will continue to run (CONTINUOUS),
* or will be complete after all those things specified as
* targets have completed the job (SNAPSHOT). If continuous, the
* job may also be run on a thing when a change is detected in a
* target. For example, a job will run on a device when the thing
* representing the device is added to a target group, even after
* the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot
* jobs for dynamic thing group targets. By using continuous
* jobs, devices that join the group receive the job execution
* even after the job has been created.
* </p>
* </note>
* @see TargetSelection
*/
public void setTargetSelection(String targetSelection) {
this.targetSelection = targetSelection;
}
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*
* @param targetSelection <p>
* Specifies whether the job will continue to run (CONTINUOUS),
* or will be complete after all those things specified as
* targets have completed the job (SNAPSHOT). If continuous, the
* job may also be run on a thing when a change is detected in a
* target. For example, a job will run on a device when the thing
* representing the device is added to a target group, even after
* the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot
* jobs for dynamic thing group targets. By using continuous
* jobs, devices that join the group receive the job execution
* even after the job has been created.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see TargetSelection
*/
public Job withTargetSelection(String targetSelection) {
this.targetSelection = targetSelection;
return this;
}
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*
* @param targetSelection <p>
* Specifies whether the job will continue to run (CONTINUOUS),
* or will be complete after all those things specified as
* targets have completed the job (SNAPSHOT). If continuous, the
* job may also be run on a thing when a change is detected in a
* target. For example, a job will run on a device when the thing
* representing the device is added to a target group, even after
* the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot
* jobs for dynamic thing group targets. By using continuous
* jobs, devices that join the group receive the job execution
* even after the job has been created.
* </p>
* </note>
* @see TargetSelection
*/
public void setTargetSelection(TargetSelection targetSelection) {
this.targetSelection = targetSelection.toString();
}
/**
* <p>
* Specifies whether the job will continue to run (CONTINUOUS), or will be
* complete after all those things specified as targets have completed the
* job (SNAPSHOT). If continuous, the job may also be run on a thing when a
* change is detected in a target. For example, a job will run on a device
* when the thing representing the device is added to a target group, even
* after the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot jobs for
* dynamic thing group targets. By using continuous jobs, devices that join
* the group receive the job execution even after the job has been created.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>CONTINUOUS, SNAPSHOT
*
* @param targetSelection <p>
* Specifies whether the job will continue to run (CONTINUOUS),
* or will be complete after all those things specified as
* targets have completed the job (SNAPSHOT). If continuous, the
* job may also be run on a thing when a change is detected in a
* target. For example, a job will run on a device when the thing
* representing the device is added to a target group, even after
* the job was completed by all things originally in the group.
* </p>
* <note>
* <p>
* We recommend that you use continuous jobs instead of snapshot
* jobs for dynamic thing group targets. By using continuous
* jobs, devices that join the group receive the job execution
* even after the job has been created.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see TargetSelection
*/
public Job withTargetSelection(TargetSelection targetSelection) {
this.targetSelection = targetSelection.toString();
return this;
}
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*
* @return <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* @see JobStatus
*/
public String getStatus() {
return status;
}
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*
* @param status <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* @see JobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*
* @param status <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see JobStatus
*/
public Job withStatus(String status) {
this.status = status;
return this;
}
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*
* @param status <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* @see JobStatus
*/
public void setStatus(JobStatus status) {
this.status = status.toString();
}
/**
* <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Allowed Values: </b>IN_PROGRESS, CANCELED, COMPLETED,
* DELETION_IN_PROGRESS, SCHEDULED
*
* @param status <p>
* The status of the job, one of <code>IN_PROGRESS</code>,
* <code>CANCELED</code>, <code>DELETION_IN_PROGRESS</code> or
* <code>COMPLETED</code>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
* @see JobStatus
*/
public Job withStatus(JobStatus status) {
this.status = status.toString();
return this;
}
/**
* <p>
* Will be <code>true</code> if the job was canceled with the optional
* <code>force</code> parameter set to <code>true</code>.
* </p>
*
* @return <p>
* Will be <code>true</code> if the job was canceled with the
* optional <code>force</code> parameter set to <code>true</code>.
* </p>
*/
public Boolean isForceCanceled() {
return forceCanceled;
}
/**
* <p>
* Will be <code>true</code> if the job was canceled with the optional
* <code>force</code> parameter set to <code>true</code>.
* </p>
*
* @return <p>
* Will be <code>true</code> if the job was canceled with the
* optional <code>force</code> parameter set to <code>true</code>.
* </p>
*/
public Boolean getForceCanceled() {
return forceCanceled;
}
/**
* <p>
* Will be <code>true</code> if the job was canceled with the optional
* <code>force</code> parameter set to <code>true</code>.
* </p>
*
* @param forceCanceled <p>
* Will be <code>true</code> if the job was canceled with the
* optional <code>force</code> parameter set to <code>true</code>
* .
* </p>
*/
public void setForceCanceled(Boolean forceCanceled) {
this.forceCanceled = forceCanceled;
}
/**
* <p>
* Will be <code>true</code> if the job was canceled with the optional
* <code>force</code> parameter set to <code>true</code>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param forceCanceled <p>
* Will be <code>true</code> if the job was canceled with the
* optional <code>force</code> parameter set to <code>true</code>
* .
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withForceCanceled(Boolean forceCanceled) {
this.forceCanceled = forceCanceled;
return this;
}
/**
* <p>
* If the job was updated, provides the reason code for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 128<br/>
* <b>Pattern: </b>[\p{Upper}\p{Digit}_]+<br/>
*
* @return <p>
* If the job was updated, provides the reason code for the update.
* </p>
*/
public String getReasonCode() {
return reasonCode;
}
/**
* <p>
* If the job was updated, provides the reason code for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 128<br/>
* <b>Pattern: </b>[\p{Upper}\p{Digit}_]+<br/>
*
* @param reasonCode <p>
* If the job was updated, provides the reason code for the
* update.
* </p>
*/
public void setReasonCode(String reasonCode) {
this.reasonCode = reasonCode;
}
/**
* <p>
* If the job was updated, provides the reason code for the update.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 128<br/>
* <b>Pattern: </b>[\p{Upper}\p{Digit}_]+<br/>
*
* @param reasonCode <p>
* If the job was updated, provides the reason code for the
* update.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withReasonCode(String reasonCode) {
this.reasonCode = reasonCode;
return this;
}
/**
* <p>
* If the job was updated, describes the reason for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @return <p>
* If the job was updated, describes the reason for the update.
* </p>
*/
public String getComment() {
return comment;
}
/**
* <p>
* If the job was updated, describes the reason for the update.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @param comment <p>
* If the job was updated, describes the reason for the update.
* </p>
*/
public void setComment(String comment) {
this.comment = comment;
}
/**
* <p>
* If the job was updated, describes the reason for the update.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @param comment <p>
* If the job was updated, describes the reason for the update.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withComment(String comment) {
this.comment = comment;
return this;
}
/**
* <p>
* A list of IoT things and thing groups to which the job should be sent.
* </p>
*
* @return <p>
* A list of IoT things and thing groups to which the job should be
* sent.
* </p>
*/
public java.util.List<String> getTargets() {
return targets;
}
/**
* <p>
* A list of IoT things and thing groups to which the job should be sent.
* </p>
*
* @param targets <p>
* A list of IoT things and thing groups to which the job should
* be sent.
* </p>
*/
public void setTargets(java.util.Collection<String> targets) {
if (targets == null) {
this.targets = null;
return;
}
this.targets = new java.util.ArrayList<String>(targets);
}
/**
* <p>
* A list of IoT things and thing groups to which the job should be sent.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param targets <p>
* A list of IoT things and thing groups to which the job should
* be sent.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withTargets(String... targets) {
if (getTargets() == null) {
this.targets = new java.util.ArrayList<String>(targets.length);
}
for (String value : targets) {
this.targets.add(value);
}
return this;
}
/**
* <p>
* A list of IoT things and thing groups to which the job should be sent.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param targets <p>
* A list of IoT things and thing groups to which the job should
* be sent.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withTargets(java.util.Collection<String> targets) {
setTargets(targets);
return this;
}
/**
* <p>
* A short text description of the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @return <p>
* A short text description of the job.
* </p>
*/
public String getDescription() {
return description;
}
/**
* <p>
* A short text description of the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @param description <p>
* A short text description of the job.
* </p>
*/
public void setDescription(String description) {
this.description = description;
}
/**
* <p>
* A short text description of the job.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b> - 2028<br/>
* <b>Pattern: </b>[^\p{C}]+<br/>
*
* @param description <p>
* A short text description of the job.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withDescription(String description) {
this.description = description;
return this;
}
/**
* <p>
* Configuration for pre-signed S3 URLs.
* </p>
*
* @return <p>
* Configuration for pre-signed S3 URLs.
* </p>
*/
public PresignedUrlConfig getPresignedUrlConfig() {
return presignedUrlConfig;
}
/**
* <p>
* Configuration for pre-signed S3 URLs.
* </p>
*
* @param presignedUrlConfig <p>
* Configuration for pre-signed S3 URLs.
* </p>
*/
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) {
this.presignedUrlConfig = presignedUrlConfig;
}
/**
* <p>
* Configuration for pre-signed S3 URLs.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param presignedUrlConfig <p>
* Configuration for pre-signed S3 URLs.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) {
this.presignedUrlConfig = presignedUrlConfig;
return this;
}
/**
* <p>
* Allows you to create a staged rollout of a job.
* </p>
*
* @return <p>
* Allows you to create a staged rollout of a job.
* </p>
*/
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig() {
return jobExecutionsRolloutConfig;
}
/**
* <p>
* Allows you to create a staged rollout of a job.
* </p>
*
* @param jobExecutionsRolloutConfig <p>
* Allows you to create a staged rollout of a job.
* </p>
*/
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) {
this.jobExecutionsRolloutConfig = jobExecutionsRolloutConfig;
}
/**
* <p>
* Allows you to create a staged rollout of a job.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param jobExecutionsRolloutConfig <p>
* Allows you to create a staged rollout of a job.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) {
this.jobExecutionsRolloutConfig = jobExecutionsRolloutConfig;
return this;
}
/**
* <p>
* Configuration for criteria to abort the job.
* </p>
*
* @return <p>
* Configuration for criteria to abort the job.
* </p>
*/
public AbortConfig getAbortConfig() {
return abortConfig;
}
/**
* <p>
* Configuration for criteria to abort the job.
* </p>
*
* @param abortConfig <p>
* Configuration for criteria to abort the job.
* </p>
*/
public void setAbortConfig(AbortConfig abortConfig) {
this.abortConfig = abortConfig;
}
/**
* <p>
* Configuration for criteria to abort the job.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param abortConfig <p>
* Configuration for criteria to abort the job.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withAbortConfig(AbortConfig abortConfig) {
this.abortConfig = abortConfig;
return this;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was created.
* </p>
*
* @return <p>
* The time, in seconds since the epoch, when the job was created.
* </p>
*/
public java.util.Date getCreatedAt() {
return createdAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was created.
* </p>
*
* @param createdAt <p>
* The time, in seconds since the epoch, when the job was
* created.
* </p>
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was created.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param createdAt <p>
* The time, in seconds since the epoch, when the job was
* created.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was last updated.
* </p>
*
* @return <p>
* The time, in seconds since the epoch, when the job was last
* updated.
* </p>
*/
public java.util.Date getLastUpdatedAt() {
return lastUpdatedAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was last updated.
* </p>
*
* @param lastUpdatedAt <p>
* The time, in seconds since the epoch, when the job was last
* updated.
* </p>
*/
public void setLastUpdatedAt(java.util.Date lastUpdatedAt) {
this.lastUpdatedAt = lastUpdatedAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was last updated.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param lastUpdatedAt <p>
* The time, in seconds since the epoch, when the job was last
* updated.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withLastUpdatedAt(java.util.Date lastUpdatedAt) {
this.lastUpdatedAt = lastUpdatedAt;
return this;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was completed.
* </p>
*
* @return <p>
* The time, in seconds since the epoch, when the job was completed.
* </p>
*/
public java.util.Date getCompletedAt() {
return completedAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was completed.
* </p>
*
* @param completedAt <p>
* The time, in seconds since the epoch, when the job was
* completed.
* </p>
*/
public void setCompletedAt(java.util.Date completedAt) {
this.completedAt = completedAt;
}
/**
* <p>
* The time, in seconds since the epoch, when the job was completed.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param completedAt <p>
* The time, in seconds since the epoch, when the job was
* completed.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withCompletedAt(java.util.Date completedAt) {
this.completedAt = completedAt;
return this;
}
/**
* <p>
* Details about the job process.
* </p>
*
* @return <p>
* Details about the job process.
* </p>
*/
public JobProcessDetails getJobProcessDetails() {
return jobProcessDetails;
}
/**
* <p>
* Details about the job process.
* </p>
*
* @param jobProcessDetails <p>
* Details about the job process.
* </p>
*/
public void setJobProcessDetails(JobProcessDetails jobProcessDetails) {
this.jobProcessDetails = jobProcessDetails;
}
/**
* <p>
* Details about the job process.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param jobProcessDetails <p>
* Details about the job process.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobProcessDetails(JobProcessDetails jobProcessDetails) {
this.jobProcessDetails = jobProcessDetails;
return this;
}
/**
* <p>
* Specifies the amount of time each device has to finish its execution of
* the job. A timer is started when the job execution status is set to
* <code>IN_PROGRESS</code>. If the job execution status is not set to
* another terminal state before the timer expires, it will be automatically
* set to <code>TIMED_OUT</code>.
* </p>
*
* @return <p>
* Specifies the amount of time each device has to finish its
* execution of the job. A timer is started when the job execution
* status is set to <code>IN_PROGRESS</code>. If the job execution
* status is not set to another terminal state before the timer
* expires, it will be automatically set to <code>TIMED_OUT</code>.
* </p>
*/
public TimeoutConfig getTimeoutConfig() {
return timeoutConfig;
}
/**
* <p>
* Specifies the amount of time each device has to finish its execution of
* the job. A timer is started when the job execution status is set to
* <code>IN_PROGRESS</code>. If the job execution status is not set to
* another terminal state before the timer expires, it will be automatically
* set to <code>TIMED_OUT</code>.
* </p>
*
* @param timeoutConfig <p>
* Specifies the amount of time each device has to finish its
* execution of the job. A timer is started when the job
* execution status is set to <code>IN_PROGRESS</code>. If the
* job execution status is not set to another terminal state
* before the timer expires, it will be automatically set to
* <code>TIMED_OUT</code>.
* </p>
*/
public void setTimeoutConfig(TimeoutConfig timeoutConfig) {
this.timeoutConfig = timeoutConfig;
}
/**
* <p>
* Specifies the amount of time each device has to finish its execution of
* the job. A timer is started when the job execution status is set to
* <code>IN_PROGRESS</code>. If the job execution status is not set to
* another terminal state before the timer expires, it will be automatically
* set to <code>TIMED_OUT</code>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param timeoutConfig <p>
* Specifies the amount of time each device has to finish its
* execution of the job. A timer is started when the job
* execution status is set to <code>IN_PROGRESS</code>. If the
* job execution status is not set to another terminal state
* before the timer expires, it will be automatically set to
* <code>TIMED_OUT</code>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withTimeoutConfig(TimeoutConfig timeoutConfig) {
this.timeoutConfig = timeoutConfig;
return this;
}
/**
* <p>
* The namespace used to indicate that a job is a customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web Services IoT Core
* sends jobs notifications to MQTT topics that contain the value in the
* following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @return <p>
* The namespace used to indicate that a job is a customer-managed
* job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web Services
* IoT Core sends jobs notifications to MQTT topics that contain the
* value in the following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
*/
public String getNamespaceId() {
return namespaceId;
}
/**
* <p>
* The namespace used to indicate that a job is a customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web Services IoT Core
* sends jobs notifications to MQTT topics that contain the value in the
* following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @param namespaceId <p>
* The namespace used to indicate that a job is a
* customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web
* Services IoT Core sends jobs notifications to MQTT topics that
* contain the value in the following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
*/
public void setNamespaceId(String namespaceId) {
this.namespaceId = namespaceId;
}
/**
* <p>
* The namespace used to indicate that a job is a customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web Services IoT Core
* sends jobs notifications to MQTT topics that contain the value in the
* following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>[a-zA-Z0-9_-]+<br/>
*
* @param namespaceId <p>
* The namespace used to indicate that a job is a
* customer-managed job.
* </p>
* <p>
* When you specify a value for this parameter, Amazon Web
* Services IoT Core sends jobs notifications to MQTT topics that
* contain the value in the following format.
* </p>
* <p>
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
* </p>
* <note>
* <p>
* The <code>namespaceId</code> feature is in public preview.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withNamespaceId(String namespaceId) {
this.namespaceId = namespaceId;
return this;
}
/**
* <p>
* The ARN of the job template used to create the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1600<br/>
* <b>Pattern: </b>^arn:[!-~]+$<br/>
*
* @return <p>
* The ARN of the job template used to create the job.
* </p>
*/
public String getJobTemplateArn() {
return jobTemplateArn;
}
/**
* <p>
* The ARN of the job template used to create the job.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1600<br/>
* <b>Pattern: </b>^arn:[!-~]+$<br/>
*
* @param jobTemplateArn <p>
* The ARN of the job template used to create the job.
* </p>
*/
public void setJobTemplateArn(String jobTemplateArn) {
this.jobTemplateArn = jobTemplateArn;
}
/**
* <p>
* The ARN of the job template used to create the job.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1600<br/>
* <b>Pattern: </b>^arn:[!-~]+$<br/>
*
* @param jobTemplateArn <p>
* The ARN of the job template used to create the job.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobTemplateArn(String jobTemplateArn) {
this.jobTemplateArn = jobTemplateArn;
return this;
}
/**
* <p>
* The configuration for the criteria to retry the job.
* </p>
*
* @return <p>
* The configuration for the criteria to retry the job.
* </p>
*/
public JobExecutionsRetryConfig getJobExecutionsRetryConfig() {
return jobExecutionsRetryConfig;
}
/**
* <p>
* The configuration for the criteria to retry the job.
* </p>
*
* @param jobExecutionsRetryConfig <p>
* The configuration for the criteria to retry the job.
* </p>
*/
public void setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) {
this.jobExecutionsRetryConfig = jobExecutionsRetryConfig;
}
/**
* <p>
* The configuration for the criteria to retry the job.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param jobExecutionsRetryConfig <p>
* The configuration for the criteria to retry the job.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) {
this.jobExecutionsRetryConfig = jobExecutionsRetryConfig;
return this;
}
/**
* <p>
* A key-value map that pairs the patterns that need to be replaced in a
* managed template job document schema. You can use the description of each
* key as a guidance to specify the inputs during runtime when creating a
* job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating jobs from
* Amazon Web Services managed templates. This parameter can't be used with
* custom job templates or to create jobs from them.
* </p>
* </note>
*
* @return <p>
* A key-value map that pairs the patterns that need to be replaced
* in a managed template job document schema. You can use the
* description of each key as a guidance to specify the inputs
* during runtime when creating a job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating
* jobs from Amazon Web Services managed templates. This parameter
* can't be used with custom job templates or to create jobs from
* them.
* </p>
* </note>
*/
public java.util.Map<String, String> getDocumentParameters() {
return documentParameters;
}
/**
* <p>
* A key-value map that pairs the patterns that need to be replaced in a
* managed template job document schema. You can use the description of each
* key as a guidance to specify the inputs during runtime when creating a
* job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating jobs from
* Amazon Web Services managed templates. This parameter can't be used with
* custom job templates or to create jobs from them.
* </p>
* </note>
*
* @param documentParameters <p>
* A key-value map that pairs the patterns that need to be
* replaced in a managed template job document schema. You can
* use the description of each key as a guidance to specify the
* inputs during runtime when creating a job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating
* jobs from Amazon Web Services managed templates. This
* parameter can't be used with custom job templates or to create
* jobs from them.
* </p>
* </note>
*/
public void setDocumentParameters(java.util.Map<String, String> documentParameters) {
this.documentParameters = documentParameters;
}
/**
* <p>
* A key-value map that pairs the patterns that need to be replaced in a
* managed template job document schema. You can use the description of each
* key as a guidance to specify the inputs during runtime when creating a
* job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating jobs from
* Amazon Web Services managed templates. This parameter can't be used with
* custom job templates or to create jobs from them.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param documentParameters <p>
* A key-value map that pairs the patterns that need to be
* replaced in a managed template job document schema. You can
* use the description of each key as a guidance to specify the
* inputs during runtime when creating a job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating
* jobs from Amazon Web Services managed templates. This
* parameter can't be used with custom job templates or to create
* jobs from them.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withDocumentParameters(java.util.Map<String, String> documentParameters) {
this.documentParameters = documentParameters;
return this;
}
/**
* <p>
* A key-value map that pairs the patterns that need to be replaced in a
* managed template job document schema. You can use the description of each
* key as a guidance to specify the inputs during runtime when creating a
* job.
* </p>
* <note>
* <p>
* <code>documentParameters</code> can only be used when creating jobs from
* Amazon Web Services managed templates. This parameter can't be used with
* custom job templates or to create jobs from them.
* </p>
* </note>
* <p>
* The method adds a new key-value pair into documentParameters parameter,
* and returns a reference to this object so that method calls can be
* chained together.
*
* @param key The key of the entry to be added into documentParameters.
* @param value The corresponding value of the entry to be added into
* documentParameters.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job adddocumentParametersEntry(String key, String value) {
if (null == this.documentParameters) {
this.documentParameters = new java.util.HashMap<String, String>();
}
if (this.documentParameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString()
+ ") are provided.");
this.documentParameters.put(key, value);
return this;
}
/**
* Removes all the entries added into documentParameters.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public Job cleardocumentParametersEntries() {
this.documentParameters = null;
return this;
}
/**
* <p>
* Indicates whether a job is concurrent. Will be true when a job is rolling
* out new job executions or canceling previously created executions,
* otherwise false.
* </p>
*
* @return <p>
* Indicates whether a job is concurrent. Will be true when a job is
* rolling out new job executions or canceling previously created
* executions, otherwise false.
* </p>
*/
public Boolean isIsConcurrent() {
return isConcurrent;
}
/**
* <p>
* Indicates whether a job is concurrent. Will be true when a job is rolling
* out new job executions or canceling previously created executions,
* otherwise false.
* </p>
*
* @return <p>
* Indicates whether a job is concurrent. Will be true when a job is
* rolling out new job executions or canceling previously created
* executions, otherwise false.
* </p>
*/
public Boolean getIsConcurrent() {
return isConcurrent;
}
/**
* <p>
* Indicates whether a job is concurrent. Will be true when a job is rolling
* out new job executions or canceling previously created executions,
* otherwise false.
* </p>
*
* @param isConcurrent <p>
* Indicates whether a job is concurrent. Will be true when a job
* is rolling out new job executions or canceling previously
* created executions, otherwise false.
* </p>
*/
public void setIsConcurrent(Boolean isConcurrent) {
this.isConcurrent = isConcurrent;
}
/**
* <p>
* Indicates whether a job is concurrent. Will be true when a job is rolling
* out new job executions or canceling previously created executions,
* otherwise false.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param isConcurrent <p>
* Indicates whether a job is concurrent. Will be true when a job
* is rolling out new job executions or canceling previously
* created executions, otherwise false.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withIsConcurrent(Boolean isConcurrent) {
this.isConcurrent = isConcurrent;
return this;
}
/**
* <p>
* The configuration that allows you to schedule a job for a future date and
* time in addition to specifying the end behavior for each job execution.
* </p>
*
* @return <p>
* The configuration that allows you to schedule a job for a future
* date and time in addition to specifying the end behavior for each
* job execution.
* </p>
*/
public SchedulingConfig getSchedulingConfig() {
return schedulingConfig;
}
/**
* <p>
* The configuration that allows you to schedule a job for a future date and
* time in addition to specifying the end behavior for each job execution.
* </p>
*
* @param schedulingConfig <p>
* The configuration that allows you to schedule a job for a
* future date and time in addition to specifying the end
* behavior for each job execution.
* </p>
*/
public void setSchedulingConfig(SchedulingConfig schedulingConfig) {
this.schedulingConfig = schedulingConfig;
}
/**
* <p>
* The configuration that allows you to schedule a job for a future date and
* time in addition to specifying the end behavior for each job execution.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param schedulingConfig <p>
* The configuration that allows you to schedule a job for a
* future date and time in addition to specifying the end
* behavior for each job execution.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withSchedulingConfig(SchedulingConfig schedulingConfig) {
this.schedulingConfig = schedulingConfig;
return this;
}
/**
* <p>
* Displays the next seven maintenance window occurrences and their start
* times.
* </p>
*
* @return <p>
* Displays the next seven maintenance window occurrences and their
* start times.
* </p>
*/
public java.util.List<ScheduledJobRollout> getScheduledJobRollouts() {
return scheduledJobRollouts;
}
/**
* <p>
* Displays the next seven maintenance window occurrences and their start
* times.
* </p>
*
* @param scheduledJobRollouts <p>
* Displays the next seven maintenance window occurrences and
* their start times.
* </p>
*/
public void setScheduledJobRollouts(
java.util.Collection<ScheduledJobRollout> scheduledJobRollouts) {
if (scheduledJobRollouts == null) {
this.scheduledJobRollouts = null;
return;
}
this.scheduledJobRollouts = new java.util.ArrayList<ScheduledJobRollout>(
scheduledJobRollouts);
}
/**
* <p>
* Displays the next seven maintenance window occurrences and their start
* times.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param scheduledJobRollouts <p>
* Displays the next seven maintenance window occurrences and
* their start times.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withScheduledJobRollouts(ScheduledJobRollout... scheduledJobRollouts) {
if (getScheduledJobRollouts() == null) {
this.scheduledJobRollouts = new java.util.ArrayList<ScheduledJobRollout>(
scheduledJobRollouts.length);
}
for (ScheduledJobRollout value : scheduledJobRollouts) {
this.scheduledJobRollouts.add(value);
}
return this;
}
/**
* <p>
* Displays the next seven maintenance window occurrences and their start
* times.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param scheduledJobRollouts <p>
* Displays the next seven maintenance window occurrences and
* their start times.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withScheduledJobRollouts(
java.util.Collection<ScheduledJobRollout> scheduledJobRollouts) {
setScheduledJobRollouts(scheduledJobRollouts);
return this;
}
/**
* <p>
* The package version Amazon Resource Names (ARNs) that are installed on
* the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single string.
* Up to five strings are allowed.
* </p>
*
* @return <p>
* The package version Amazon Resource Names (ARNs) that are
* installed on the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single
* string. Up to five strings are allowed.
* </p>
*/
public java.util.List<String> getDestinationPackageVersions() {
return destinationPackageVersions;
}
/**
* <p>
* The package version Amazon Resource Names (ARNs) that are installed on
* the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single string.
* Up to five strings are allowed.
* </p>
*
* @param destinationPackageVersions <p>
* The package version Amazon Resource Names (ARNs) that are
* installed on the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a
* single string. Up to five strings are allowed.
* </p>
*/
public void setDestinationPackageVersions(
java.util.Collection<String> destinationPackageVersions) {
if (destinationPackageVersions == null) {
this.destinationPackageVersions = null;
return;
}
this.destinationPackageVersions = new java.util.ArrayList<String>(
destinationPackageVersions);
}
/**
* <p>
* The package version Amazon Resource Names (ARNs) that are installed on
* the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single string.
* Up to five strings are allowed.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param destinationPackageVersions <p>
* The package version Amazon Resource Names (ARNs) that are
* installed on the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a
* single string. Up to five strings are allowed.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withDestinationPackageVersions(String... destinationPackageVersions) {
if (getDestinationPackageVersions() == null) {
this.destinationPackageVersions = new java.util.ArrayList<String>(
destinationPackageVersions.length);
}
for (String value : destinationPackageVersions) {
this.destinationPackageVersions.add(value);
}
return this;
}
/**
* <p>
* The package version Amazon Resource Names (ARNs) that are installed on
* the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a single string.
* Up to five strings are allowed.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param destinationPackageVersions <p>
* The package version Amazon Resource Names (ARNs) that are
* installed on the device when the job successfully completes.
* </p>
* <p>
* <b>Note:</b>The following Length Constraints relates to a
* single string. Up to five strings are allowed.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Job withDestinationPackageVersions(
java.util.Collection<String> destinationPackageVersions) {
setDestinationPackageVersions(destinationPackageVersions);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobArn() != null)
sb.append("jobArn: " + getJobArn() + ",");
if (getJobId() != null)
sb.append("jobId: " + getJobId() + ",");
if (getTargetSelection() != null)
sb.append("targetSelection: " + getTargetSelection() + ",");
if (getStatus() != null)
sb.append("status: " + getStatus() + ",");
if (getForceCanceled() != null)
sb.append("forceCanceled: " + getForceCanceled() + ",");
if (getReasonCode() != null)
sb.append("reasonCode: " + getReasonCode() + ",");
if (getComment() != null)
sb.append("comment: " + getComment() + ",");
if (getTargets() != null)
sb.append("targets: " + getTargets() + ",");
if (getDescription() != null)
sb.append("description: " + getDescription() + ",");
if (getPresignedUrlConfig() != null)
sb.append("presignedUrlConfig: " + getPresignedUrlConfig() + ",");
if (getJobExecutionsRolloutConfig() != null)
sb.append("jobExecutionsRolloutConfig: " + getJobExecutionsRolloutConfig() + ",");
if (getAbortConfig() != null)
sb.append("abortConfig: " + getAbortConfig() + ",");
if (getCreatedAt() != null)
sb.append("createdAt: " + getCreatedAt() + ",");
if (getLastUpdatedAt() != null)
sb.append("lastUpdatedAt: " + getLastUpdatedAt() + ",");
if (getCompletedAt() != null)
sb.append("completedAt: " + getCompletedAt() + ",");
if (getJobProcessDetails() != null)
sb.append("jobProcessDetails: " + getJobProcessDetails() + ",");
if (getTimeoutConfig() != null)
sb.append("timeoutConfig: " + getTimeoutConfig() + ",");
if (getNamespaceId() != null)
sb.append("namespaceId: " + getNamespaceId() + ",");
if (getJobTemplateArn() != null)
sb.append("jobTemplateArn: " + getJobTemplateArn() + ",");
if (getJobExecutionsRetryConfig() != null)
sb.append("jobExecutionsRetryConfig: " + getJobExecutionsRetryConfig() + ",");
if (getDocumentParameters() != null)
sb.append("documentParameters: " + getDocumentParameters() + ",");
if (getIsConcurrent() != null)
sb.append("isConcurrent: " + getIsConcurrent() + ",");
if (getSchedulingConfig() != null)
sb.append("schedulingConfig: " + getSchedulingConfig() + ",");
if (getScheduledJobRollouts() != null)
sb.append("scheduledJobRollouts: " + getScheduledJobRollouts() + ",");
if (getDestinationPackageVersions() != null)
sb.append("destinationPackageVersions: " + getDestinationPackageVersions());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobArn() == null) ? 0 : getJobArn().hashCode());
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode
+ ((getTargetSelection() == null) ? 0 : getTargetSelection().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode
+ ((getForceCanceled() == null) ? 0 : getForceCanceled().hashCode());
hashCode = prime * hashCode + ((getReasonCode() == null) ? 0 : getReasonCode().hashCode());
hashCode = prime * hashCode + ((getComment() == null) ? 0 : getComment().hashCode());
hashCode = prime * hashCode + ((getTargets() == null) ? 0 : getTargets().hashCode());
hashCode = prime * hashCode
+ ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode
+ ((getPresignedUrlConfig() == null) ? 0 : getPresignedUrlConfig().hashCode());
hashCode = prime
* hashCode
+ ((getJobExecutionsRolloutConfig() == null) ? 0 : getJobExecutionsRolloutConfig()
.hashCode());
hashCode = prime * hashCode
+ ((getAbortConfig() == null) ? 0 : getAbortConfig().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode
+ ((getLastUpdatedAt() == null) ? 0 : getLastUpdatedAt().hashCode());
hashCode = prime * hashCode
+ ((getCompletedAt() == null) ? 0 : getCompletedAt().hashCode());
hashCode = prime * hashCode
+ ((getJobProcessDetails() == null) ? 0 : getJobProcessDetails().hashCode());
hashCode = prime * hashCode
+ ((getTimeoutConfig() == null) ? 0 : getTimeoutConfig().hashCode());
hashCode = prime * hashCode
+ ((getNamespaceId() == null) ? 0 : getNamespaceId().hashCode());
hashCode = prime * hashCode
+ ((getJobTemplateArn() == null) ? 0 : getJobTemplateArn().hashCode());
hashCode = prime
* hashCode
+ ((getJobExecutionsRetryConfig() == null) ? 0 : getJobExecutionsRetryConfig()
.hashCode());
hashCode = prime * hashCode
+ ((getDocumentParameters() == null) ? 0 : getDocumentParameters().hashCode());
hashCode = prime * hashCode
+ ((getIsConcurrent() == null) ? 0 : getIsConcurrent().hashCode());
hashCode = prime * hashCode
+ ((getSchedulingConfig() == null) ? 0 : getSchedulingConfig().hashCode());
hashCode = prime * hashCode
+ ((getScheduledJobRollouts() == null) ? 0 : getScheduledJobRollouts().hashCode());
hashCode = prime
* hashCode
+ ((getDestinationPackageVersions() == null) ? 0 : getDestinationPackageVersions()
.hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Job == false)
return false;
Job other = (Job) obj;
if (other.getJobArn() == null ^ this.getJobArn() == null)
return false;
if (other.getJobArn() != null && other.getJobArn().equals(this.getJobArn()) == false)
return false;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getTargetSelection() == null ^ this.getTargetSelection() == null)
return false;
if (other.getTargetSelection() != null
&& other.getTargetSelection().equals(this.getTargetSelection()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getForceCanceled() == null ^ this.getForceCanceled() == null)
return false;
if (other.getForceCanceled() != null
&& other.getForceCanceled().equals(this.getForceCanceled()) == false)
return false;
if (other.getReasonCode() == null ^ this.getReasonCode() == null)
return false;
if (other.getReasonCode() != null
&& other.getReasonCode().equals(this.getReasonCode()) == false)
return false;
if (other.getComment() == null ^ this.getComment() == null)
return false;
if (other.getComment() != null && other.getComment().equals(this.getComment()) == false)
return false;
if (other.getTargets() == null ^ this.getTargets() == null)
return false;
if (other.getTargets() != null && other.getTargets().equals(this.getTargets()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null
&& other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getPresignedUrlConfig() == null ^ this.getPresignedUrlConfig() == null)
return false;
if (other.getPresignedUrlConfig() != null
&& other.getPresignedUrlConfig().equals(this.getPresignedUrlConfig()) == false)
return false;
if (other.getJobExecutionsRolloutConfig() == null
^ this.getJobExecutionsRolloutConfig() == null)
return false;
if (other.getJobExecutionsRolloutConfig() != null
&& other.getJobExecutionsRolloutConfig().equals(
this.getJobExecutionsRolloutConfig()) == false)
return false;
if (other.getAbortConfig() == null ^ this.getAbortConfig() == null)
return false;
if (other.getAbortConfig() != null
&& other.getAbortConfig().equals(this.getAbortConfig()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null
&& other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getLastUpdatedAt() == null ^ this.getLastUpdatedAt() == null)
return false;
if (other.getLastUpdatedAt() != null
&& other.getLastUpdatedAt().equals(this.getLastUpdatedAt()) == false)
return false;
if (other.getCompletedAt() == null ^ this.getCompletedAt() == null)
return false;
if (other.getCompletedAt() != null
&& other.getCompletedAt().equals(this.getCompletedAt()) == false)
return false;
if (other.getJobProcessDetails() == null ^ this.getJobProcessDetails() == null)
return false;
if (other.getJobProcessDetails() != null
&& other.getJobProcessDetails().equals(this.getJobProcessDetails()) == false)
return false;
if (other.getTimeoutConfig() == null ^ this.getTimeoutConfig() == null)
return false;
if (other.getTimeoutConfig() != null
&& other.getTimeoutConfig().equals(this.getTimeoutConfig()) == false)
return false;
if (other.getNamespaceId() == null ^ this.getNamespaceId() == null)
return false;
if (other.getNamespaceId() != null
&& other.getNamespaceId().equals(this.getNamespaceId()) == false)
return false;
if (other.getJobTemplateArn() == null ^ this.getJobTemplateArn() == null)
return false;
if (other.getJobTemplateArn() != null
&& other.getJobTemplateArn().equals(this.getJobTemplateArn()) == false)
return false;
if (other.getJobExecutionsRetryConfig() == null
^ this.getJobExecutionsRetryConfig() == null)
return false;
if (other.getJobExecutionsRetryConfig() != null
&& other.getJobExecutionsRetryConfig().equals(this.getJobExecutionsRetryConfig()) == false)
return false;
if (other.getDocumentParameters() == null ^ this.getDocumentParameters() == null)
return false;
if (other.getDocumentParameters() != null
&& other.getDocumentParameters().equals(this.getDocumentParameters()) == false)
return false;
if (other.getIsConcurrent() == null ^ this.getIsConcurrent() == null)
return false;
if (other.getIsConcurrent() != null
&& other.getIsConcurrent().equals(this.getIsConcurrent()) == false)
return false;
if (other.getSchedulingConfig() == null ^ this.getSchedulingConfig() == null)
return false;
if (other.getSchedulingConfig() != null
&& other.getSchedulingConfig().equals(this.getSchedulingConfig()) == false)
return false;
if (other.getScheduledJobRollouts() == null ^ this.getScheduledJobRollouts() == null)
return false;
if (other.getScheduledJobRollouts() != null
&& other.getScheduledJobRollouts().equals(this.getScheduledJobRollouts()) == false)
return false;
if (other.getDestinationPackageVersions() == null
^ this.getDestinationPackageVersions() == null)
return false;
if (other.getDestinationPackageVersions() != null
&& other.getDestinationPackageVersions().equals(
this.getDestinationPackageVersions()) == false)
return false;
return true;
}
}