com.amazonaws.services.iotjobsdataplane.model

Class JobExecutionState

java.lang.Object

com.amazonaws.services.iotjobsdataplane.model.JobExecutionState

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobExecutionState
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains data about the state of a job execution.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobExecutionState()

Method Summary

Modifier and Type	Method and Description
JobExecutionState	addStatusDetailsEntry(String key, String value)
JobExecutionState	clearStatusDetailsEntries() Removes all the entries added into StatusDetails.
JobExecutionState	clone()
boolean	equals(Object obj)
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.
Long	getVersionNumber() The version of the job execution.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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	setVersionNumber(Long versionNumber) The version of the job execution.
String	toString() Returns a string representation of this object.
JobExecutionState	withStatus(JobExecutionStatus status) The status of the job execution.
JobExecutionState	withStatus(String status) The status of the job execution.
JobExecutionState	withStatusDetails(Map<String,String> statusDetails) A collection of name/value pairs that describe the status of the job execution.
JobExecutionState	withVersionNumber(Long versionNumber) The version of the job execution.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobExecutionState

public JobExecutionState()

Method Detail

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 JobExecutionState 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 JobExecutionState 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 JobExecutionState 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 JobExecutionState addStatusDetailsEntry(String key,
                                               String value)

clearStatusDetailsEntries

public JobExecutionState clearStatusDetailsEntries()

Removes all the entries added into StatusDetails.

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