@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Job extends Object implements Serializable, Cloneable, StructuredPojo
The Job
object contains details about a job.
Constructor and Description |
---|
Job() |
Modifier and Type | Method and Description |
---|---|
Job |
clone() |
boolean |
equals(Object obj) |
AbortConfig |
getAbortConfig()
Configuration for criteria to abort the job.
|
String |
getComment()
If the job was updated, describes the reason for the update.
|
Date |
getCompletedAt()
The time, in seconds since the epoch, when the job was completed.
|
Date |
getCreatedAt()
The time, in seconds 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 seconds since the epoch, when the job was last updated.
|
String |
getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
|
PresignedUrlConfig |
getPresignedUrlConfig()
Configuration for pre-signed S3 URLs.
|
String |
getReasonCode()
If the job was updated, provides the reason code for the update.
|
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 |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setAbortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
|
void |
setComment(String comment)
If the job was updated, describes the reason for the update.
|
void |
setCompletedAt(Date completedAt)
The time, in seconds since the epoch, when the job was completed.
|
void |
setCreatedAt(Date createdAt)
The time, in seconds 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 seconds since the epoch, when the job was last updated.
|
void |
setNamespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
void |
setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
|
void |
setReasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
|
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 |
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.
|
Job |
withAbortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
|
Job |
withComment(String comment)
If the job was updated, describes the reason for the update.
|
Job |
withCompletedAt(Date completedAt)
The time, in seconds since the epoch, when the job was completed.
|
Job |
withCreatedAt(Date createdAt)
The time, in seconds 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 seconds since the epoch, when the job was last updated.
|
Job |
withNamespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
Job |
withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
|
Job |
withReasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
|
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 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 String getJobArn()
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".
jobArn
- An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".public void setJobId(String jobId)
The unique identifier you assigned to this job when it was created.
jobId
- The unique identifier you assigned to this job when it was created.public String getJobId()
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.
jobId
- The unique identifier you assigned to this job when it was created.public 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.
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.TargetSelection
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.
TargetSelection
public 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.
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.TargetSelection
public 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.
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.TargetSelection
public void setStatus(String status)
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
status
- The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.JobStatus
public String getStatus()
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.JobStatus
public Job withStatus(String status)
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
status
- The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.JobStatus
public Job withStatus(JobStatus status)
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
status
- The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.JobStatus
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 Boolean getForceCanceled()
Will be true
if the job was canceled with the optional force
parameter set to
true
.
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
.
forceCanceled
- Will be true
if the job was canceled with the optional force
parameter set to
true
.public Boolean isForceCanceled()
Will be true
if the job was canceled with the optional force
parameter set to
true
.
true
if the job was canceled with the optional force
parameter set to
true
.public void setReasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
reasonCode
- If the job was updated, provides the reason code for the update.public String getReasonCode()
If the job was updated, provides the reason code for the update.
public Job withReasonCode(String reasonCode)
If the job was updated, provides the reason code for the update.
reasonCode
- If the job was updated, provides the reason code for the update.public void setComment(String comment)
If the job was updated, describes the reason for the update.
comment
- If the job was updated, describes the reason for the update.public String getComment()
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.
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.
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.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
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.
targets
- A list of IoT things and thing groups to which the job should be sent.public void setDescription(String description)
A short text description of the job.
description
- A short text description of the job.public String getDescription()
A short text description of the job.
public Job withDescription(String description)
A short text description of the job.
description
- A short text description of the job.public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
presignedUrlConfig
- Configuration for pre-signed S3 URLs.public PresignedUrlConfig getPresignedUrlConfig()
Configuration for pre-signed S3 URLs.
public Job withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration for pre-signed S3 URLs.
presignedUrlConfig
- Configuration for pre-signed S3 URLs.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 JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
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.
jobExecutionsRolloutConfig
- Allows you to create a staged rollout of a job.public void setAbortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
abortConfig
- Configuration for criteria to abort the job.public AbortConfig getAbortConfig()
Configuration for criteria to abort the job.
public Job withAbortConfig(AbortConfig abortConfig)
Configuration for criteria to abort the job.
abortConfig
- Configuration for criteria to abort the job.public void setCreatedAt(Date createdAt)
The time, in seconds since the epoch, when the job was created.
createdAt
- The time, in seconds since the epoch, when the job was created.public Date getCreatedAt()
The time, in seconds since the epoch, when the job was created.
public Job withCreatedAt(Date createdAt)
The time, in seconds since the epoch, when the job was created.
createdAt
- The time, in seconds since the epoch, when the job was created.public void setLastUpdatedAt(Date lastUpdatedAt)
The time, in seconds since the epoch, when the job was last updated.
lastUpdatedAt
- The time, in seconds since the epoch, when the job was last updated.public Date getLastUpdatedAt()
The time, in seconds since the epoch, when the job was last updated.
public Job withLastUpdatedAt(Date lastUpdatedAt)
The time, in seconds since the epoch, when the job was last updated.
lastUpdatedAt
- The time, in seconds since the epoch, when the job was last updated.public void setCompletedAt(Date completedAt)
The time, in seconds since the epoch, when the job was completed.
completedAt
- The time, in seconds since the epoch, when the job was completed.public Date getCompletedAt()
The time, in seconds since the epoch, when the job was completed.
public Job withCompletedAt(Date completedAt)
The time, in seconds since the epoch, when the job was completed.
completedAt
- The time, in seconds since the epoch, when the job was completed.public void setJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
jobProcessDetails
- Details about the job process.public JobProcessDetails getJobProcessDetails()
Details about the job process.
public Job withJobProcessDetails(JobProcessDetails jobProcessDetails)
Details about the job process.
jobProcessDetails
- Details about the job process.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 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
.
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
.
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 void setNamespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
public String getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
public Job withNamespaceId(String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId
feature is in public preview.
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2021. All rights reserved.