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)`
`Job`	`clearDocumentParametersEntries()` Removes all the entries added into DocumentParameters.
`Job`	`clone()`
`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.
`Map<String,String>`	`getDocumentParameters()` The parameters specified for the job document.
`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`, 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).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`setDocumentParameters(Map<String,String> documentParameters)` The parameters specified for the job document.
`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(String status)` The status of the job, one of `IN_PROGRESS`, `CANCELED`, 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).
`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`	`withDocumentParameters(Map<String,String> documentParameters)` The parameters specified for the job document.
`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`, or `COMPLETED`.
`Job`	`withStatus(String status)` The status of the job, one of `IN_PROGRESS`, `CANCELED`, 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).

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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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, or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
    
    Returns:
    
    The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(String status)
```
    The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, 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, or COMPLETED.
    
    Parameters:
    
    status - The status of the job, one of IN_PROGRESS, CANCELED, or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - 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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time, in milliseconds since the epoch, when the job was created.
    
    Parameters:
    
    createdAt - The time, in milliseconds since the epoch, when the job was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time, in milliseconds since the epoch, when the job was created.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job was created.
  - withCreatedAt
```
public Job withCreatedAt(Date createdAt)
```
    The time, in milliseconds since the epoch, when the job was created.
    
    Parameters:
    
    createdAt - The time, in milliseconds 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 milliseconds since the epoch, when the job was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in milliseconds since the epoch, when the job was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The time, in milliseconds since the epoch, when the job was last updated.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job was last updated.
  - withLastUpdatedAt
```
public Job withLastUpdatedAt(Date lastUpdatedAt)
```
    The time, in milliseconds since the epoch, when the job was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in milliseconds 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 milliseconds since the epoch, when the job was completed.
    
    Parameters:
    
    completedAt - The time, in milliseconds since the epoch, when the job was completed.
  - getCompletedAt
```
public Date getCompletedAt()
```
    The time, in milliseconds since the epoch, when the job was completed.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job was completed.
  - withCompletedAt
```
public Job withCompletedAt(Date completedAt)
```
    The time, in milliseconds since the epoch, when the job was completed.
    
    Parameters:
    
    completedAt - The time, in milliseconds 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.
  - getDocumentParameters
```
public Map<String,String> getDocumentParameters()
```
    The parameters specified for the job document.
    
    Returns:
    
    The parameters specified for the job document.
  - setDocumentParameters
```
public void setDocumentParameters(Map<String,String> documentParameters)
```
    The parameters specified for the job document.
    
    Parameters:
    
    documentParameters - The parameters specified for the job document.
  - withDocumentParameters
```
public Job withDocumentParameters(Map<String,String> documentParameters)
```
    The parameters specified for the job document.
    
    Parameters:
    
    documentParameters - The parameters specified for the job document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDocumentParametersEntry
```
public Job addDocumentParametersEntry(String key,
                                      String value)
```
  - 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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

setComment

getComment

withComment

getTargets

setTargets

withTargets

withTargets

setDescription

getDescription

withDescription

setPresignedUrlConfig

getPresignedUrlConfig

withPresignedUrlConfig

setJobExecutionsRolloutConfig

getJobExecutionsRolloutConfig

withJobExecutionsRolloutConfig

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setCompletedAt

getCompletedAt

withCompletedAt

setJobProcessDetails

getJobProcessDetails

withJobProcessDetails

getDocumentParameters

setDocumentParameters

withDocumentParameters

addDocumentParametersEntry

clearDocumentParametersEntries

toString

equals

hashCode

clone

marshall