public class Job extends Object implements Serializable
The Job object contains details about a job.
| Constructor and Description |
|---|
Job() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getComment()
If the job was updated, describes the reason for the update.
|
Date |
getCompletedAt()
The time, in milliseconds since the epoch, when the job was completed.
|
Date |
getCreatedAt()
The time, in milliseconds since the epoch, when the job was created.
|
String |
getDescription()
A short text description of the job.
|
Boolean |
getForceCanceled()
Will be
true if the job was canceled with the optional
force parameter set to true. |
String |
getJobArn()
An ARN identifying the job with format
"arn:aws:iot:region:account:job/jobId".
|
JobExecutionsRolloutConfig |
getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of a job.
|
String |
getJobId()
The unique identifier you assigned to this job when it was created.
|
JobProcessDetails |
getJobProcessDetails()
Details about the job process.
|
Date |
getLastUpdatedAt()
The time, in milliseconds since the epoch, when the job was last updated.
|
PresignedUrlConfig |
getPresignedUrlConfig()
Configuration for pre-signed S3 URLs.
|
String |
getStatus()
The status of the job, one of
IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED. |
List<String> |
getTargets()
A list of IoT things and thing groups to which the job should be sent.
|
String |
getTargetSelection()
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).
|
TimeoutConfig |
getTimeoutConfig()
Specifies the amount of time each device has to finish its execution of
the job.
|
int |
hashCode() |
Boolean |
isForceCanceled()
Will be
true if the job was canceled with the optional
force parameter set to true. |
void |
setComment(String comment)
If the job was updated, describes the reason for the update.
|
void |
setCompletedAt(Date completedAt)
The time, in milliseconds since the epoch, when the job was completed.
|
void |
setCreatedAt(Date createdAt)
The time, in milliseconds since the epoch, when the job was created.
|
void |
setDescription(String description)
A short text description of the job.
|
void |
setForceCanceled(Boolean forceCanceled)
Will be
true if the job was canceled with the optional
force parameter set to true. |
void |
setJobArn(String jobArn)
An ARN identifying the job with format
"arn:aws:iot:region:account:job/jobId".
|
void |
setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
|
void |
setJobId(String jobId)
The unique identifier you assigned to this job when it was created.
|
void |
setJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
|
void |
setLastUpdatedAt(Date lastUpdatedAt)
The time, in milliseconds since the epoch, when the job was last updated.
|
void |
setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
|
void |
setStatus(JobStatus status)
The status of the job, one of
IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED. |
void |
setStatus(String status)
The status of the job, one of
IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED. |
void |
setTargets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
|
void |
setTargetSelection(String targetSelection)
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).
|
void |
setTargetSelection(TargetSelection targetSelection)
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).
|
void |
setTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Job |
withComment(String comment)
If the job was updated, describes the reason for the update.
|
Job |
withCompletedAt(Date completedAt)
The time, in milliseconds since the epoch, when the job was completed.
|
Job |
withCreatedAt(Date createdAt)
The time, in milliseconds since the epoch, when the job was created.
|
Job |
withDescription(String description)
A short text description of the job.
|
Job |
withForceCanceled(Boolean forceCanceled)
Will be
true if the job was canceled with the optional
force parameter set to true. |
Job |
withJobArn(String jobArn)
An ARN identifying the job with format
"arn:aws:iot:region:account:job/jobId".
|
Job |
withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
|
Job |
withJobId(String jobId)
The unique identifier you assigned to this job when it was created.
|
Job |
withJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
|
Job |
withLastUpdatedAt(Date lastUpdatedAt)
The time, in milliseconds since the epoch, when the job was last updated.
|
Job |
withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
|
Job |
withStatus(JobStatus status)
The status of the job, one of
IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED. |
Job |
withStatus(String status)
The status of the job, one of
IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED. |
Job |
withTargets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
|
Job |
withTargets(String... targets)
A list of IoT things and thing groups to which the job should be sent.
|
Job |
withTargetSelection(String targetSelection)
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).
|
Job |
withTargetSelection(TargetSelection targetSelection)
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).
|
Job |
withTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
public String getJobArn()
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
public void setJobArn(String jobArn)
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
public Job withJobArn(String jobArn)
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
Returns a reference to this object so that method calls can be chained together.
jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
public String getJobId()
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
The unique identifier you assigned to this job when it was created.
public void setJobId(String jobId)
The unique identifier you assigned to this job when it was created.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId - The unique identifier you assigned to this job when it was created.
public Job withJobId(String jobId)
The unique identifier you assigned to this job when it was created.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId - The unique identifier you assigned to this job when it was created.
public String getTargetSelection()
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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelectionpublic void setTargetSelection(String targetSelection)
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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection - 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.
TargetSelectionpublic Job withTargetSelection(String targetSelection)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection - 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.
TargetSelectionpublic void setTargetSelection(TargetSelection targetSelection)
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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection - 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.
TargetSelectionpublic Job withTargetSelection(TargetSelection targetSelection)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection - 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.
TargetSelectionpublic String getStatus()
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
JobStatuspublic void setStatus(String status)
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
status -
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
JobStatuspublic Job withStatus(String status)
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
status -
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
JobStatuspublic void setStatus(JobStatus status)
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
status -
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
JobStatuspublic Job withStatus(JobStatus status)
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED,
DELETION_IN_PROGRESS
status -
The status of the job, one of IN_PROGRESS,
CANCELED, DELETION_IN_PROGRESS or
COMPLETED.
JobStatuspublic Boolean isForceCanceled()
Will be true if the job was canceled with the optional
force parameter set to true.
Will be true if the job was canceled with the
optional force parameter set to true.
public Boolean getForceCanceled()
Will be true if the job was canceled with the optional
force parameter set to true.
Will be true if the job was canceled with the
optional force parameter set to true.
public void setForceCanceled(Boolean forceCanceled)
Will be true if the job was canceled with the optional
force parameter set to true.
forceCanceled -
Will be true if the job was canceled with the
optional force parameter set to true
.
public Job withForceCanceled(Boolean forceCanceled)
Will be true if the job was canceled with the optional
force parameter set to true.
Returns a reference to this object so that method calls can be chained together.
forceCanceled -
Will be true if the job was canceled with the
optional force parameter set to true
.
public String getComment()
If the job was updated, describes the reason for the update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
If the job was updated, describes the reason for the update.
public void setComment(String comment)
If the job was updated, describes the reason for the update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
comment - If the job was updated, describes the reason for the update.
public Job withComment(String comment)
If the job was updated, describes the reason for the update.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
comment - If the job was updated, describes the reason for the update.
public List<String> getTargets()
A list of IoT things and thing groups to which the job should be sent.
A list of IoT things and thing groups to which the job should be sent.
public void setTargets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
targets - A list of IoT things and thing groups to which the job should be sent.
public Job withTargets(String... targets)
A list of IoT things and thing groups to which the job should be sent.
Returns a reference to this object so that method calls can be chained together.
targets - A list of IoT things and thing groups to which the job should be sent.
public Job withTargets(Collection<String> targets)
A list of IoT things and thing groups to which the job should be sent.
Returns a reference to this object so that method calls can be chained together.
targets - A list of IoT things and thing groups to which the job should be sent.
public String getDescription()
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
A short text description of the job.
public void setDescription(String description)
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description - A short text description of the job.
public Job withDescription(String description)
A short text description of the job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description - A short text description of the job.
public PresignedUrlConfig getPresignedUrlConfig()
Configuration for pre-signed S3 URLs.
Configuration for pre-signed S3 URLs.
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
presignedUrlConfig - Configuration for pre-signed S3 URLs.
public Job withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
Returns a reference to this object so that method calls can be chained together.
presignedUrlConfig - Configuration for pre-signed S3 URLs.
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of a job.
Allows you to create a staged rollout of a job.
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.
public Job withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of a job.
Returns a reference to this object so that method calls can be chained together.
jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.
public Date getCreatedAt()
The time, in milliseconds since the epoch, when the job was created.
The time, in milliseconds since the epoch, when the job was created.
public void setCreatedAt(Date createdAt)
The time, in milliseconds since the epoch, when the job was created.
createdAt - The time, in milliseconds since the epoch, when the job was created.
public Job withCreatedAt(Date createdAt)
The time, in milliseconds since the epoch, when the job was created.
Returns a reference to this object so that method calls can be chained together.
createdAt - The time, in milliseconds since the epoch, when the job was created.
public Date getLastUpdatedAt()
The time, in milliseconds since the epoch, when the job was last updated.
The time, in milliseconds since the epoch, when the job was last updated.
public void setLastUpdatedAt(Date lastUpdatedAt)
The time, in milliseconds since the epoch, when the job was last updated.
lastUpdatedAt - The time, in milliseconds since the epoch, when the job was last updated.
public Job withLastUpdatedAt(Date lastUpdatedAt)
The time, in milliseconds since the epoch, when the job was last updated.
Returns a reference to this object so that method calls can be chained together.
lastUpdatedAt - The time, in milliseconds since the epoch, when the job was last updated.
public Date getCompletedAt()
The time, in milliseconds since the epoch, when the job was completed.
The time, in milliseconds since the epoch, when the job was completed.
public void setCompletedAt(Date completedAt)
The time, in milliseconds since the epoch, when the job was completed.
completedAt - The time, in milliseconds since the epoch, when the job was completed.
public Job withCompletedAt(Date completedAt)
The time, in milliseconds since the epoch, when the job was completed.
Returns a reference to this object so that method calls can be chained together.
completedAt - The time, in milliseconds since the epoch, when the job was completed.
public JobProcessDetails getJobProcessDetails()
Details about the job process.
Details about the job process.
public void setJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
jobProcessDetails - Details about the job process.
public Job withJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
Returns a reference to this object so that method calls can be chained together.
jobProcessDetails - Details about the job process.
public TimeoutConfig getTimeoutConfig()
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
IN_PROGRESS. If the job execution status is not set to
another terminal state before the timer expires, it will be automatically
set to TIMED_OUT.
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 IN_PROGRESS. If the job execution
status is not set to another terminal state before the timer
expires, it will be automatically set to TIMED_OUT.
public void setTimeoutConfig(TimeoutConfig timeoutConfig)
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
IN_PROGRESS. If the job execution status is not set to
another terminal state before the timer expires, it will be automatically
set to TIMED_OUT.
timeoutConfig -
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 IN_PROGRESS. If the
job execution status is not set to another terminal state
before the timer expires, it will be automatically set to
TIMED_OUT.
public Job withTimeoutConfig(TimeoutConfig timeoutConfig)
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
IN_PROGRESS. If the job execution status is not set to
another terminal state before the timer expires, it will be automatically
set to TIMED_OUT.
Returns a reference to this object so that method calls can be chained together.
timeoutConfig -
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 IN_PROGRESS. If the
job execution status is not set to another terminal state
before the timer expires, it will be automatically set to
TIMED_OUT.
public String toString()
toString in class ObjectObject.toString()Copyright © 2018. All rights reserved.