com.amazonaws.services.iotjobsdataplane.model

Class DescribeJobExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotjobsdataplane.model.DescribeJobExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeJobExecutionRequest()

Method Summary

Modifier and Type	Method and Description
DescribeJobExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getExecutionNumber() Optional.
Boolean	getIncludeJobDocument() Optional.
String	getJobId() The unique identifier assigned to this job when it was created.
String	getThingName() The thing name associated with the device the job execution is running on.
int	hashCode()
Boolean	isIncludeJobDocument() Optional.
void	setExecutionNumber(Long executionNumber) Optional.
void	setIncludeJobDocument(Boolean includeJobDocument) Optional.
void	setJobId(String jobId) The unique identifier assigned to this job when it was created.
void	setThingName(String thingName) The thing name associated with the device the job execution is running on.
String	toString() Returns a string representation of this object.
DescribeJobExecutionRequest	withExecutionNumber(Long executionNumber) Optional.
DescribeJobExecutionRequest	withIncludeJobDocument(Boolean includeJobDocument) Optional.
DescribeJobExecutionRequest	withJobId(String jobId) The unique identifier assigned to this job when it was created.
DescribeJobExecutionRequest	withThingName(String thingName) The thing name associated with the device the job execution is running on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeJobExecutionRequest

public DescribeJobExecutionRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The unique identifier assigned to this job when it was created.

Parameters:

jobId - The unique identifier assigned to this job when it was created.

getJobId

public String getJobId()

The unique identifier assigned to this job when it was created.

Returns:

The unique identifier assigned to this job when it was created.

withJobId

public DescribeJobExecutionRequest withJobId(String jobId)

The unique identifier assigned to this job when it was created.

Parameters:

jobId - The unique identifier 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 thing name associated with the device the job execution is running on.

Parameters:

thingName - The thing name associated with the device the job execution is running on.

getThingName

public String getThingName()

The thing name associated with the device the job execution is running on.

Returns:

The thing name associated with the device the job execution is running on.

withThingName

public DescribeJobExecutionRequest withThingName(String thingName)

The thing name associated with the device the job execution is running on.

Parameters:

thingName - The thing name associated with the device the job execution is running on.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIncludeJobDocument

public void setIncludeJobDocument(Boolean includeJobDocument)

Optional. When set to true, the response contains the job document. The default is false.

Parameters:

includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

getIncludeJobDocument

public Boolean getIncludeJobDocument()

Optional. When set to true, the response contains the job document. The default is false.

Returns:

Optional. When set to true, the response contains the job document. The default is false.

withIncludeJobDocument

public DescribeJobExecutionRequest withIncludeJobDocument(Boolean includeJobDocument)

Optional. When set to true, the response contains the job document. The default is false.

Parameters:

includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeJobDocument

public Boolean isIncludeJobDocument()

Optional. When set to true, the response contains the job document. The default is false.

Returns:

Optional. When set to true, the response contains the job document. The default is false.

setExecutionNumber

public void setExecutionNumber(Long executionNumber)

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Parameters:

executionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

getExecutionNumber

public Long getExecutionNumber()

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Returns:

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

withExecutionNumber

public DescribeJobExecutionRequest withExecutionNumber(Long executionNumber)

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Parameters:

executionNumber - Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

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 DescribeJobExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()