JobExecution (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iotjobsdataplane.model

Class JobExecution

java.lang.Object
- com.amazonaws.services.iotjobsdataplane.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

Contains data about a job execution.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobExecution ()

Constructors
Constructor and Description
`JobExecution ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`JobExecution`	`addStatusDetailsEntry (String key, String value)` Add a single StatusDetails entry
`JobExecution`	`clearStatusDetailsEntries ()` Removes all the entries added into StatusDetails.
`JobExecution`	`clone ()`
`boolean`	`equals (Object obj)`
`Long`	`getApproximateSecondsBeforeTimedOut ()` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`Long`	`getExecutionNumber ()` A number that identifies a particular job execution on a particular device.
`String`	`getJobDocument ()` The content of the job document.
`String`	`getJobId ()` The unique identifier you assigned to this job when it was created.
`Long`	`getLastUpdatedAt ()` The time, in milliseconds since the epoch, when the job execution was last updated.
`Long`	`getQueuedAt ()` The time, in milliseconds since the epoch, when the job execution was enqueued.
`Long`	`getStartedAt ()` The time, in milliseconds since the epoch, when the job execution was started.
`String`	`getStatus ()` The status of the job execution.
`Map<String,String>`	`getStatusDetails ()` A collection of name/value pairs that describe the status of the job execution.
`String`	`getThingName ()` The name of the thing that is executing the job.
`Long`	`getVersionNumber ()` The version of the job execution.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApproximateSecondsBeforeTimedOut (Long approximateSecondsBeforeTimedOut)` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`void`	`setExecutionNumber (Long executionNumber)` A number that identifies a particular job execution on a particular device.
`void`	`setJobDocument (String jobDocument)` The content of the job document.
`void`	`setJobId (String jobId)` The unique identifier you assigned to this job when it was created.
`void`	`setLastUpdatedAt (Long lastUpdatedAt)` The time, in milliseconds since the epoch, when the job execution was last updated.
`void`	`setQueuedAt (Long queuedAt)` The time, in milliseconds since the epoch, when the job execution was enqueued.
`void`	`setStartedAt (Long startedAt)` The time, in milliseconds since the epoch, when the job execution was started.
`void`	`setStatus (String status)` The status of the job execution.
`void`	`setStatusDetails (Map<String,String> statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`void`	`setThingName (String thingName)` The name of the thing that is executing the job.
`void`	`setVersionNumber (Long versionNumber)` The version of the job execution.
`String`	`toString ()` Returns a string representation of this object.
`JobExecution`	`withApproximateSecondsBeforeTimedOut (Long approximateSecondsBeforeTimedOut)` The estimated number of seconds that remain before the job execution status will be changed to `TIMED_OUT`.
`JobExecution`	`withExecutionNumber (Long executionNumber)` A number that identifies a particular job execution on a particular device.
`JobExecution`	`withJobDocument (String jobDocument)` The content of the job document.
`JobExecution`	`withJobId (String jobId)` The unique identifier you assigned to this job when it was created.
`JobExecution`	`withLastUpdatedAt (Long lastUpdatedAt)` The time, in milliseconds since the epoch, when the job execution was last updated.
`JobExecution`	`withQueuedAt (Long queuedAt)` The time, in milliseconds since the epoch, when the job execution was enqueued.
`JobExecution`	`withStartedAt (Long startedAt)` The time, in milliseconds since the epoch, when the job execution was started.
`JobExecution`	`withStatus (JobExecutionStatus status)` The status of the job execution.
`JobExecution`	`withStatus (String status)` The status of the job execution.
`JobExecution`	`withStatusDetails (Map<String,String> statusDetails)` A collection of name/value pairs that describe the status of the job execution.
`JobExecution`	`withThingName (String thingName)` The name of the thing that is executing the job.
`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 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 JobExecution 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.
  - setThingName
```
public void setThingName(String thingName)
```
    The name of the thing that is executing the job.
    
    Parameters:
    
    thingName - The name of the thing that is executing the job.
  - getThingName
```
public String getThingName()
```
    The name of the thing that is executing the job.
    
    Returns:
    
    The name of the thing that is executing the job.
  - withThingName
```
public JobExecution withThingName(String thingName)
```
    The name of the thing that is executing the job.
    
    Parameters:
    
    thingName - The name of the thing that is executing the job.
    
    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. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    Parameters:
    
    status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    See Also:
    
    JobExecutionStatus
  - getStatus
```
public String getStatus()
```
    The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    Returns:
    
    The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    See Also:
    
    JobExecutionStatus
  - withStatus
```
public JobExecution withStatus(String status)
```
    The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    Parameters:
    
    status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    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. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    Parameters:
    
    status - The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionStatus
  - getStatusDetails
```
public Map<String,String> 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(Map<String,String> 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(Map<String,String> 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.
  - addStatusDetailsEntry
```
public JobExecution addStatusDetailsEntry(String key,
 String value)
```
    Add a single StatusDetails entry
    
    See Also:
    
    withStatusDetails(java.util.Map<java.lang.String, java.lang.String>)
  - clearStatusDetailsEntries
```
public JobExecution clearStatusDetailsEntries()
```
    Removes all the entries added into StatusDetails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueuedAt
```
public void setQueuedAt(Long queuedAt)
```
    The time, in milliseconds since the epoch, when the job execution was enqueued.
    
    Parameters:
    
    queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.
  - getQueuedAt
```
public Long getQueuedAt()
```
    The time, in milliseconds since the epoch, when the job execution was enqueued.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job execution was enqueued.
  - withQueuedAt
```
public JobExecution withQueuedAt(Long queuedAt)
```
    The time, in milliseconds since the epoch, when the job execution was enqueued.
    
    Parameters:
    
    queuedAt - The time, in milliseconds since the epoch, when the job execution was enqueued.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartedAt
```
public void setStartedAt(Long startedAt)
```
    The time, in milliseconds since the epoch, when the job execution was started.
    
    Parameters:
    
    startedAt - The time, in milliseconds since the epoch, when the job execution was started.
  - getStartedAt
```
public Long getStartedAt()
```
    The time, in milliseconds since the epoch, when the job execution was started.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the job execution was started.
  - withStartedAt
```
public JobExecution withStartedAt(Long startedAt)
```
    The time, in milliseconds since the epoch, when the job execution was started.
    
    Parameters:
    
    startedAt - The time, in milliseconds since the epoch, when the job execution was started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Long 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 Long 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(Long 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.
  - setApproximateSecondsBeforeTimedOut
```
public void setApproximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut)
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
    
    Parameters:
    
    approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
  - getApproximateSecondsBeforeTimedOut
