JobExecution (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class JobExecution
extends java.lang.Object
implements java.io.Serializable
```
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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Long`	`getApproximateSecondsBeforeTimedOut()` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`java.lang.Long`	`getExecutionNumber()` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`java.lang.Boolean`	`getForceCanceled()` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`java.lang.String`	`getJobId()` The unique identifier you assigned to the job when it was created.
`java.util.Date`	`getLastUpdatedAt()` The time, in seconds since the epoch, when the job execution was last updated.
`java.util.Date`	`getQueuedAt()` The time, in seconds since the epoch, when the job execution was queued.
`java.util.Date`	`getStartedAt()` The time, in seconds since the epoch, when the job execution started.
`java.lang.String`	`getStatus()` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`JobExecutionStatusDetails`	`getStatusDetails()` A collection of name/value pairs that describe the status of the job execution.
`java.lang.String`	`getThingArn()` The ARN of the thing on which the job execution is running.
`java.lang.Long`	`getVersionNumber()` The version of the job execution.
`int`	`hashCode()`
`java.lang.Boolean`	`isForceCanceled()` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`void`	`setApproximateSecondsBeforeTimedOut(java.lang.Long approximateSecondsBeforeTimedOut)` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`void`	`setExecutionNumber(java.lang.Long executionNumber)` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`void`	`setForceCanceled(java.lang.Boolean forceCanceled)` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`void`	`setJobId(java.lang.String jobId)` The unique identifier you assigned to the job when it was created.
`void`	`setLastUpdatedAt(java.util.Date lastUpdatedAt)` The time, in seconds since the epoch, when the job execution was last updated.
`void`	`setQueuedAt(java.util.Date queuedAt)` The time, in seconds since the epoch, when the job execution was queued.
`void`	`setStartedAt(java.util.Date startedAt)` The time, in seconds since the epoch, when the job execution started.
`void`	`setStatus(JobExecutionStatus status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`void`	`setStatus(java.lang.String status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`void`	`setStatusDetails(JobExecutionStatusDetails statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`void`	`setThingArn(java.lang.String thingArn)` The ARN of the thing on which the job execution is running.
`void`	`setVersionNumber(java.lang.Long versionNumber)` The version of the job execution.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`JobExecution`	`withApproximateSecondsBeforeTimedOut(java.lang.Long approximateSecondsBeforeTimedOut)` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`JobExecution`	`withExecutionNumber(java.lang.Long executionNumber)` A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device.
`JobExecution`	`withForceCanceled(java.lang.Boolean forceCanceled)` Will be `true` if the job execution was canceled with the optional `force` parameter set to `true`.
`JobExecution`	`withJobId(java.lang.String jobId)` The unique identifier you assigned to the job when it was created.
`JobExecution`	`withLastUpdatedAt(java.util.Date lastUpdatedAt)` The time, in seconds since the epoch, when the job execution was last updated.
`JobExecution`	`withQueuedAt(java.util.Date queuedAt)` The time, in seconds since the epoch, when the job execution was queued.
`JobExecution`	`withStartedAt(java.util.Date startedAt)` The time, in seconds since the epoch, when the job execution started.
`JobExecution`	`withStatus(JobExecutionStatus status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`JobExecution`	`withStatus(java.lang.String status)` The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
`JobExecution`	`withStatusDetails(JobExecutionStatusDetails statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`JobExecution`	`withThingArn(java.lang.String thingArn)` The ARN of the thing on which the job execution is running.
`JobExecution`	`withVersionNumber(java.lang.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
  - getJobId
```
public java.lang.String getJobId()
```
    The unique identifier you assigned to the job when it was created.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Returns:
    
    The unique identifier you assigned to the job when it was created.
  - setJobId
```
public void setJobId(java.lang.String jobId)
```
    The unique identifier you assigned to the job when it was created.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    jobId -
    The unique identifier you assigned to the job when it was created.
  - withJobId
```
public JobExecution withJobId(java.lang.String jobId)
```
    The unique identifier you assigned to the job when it was created.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    jobId -
    The unique identifier you assigned to the job when it was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public java.lang.String getStatus()
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Constraints:
    Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
    
    Returns:
    
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - setStatus
```
public void setStatus(java.lang.String status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Constraints:
    Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
    
    Parameters:
    
    status -
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - withStatus
```
public JobExecution withStatus(java.lang.String status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
    
    Parameters:
    
    status -
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionStatus
  - setStatus
```
public void setStatus(JobExecutionStatus status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Constraints:
    Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
    
    Parameters:
    
    status -
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    See Also:
    
    JobExecutionStatus
  - withStatus
```
public JobExecution withStatus(JobExecutionStatus status)
```
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED
    
    Parameters:
    
    status -
    The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionStatus
  - isForceCanceled
```
public java.lang.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.
  - getForceCanceled
```
public java.lang.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.
  - setForceCanceled
```
public void setForceCanceled(java.lang.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.
  - withForceCanceled
```
public JobExecution withForceCanceled(java.lang.Boolean forceCanceled)
```
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    forceCanceled -
    Will be true if the job execution was canceled with the optional force parameter set to true.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withStatusDetails
```
public JobExecution withStatusDetails(JobExecutionStatusDetails statusDetails)
```
    A collection of name/value pairs that describe the status of the job execution.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    statusDetails -
    A collection of name/value pairs that describe the status of the job execution.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingArn
```
public java.lang.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.
  - setThingArn
```
public void setThingArn(java.lang.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.
  - withThingArn
```
public JobExecution withThingArn(java.lang.String thingArn)
```
    The ARN of the thing on which the job execution is running.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    thingArn -
    The ARN of the thing on which the job execution is running.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getQueuedAt
```
public java.util.Date getQueuedAt()
```
    The time, in seconds since the epoch, when the job execution was queued.
    
    Returns:
    
    The time, in seconds since the epoch, when the job execution was queued.
  - setQueuedAt
```
public void setQueuedAt(java.util.Date queuedAt)
```
    The time, in seconds since the epoch, when the job execution was queued.
    
    Parameters:
    
    queuedAt -
    The time, in seconds since the epoch, when the job execution was queued.
  - withQueuedAt
```
public JobExecution withQueuedAt(java.util.Date queuedAt)
```
    The time, in seconds since the epoch, when the job execution was queued.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    queuedAt -
    The time, in seconds since the epoch, when the job execution was queued.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStartedAt
```
public java.util.Date getStartedAt()
```
    The time, in seconds since the epoch, when the job execution started.
    
    Returns:
    
    The time, in seconds since the epoch, when the job execution started.
  - setStartedAt
```
public void setStartedAt(java.util.Date startedAt)
```
    The time, in seconds since the epoch, when the job execution started.
    
    Parameters:
    
    startedAt -
    The time, in seconds since the epoch, when the job execution started.
  - withStartedAt
```
public JobExecution withStartedAt(java.util.Date startedAt)
```
    The time, in seconds since the epoch, when the job execution started.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    startedAt -
    The time, in seconds since the epoch, when the job execution started.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLastUpdatedAt
```
public java.util.Date getLastUpdatedAt()
```
    The time, in seconds since the epoch, when the job execution was last updated.
    
    Returns:
    
    The time, in seconds since the epoch, when the job execution was last updated.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(java.util.Date lastUpdatedAt)
```
    The time, in seconds since the epoch, when the job execution was last updated.
    
    Parameters:
    
    lastUpdatedAt -
    The time, in seconds since the epoch, when the job execution was last updated.
  - withLastUpdatedAt
```
public JobExecution withLastUpdatedAt(java.util.Date lastUpdatedAt)
```
    The time, in seconds since the epoch, when the job execution was last updated.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastUpdatedAt -
    The time, in seconds since the epoch, when the job execution was last updated.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExecutionNumber
```
public java.lang.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.
  - setExecutionNumber
```
public void setExecutionNumber(java.lang.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.
  - withExecutionNumber
```
public JobExecution withExecutionNumber(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getVersionNumber
```
public java.lang.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.
  - setVersionNumber
```
public void setVersionNumber(java.lang.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.
  - withVersionNumber
```
public JobExecution withVersionNumber(java.lang.Long versionNumber)
```
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    versionNumber -
    The version of the job execution. Job execution versions are incremented each time they are updated by a device.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getApproximateSecondsBeforeTimedOut
```
public java.lang.Long getApproximateSecondsBeforeTimedOut()
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
    
    Returns:
    
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
  - setApproximateSecondsBeforeTimedOut
```
public void setApproximateSecondsBeforeTimedOut(java.lang.Long approximateSecondsBeforeTimedOut)
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
    
    Parameters:
    
    approximateSecondsBeforeTimedOut -
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
  - withApproximateSecondsBeforeTimedOut
```
public JobExecution withApproximateSecondsBeforeTimedOut(java.lang.Long approximateSecondsBeforeTimedOut)
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    approximateSecondsBeforeTimedOut -
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class JobExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobExecution

Method Detail

getJobId

setJobId

withJobId

getStatus

setStatus

withStatus

setStatus

withStatus

isForceCanceled

getForceCanceled

setForceCanceled

withForceCanceled

getStatusDetails

setStatusDetails

withStatusDetails

getThingArn

setThingArn

withThingArn

getQueuedAt

setQueuedAt

withQueuedAt

getStartedAt

setStartedAt

withStartedAt

getLastUpdatedAt

setLastUpdatedAt

withLastUpdatedAt

getExecutionNumber

setExecutionNumber

withExecutionNumber

getVersionNumber

setVersionNumber

withVersionNumber

getApproximateSecondsBeforeTimedOut

setApproximateSecondsBeforeTimedOut

withApproximateSecondsBeforeTimedOut

toString

hashCode

equals