Job (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@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.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Job()

Constructors
Constructor and Description
`Job()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Job`	`addDocumentParametersEntry(String key, String value)` Add a single DocumentParameters entry
`Job`	`clearDocumentParametersEntries()` Removes all the entries added into DocumentParameters.
`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.
`Map<String,String>`	`getDocumentParameters()` A key-value map that pairs the patterns that need to be replaced in a managed template job document schema.
`Boolean`	`getForceCanceled()` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`Boolean`	`getIsConcurrent()` Indicates whether a job is concurrent.
`String`	`getJobArn()` An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
`JobExecutionsRetryConfig`	`getJobExecutionsRetryConfig()` The configuration for the criteria to retry the job.
`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.
`String`	`getJobTemplateArn()` The ARN of the job template used to create the job.
`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`	`isConcurrent()` Indicates whether a job is concurrent.
`Boolean`	`isForceCanceled()` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `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`	`setDocumentParameters(Map<String,String> documentParameters)` A key-value map that pairs the patterns that need to be replaced in a managed template job document schema.
`void`	`setForceCanceled(Boolean forceCanceled)` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`void`	`setIsConcurrent(Boolean isConcurrent)` Indicates whether a job is concurrent.
`void`	`setJobArn(String jobArn)` An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
`void`	`setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)` The configuration for the criteria to retry the job.
`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`	`setJobTemplateArn(String jobTemplateArn)` The ARN of the job template used to create the job.
`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`	`withDocumentParameters(Map<String,String> documentParameters)` A key-value map that pairs the patterns that need to be replaced in a managed template job document schema.
`Job`	`withForceCanceled(Boolean forceCanceled)` Will be `true` if the job was canceled with the optional `force` parameter set to `true`.
`Job`	`withIsConcurrent(Boolean isConcurrent)` Indicates whether a job is concurrent.
`Job`	`withJobArn(String jobArn)` An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
`Job`	`withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)` The configuration for the criteria to retry the job.
`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`	`withJobTemplateArn(String jobTemplateArn)` The ARN of the job template used to create the job.
`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.

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

- Constructor Detail
  - Job
```
public Job()
```
- Method Detail
  - setJobArn
```
public void setJobArn(String jobArn)
```
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Parameters:
    
    jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
  - getJobArn
```
public String getJobArn()
```
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Returns:
    
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
  - withJobArn
```
public Job withJobArn(String jobArn)
```
    An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Parameters:
    
    jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The unique identifier you assigned to this job when it was created.
    
    Parameters:
    
    jobId - The unique identifier you assigned to this job when it was created.
  - getJobId
```
public String getJobId()
```
    The unique identifier you assigned to this job when it was created.
    
    Returns:
    
    The unique identifier you assigned to this job when it was created.
  - withJobId
```
public Job withJobId(String jobId)
```
    The unique identifier you assigned to this job when it was created.
    
    Parameters:
    
    jobId - The unique identifier you assigned to this job when it was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetSelection
```
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.
    
    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.
    
    Parameters:
    
    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.
    
    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.
    
    See Also:
    
    TargetSelection
  - getTargetSelection
```
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.
    
    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.
    
    Returns:
    
    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.
    
    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.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
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.
    
    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.
    
    Parameters:
    
    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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
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.
    
    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.
    
    Parameters:
    
    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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - setStatus
```
public void setStatus(String status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Returns:
    
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(String status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(JobStatus status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setForceCanceled
```
public void setForceCanceled(Boolean forceCanceled)
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Parameters:
    
    forceCanceled - Will be true if the job was canceled with the optional force parameter set to true.
  - getForceCanceled
```
public Boolean getForceCanceled()
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job was canceled with the optional force parameter set to true.
  - withForceCanceled
```
public Job withForceCanceled(Boolean forceCanceled)
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Parameters:
    
    forceCanceled - Will be true if the job was canceled with the optional force parameter set to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isForceCanceled
```
public Boolean isForceCanceled()
```
    Will be true if the job was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job was canceled with the optional force parameter set to true.
  - setReasonCode
```
public void setReasonCode(String reasonCode)
```
    If the job was updated, provides the reason code for the update.
    
    Parameters:
    
    reasonCode - If the job was updated, provides the reason code for the update.
  - getReasonCode
```
public String getReasonCode()
```
    If the job was updated, provides the reason code for the update.
    
    Returns:
    
    If the job was updated, provides the reason code for the update.
  - withReasonCode
```
public Job withReasonCode(String reasonCode)
```
    If the job was updated, provides the reason code for the update.
    
    Parameters:
    
    reasonCode - If the job was updated, provides the reason code for the update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComment
```
public void setComment(String comment)
```
    If the job was updated, describes the reason for the update.
    
    Parameters:
    
    comment - If the job was updated, describes the reason for the update.
  - getComment
```
public String getComment()
```
    If the job was updated, describes the reason for the update.
    
    Returns:
    
    If the job was updated, describes the reason for the update.
  - withComment
```
public Job withComment(String comment)
```
    If the job was updated, describes the reason for the update.
    
    Parameters:
    
    comment - If the job was updated, describes the reason for the update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<String> getTargets()
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Returns:
    
    A list of IoT things and thing groups to which the job should be sent.
  - setTargets
```
public void setTargets(Collection<String> targets)
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of IoT things and thing groups to which the job should be sent.
  - withTargets
```
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.
    
    Parameters:
    
    targets - A list of IoT things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public Job withTargets(Collection<String> targets)
```
    A list of IoT things and thing groups to which the job should be sent.
    
    Parameters:
    
    targets - A list of IoT things and thing groups to which the job should be sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A short text description of the job.
    
    Parameters:
    
    description - A short text description of the job.
  - getDescription
```
public String getDescription()
```
    A short text description of the job.
    
    Returns:
    
    A short text description of the job.
  - withDescription
```
public Job withDescription(String description)
```
    A short text description of the job.
    
    Parameters:
    
    description - A short text description of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPresignedUrlConfig
```
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig - Configuration for pre-signed S3 URLs.
  - getPresignedUrlConfig
```
public PresignedUrlConfig getPresignedUrlConfig()
```
    Configuration for pre-signed S3 URLs.
    
    Returns:
    
    Configuration for pre-signed S3 URLs.
  - withPresignedUrlConfig
```
public Job withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
```
    Configuration for pre-signed S3 URLs.
    
    Parameters:
    
    presignedUrlConfig - Configuration for pre-signed S3 URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobExecutionsRolloutConfig
```
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of a job.
    
    Parameters:
    
    jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.
  - getJobExecutionsRolloutConfig
```
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
```
    Allows you to create a staged rollout of a job.
    
    Returns:
    
    Allows you to create a staged rollout of a job.
  - withJobExecutionsRolloutConfig
```
public Job withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
```
    Allows you to create a staged rollout of a job.
    
    Parameters:
    
    jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAbortConfig
```
public void setAbortConfig(AbortConfig abortConfig)
```
    Configuration for criteria to abort the job.
    
    Parameters:
    
    abortConfig - Configuration for criteria to abort the job.
  - getAbortConfig
```
public AbortConfig getAbortConfig()
```
    Configuration for criteria to abort the job.
    
    Returns:
    
    Configuration for criteria to abort the job.
  - withAbortConfig
```
public Job withAbortConfig(AbortConfig abortConfig)
```
    Configuration for criteria to abort the job.
    
    Parameters:
    
    abortConfig - Configuration for criteria to abort the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time, in seconds since the epoch, when the job was created.
    
    Parameters:
    
    createdAt - The time, in seconds since the epoch, when the job was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time, in seconds since the epoch, when the job was created.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was created.
  - withCreatedAt
```
public Job withCreatedAt(Date createdAt)
```
    The time, in seconds since the epoch, when the job was created.
    
    Parameters:
    
    createdAt - The time, in seconds since the epoch, when the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    The time, in seconds since the epoch, when the job was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The time, in seconds since the epoch, when the job was last updated.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was last updated.
  - withLastUpdatedAt
```
public Job withLastUpdatedAt(Date lastUpdatedAt)
```
    The time, in seconds since the epoch, when the job was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletedAt
```
public void setCompletedAt(Date completedAt)
```
    The time, in seconds since the epoch, when the job was completed.
    
    Parameters:
    
    completedAt - The time, in seconds since the epoch, when the job was completed.
  - getCompletedAt
```
public Date getCompletedAt()
```
    The time, in seconds since the epoch, when the job was completed.
    
    Returns:
    
    The time, in seconds since the epoch, when the job was completed.
  - withCompletedAt
```
public Job withCompletedAt(Date completedAt)
```
    The time, in seconds since the epoch, when the job was completed.
    
    Parameters:
    
    completedAt - The time, in seconds since the epoch, when the job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobProcessDetails
```
public void setJobProcessDetails(JobProcessDetails jobProcessDetails)
```
    Details about the job process.
    
    Parameters:
    
    jobProcessDetails - Details about the job process.
  - getJobProcessDetails
```
public JobProcessDetails getJobProcessDetails()
```
    Details about the job process.
    
    Returns:
    
    Details about the job process.
  - withJobProcessDetails
```
public Job withJobProcessDetails(JobProcessDetails jobProcessDetails)
```
    Details about the job process.
    
    Parameters:
    
    jobProcessDetails - Details about the job process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutConfig
```
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.
    
    Parameters:
    
    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.
  - getTimeoutConfig
```
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.
    
    Returns:
    
    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.
  - withTimeoutConfig
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespaceId
```
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, Amazon Web Services 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.
    
    Parameters:
    
    namespaceId - The namespace used to indicate that a job is a customer-managed job.
    
    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.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
  - getNamespaceId
```
public String getNamespaceId()
```
    The namespace used to indicate that a job is a customer-managed job.
    
    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.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
    
    Returns:
    
    The namespace used to indicate that a job is a customer-managed job.
    
    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.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
  - withNamespaceId
```
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, Amazon Web Services 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.
    
    Parameters:
    
    namespaceId - The namespace used to indicate that a job is a customer-managed job.
    
    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.
    
    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
    
    The namespaceId feature is in public preview.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobTemplateArn
```
public void setJobTemplateArn(String jobTemplateArn)
```
    The ARN of the job template used to create the job.
    
    Parameters:
    
    jobTemplateArn - The ARN of the job template used to create the job.
  - getJobTemplateArn
```
public String getJobTemplateArn()
```
    The ARN of the job template used to create the job.
    
    Returns:
    
    The ARN of the job template used to create the job.
  - withJobTemplateArn
```
public Job withJobTemplateArn(String jobTemplateArn)
```
    The ARN of the job template used to create the job.
    
    Parameters:
    
    jobTemplateArn - The ARN of the job template used to create the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobExecutionsRetryConfig
```
public void setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
```
    The configuration for the criteria to retry the job.
    
    Parameters:
    
    jobExecutionsRetryConfig - The configuration for the criteria to retry the job.
  - getJobExecutionsRetryConfig
```
public JobExecutionsRetryConfig getJobExecutionsRetryConfig()
```
    The configuration for the criteria to retry the job.
    
    Returns:
    
    The configuration for the criteria to retry the job.
  - withJobExecutionsRetryConfig
```
public Job withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)
```
    The configuration for the criteria to retry the job.
    
    Parameters:
    
    jobExecutionsRetryConfig - The configuration for the criteria to retry the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDocumentParameters
```
public Map<String,String> getDocumentParameters()
```
    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.
    
    documentParameters 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.
    
    Returns:
    
    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.
    
    documentParameters 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.
  - setDocumentParameters
```
public void setDocumentParameters(Map<String,String> documentParameters)
```
    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.
    
    documentParameters 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.
    
    Parameters:
    
    documentParameters - 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.
    
    documentParameters 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.
  - withDocumentParameters
```
public Job withDocumentParameters(Map<String,String> documentParameters)
```
    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.
    
    documentParameters 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.
    
    Parameters:
    
    documentParameters - 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.
    
    documentParameters 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDocumentParametersEntry
```
public Job addDocumentParametersEntry(String key,
                                      String value)
```
    Add a single DocumentParameters entry
    
    See Also:
    
    withDocumentParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearDocumentParametersEntries
```
public Job clearDocumentParametersEntries()
```
    Removes all the entries added into DocumentParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsConcurrent
```
public void setIsConcurrent(Boolean isConcurrent)
```
    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.
    
    Parameters:
    
    isConcurrent - 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.
  - getIsConcurrent
```
public Boolean getIsConcurrent()
```
    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.
    
    Returns:
    
    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.
  - withIsConcurrent
```
public Job withIsConcurrent(Boolean isConcurrent)
```
    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.
    
    Parameters:
    
    isConcurrent - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isConcurrent
```
public Boolean isConcurrent()
```
    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.
    
    Returns:
    
    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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Job clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Job

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Method Detail

setJobArn

getJobArn

withJobArn

setJobId

getJobId

withJobId

setTargetSelection

getTargetSelection

withTargetSelection

withTargetSelection

setStatus

getStatus

withStatus

withStatus

setForceCanceled

getForceCanceled

withForceCanceled

isForceCanceled

setReasonCode

getReasonCode

withReasonCode

setComment

getComment

withComment

getTargets

setTargets

withTargets

withTargets

setDescription

getDescription

withDescription

setPresignedUrlConfig

getPresignedUrlConfig

withPresignedUrlConfig

setJobExecutionsRolloutConfig

getJobExecutionsRolloutConfig

withJobExecutionsRolloutConfig

setAbortConfig

getAbortConfig

withAbortConfig

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setCompletedAt

getCompletedAt

withCompletedAt

setJobProcessDetails

getJobProcessDetails

withJobProcessDetails

setTimeoutConfig

getTimeoutConfig

withTimeoutConfig

setNamespaceId

getNamespaceId

withNamespaceId

setJobTemplateArn

getJobTemplateArn

withJobTemplateArn

setJobExecutionsRetryConfig

getJobExecutionsRetryConfig

withJobExecutionsRetryConfig

getDocumentParameters

setDocumentParameters

withDocumentParameters

addDocumentParametersEntry

clearDocumentParametersEntries

setIsConcurrent

getIsConcurrent

withIsConcurrent