```
public Long getApproximateSecondsBeforeTimedOut()
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
    
    Returns:
    
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
  - withApproximateSecondsBeforeTimedOut
```
public JobExecution withApproximateSecondsBeforeTimedOut(Long approximateSecondsBeforeTimedOut)
```
    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
    
    Parameters:
    
    approximateSecondsBeforeTimedOut - The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.
    
    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.
  - setExecutionNumber
```
public void setExecutionNumber(Long executionNumber)
```
    A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
    
    Parameters:
    
    executionNumber - A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
  - getExecutionNumber
```
public Long getExecutionNumber()
```
    A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
    
    Returns:
    
    A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
  - withExecutionNumber
```
public JobExecution withExecutionNumber(Long executionNumber)
```
    A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
    
    Parameters:
    
    executionNumber - A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDocument
```
public void setJobDocument(String jobDocument)
```
    The content of the job document.
    
    Parameters:
    
    jobDocument - The content of the job document.
  - getJobDocument
```
public String getJobDocument()
```
    The content of the job document.
    
    Returns:
    
    The content of the job document.
  - withJobDocument
```
public JobExecution withJobDocument(String jobDocument)
```
    The content of the job document.
    
    Parameters:
    
    jobDocument - The content of the job document.
    
    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. 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 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class JobExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobExecution

Method Detail

setJobId

getJobId

withJobId

setThingName

getThingName

withThingName

setStatus

getStatus

withStatus

withStatus

getStatusDetails

setStatusDetails

withStatusDetails

addStatusDetailsEntry

clearStatusDetailsEntries

setQueuedAt

getQueuedAt

withQueuedAt

setStartedAt

getStartedAt

withStartedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setApproximateSecondsBeforeTimedOut

getApproximateSecondsBeforeTimedOut

withApproximateSecondsBeforeTimedOut

setVersionNumber

getVersionNumber

withVersionNumber

setExecutionNumber

getExecutionNumber

withExecutionNumber

setJobDocument

getJobDocument

withJobDocument

toString

equals

hashCode

clone

marshall