JobExecution (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobExecution
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The job execution object represents the execution of a job on a particular device.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobExecution()

Constructors
Constructor and Description
`JobExecution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobExecution`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getExecutionNumber()` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`Boolean`	`getForceCanceled()` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`String`	`getJobId()` The unique identifier you assigned to the job when it was created.
`Date`	`getLastUpdatedAt()` The time, in milliseconds since the epoch, when the job execution was last updated.
`Date`	`getQueuedAt()` The time, in milliseconds since the epoch, when the job execution was queued.
`Date`	`getStartedAt()` The time, in milliseconds since the epoch, when the job execution started.
`String`	`getStatus()` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
`JobExecutionStatusDetails`	`getStatusDetails()` A collection of name/value pairs that describe the status of the job execution.
`String`	`getThingArn()` The ARN of the thing on which the job execution is running.
`Long`	`getVersionNumber()` The version of the job execution.
`int`	`hashCode()`
`Boolean`	`isForceCanceled()` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExecutionNumber(Long executionNumber)` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`void`	`setForceCanceled(Boolean forceCanceled)` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`void`	`setJobId(String jobId)` The unique identifier you assigned to the job when it was created.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` The time, in milliseconds since the epoch, when the job execution was last updated.
`void`	`setQueuedAt(Date queuedAt)` The time, in milliseconds since the epoch, when the job execution was queued.
`void`	`setStartedAt(Date startedAt)` The time, in milliseconds since the epoch, when the job execution started.
`void`	`setStatus(String status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
`void`	`setStatusDetails(JobExecutionStatusDetails statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`void`	`setThingArn(String thingArn)` The ARN of the thing on which the job execution is running.
`void`	`setVersionNumber(Long versionNumber)` The version of the job execution.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`JobExecution`	`withExecutionNumber(Long executionNumber)` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`JobExecution`	`withForceCanceled(Boolean forceCanceled)` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`JobExecution`	`withJobId(String jobId)` The unique identifier you assigned to the job when it was created.
`JobExecution`	`withLastUpdatedAt(Date lastUpdatedAt)` The time, in milliseconds since the epoch, when the job execution was last updated.
`JobExecution`	`withQueuedAt(Date queuedAt)` The time, in milliseconds since the epoch, when the job execution was queued.
`JobExecution`	`withStartedAt(Date startedAt)` The time, in milliseconds since the epoch, when the job execution started.
`JobExecution`	`withStatus(JobExecutionStatus status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
`JobExecution`	`withStatus(String status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
`JobExecution`	`withStatusDetails(JobExecutionStatusDetails statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`JobExecution`	`withThingArn(String thingArn)` The ARN of the thing on which the job execution is running.
`JobExecution`	`withVersionNumber(Long versionNumber)` The version of the job execution.

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

- Constructor Detail
  - JobExecution
```
public JobExecution()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The unique identifier you assigned to the job when it was created.
    
    Parameters:
    
    jobId - The unique identifier you assigned to the job when it was created.
  - getJobId
```
public String getJobId()
```
    The unique identifier you assigned to the job when it was created.
    
    Returns:
    
    The unique identifier you assigned to the job when it was created.
  - withJobId
```
public JobExecution withJobId(String jobId)
```
    The unique identifier you assigned to the job when it was created.
    
    Parameters:
    
    jobId - The unique identifier you assigned to the job when it was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Parameters:
    
    status - The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - getStatus
```
public String getStatus()
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Returns:
    
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - withStatus
```
public JobExecution withStatus(String status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Parameters:
    
    status - The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionStatus
  - withStatus
```
public JobExecution withStatus(JobExecutionStatus status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Parameters:
    
    status - The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionStatus
  - setForceCanceled
```
public void setForceCanceled(Boolean forceCanceled)
```
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Parameters:
    
    forceCanceled - Will be true if the job execution was canceled with the optional force parameter set to true.
  - getForceCanceled
```
public Boolean getForceCanceled()
```
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job execution was canceled with the optional force parameter set to true.
  - withForceCanceled
```
public JobExecution withForceCanceled(Boolean forceCanceled)
```
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Parameters:
    
    forceCanceled - Will be true if the job execution 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 execution was canceled with the optional force parameter set to true.
    
    Returns:
    
    Will be true if the job execution was canceled with the optional force parameter set to true.
  - setStatusDetails
```
public void setStatusDetails(JobExecutionStatusDetails statusDetails)
```
    A collection of name/value pairs that describe the status of the job execution.
    
    Parameters:
    
    statusDetails - A collection of name/value pairs that describe the status of the job execution.
  - getStatusDetails
```
public JobExecutionStatusDetails getStatusDetails()
```
    A collection of name/value pairs that describe the status of the job execution.
    
    Returns:
    
    A collection of name/value pairs that describe the status of the job execution.
  - withStatusDetails
```
public JobExecution withStatusDetails(JobExecutionStatusDetails statusDetails)
```
    A collection of name/value pairs that describe the status of the job execution.
    
    Parameters:
    
    statusDetails - A collection of name/value pairs that describe the status of the job execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThingArn
```
public void setThingArn(String thingArn)
```
    The ARN of the thing on which the job execution is running.
    
    Parameters:
    
    thingArn - The ARN of the thing on which the job execution is running.
  - getThingArn
```
public String getThingArn()
```
    The ARN of the thing on which the job execution is running.
    
    Returns:
    
    The ARN of the thing on which the job execution is running.
  - withThingArn
```
public JobExecution withThingArn(String thingArn)
```
    The ARN of the thing on which the job execution is running.
    
    Parameters:
    
    thingArn - The ARN of the thing on which the job execution is running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueuedAt
```
public void setQueuedAt(Date queuedAt)
```
    The time, in milliseconds since the epoch, when the job execution was queued.
    
    Parameters:
    
    queuedAt - The time, in milliseconds since the epoch, when the job execution was queued.
  - getQueuedAt
```
public Date getQueuedAt()
```
    The time, in milliseconds since the epoch, when the job execution was queued.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job execution was queued.
  - withQueuedAt
```
public JobExecution withQueuedAt(Date queuedAt)
```
    The time, in milliseconds since the epoch, when the job execution was queued.
    
    Parameters:
    
    queuedAt - The time, in milliseconds since the epoch, when the job execution was queued.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Date startedAt)
```
    The time, in milliseconds since the epoch, when the job execution started.
    
    Parameters:
    
    startedAt - The time, in milliseconds since the epoch, when the job execution started.
  - getStartedAt
```
public Date getStartedAt()
```
    The time, in milliseconds since the epoch, when the job execution started.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job execution started.
  - withStartedAt
```
public JobExecution withStartedAt(Date startedAt)
```
    The time, in milliseconds since the epoch, when the job execution started.
    
    Parameters:
    
    startedAt - The time, in milliseconds since the epoch, when the job execution started.
    
    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 execution was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in milliseconds since the epoch, when the job execution was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The time, in milliseconds since the epoch, when the job execution was last updated.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job execution was last updated.
  - withLastUpdatedAt
```
public JobExecution withLastUpdatedAt(Date lastUpdatedAt)
```
    The time, in milliseconds since the epoch, when the job execution was last updated.
    
    Parameters:
    
    lastUpdatedAt - The time, in milliseconds since the epoch, when the job execution was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionNumber
```
public void setExecutionNumber(Long executionNumber)
```
    A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
    
    Parameters:
    
    executionNumber - A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
  - getExecutionNumber
```
public Long getExecutionNumber()
```
    A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
    
    Returns:
    
    A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
  - withExecutionNumber
```
public JobExecution withExecutionNumber(Long executionNumber)
```
    A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
    
    Parameters:
    
    executionNumber - A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionNumber
```
public void setVersionNumber(Long versionNumber)
```
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    Parameters:
    
    versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.
  - getVersionNumber
```
public Long getVersionNumber()
```
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    Returns:
    
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
  - withVersionNumber
```
public JobExecution withVersionNumber(Long versionNumber)
```
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    Parameters:
    
    versionNumber - The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    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 JobExecution 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 JobExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobExecution

Method Detail

setJobId

getJobId

withJobId

setStatus

getStatus

withStatus

withStatus

setForceCanceled

getForceCanceled

withForceCanceled

isForceCanceled

setStatusDetails

getStatusDetails

withStatusDetails

setThingArn

getThingArn

withThingArn

setQueuedAt

getQueuedAt

withQueuedAt

setStartedAt

getStartedAt

withStartedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setExecutionNumber

getExecutionNumber

withExecutionNumber

setVersionNumber

getVersionNumber

withVersionNumber

toString

equals

hashCode

clone

marshall