com.amazonaws.services.iot.model

Class UpdateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.UpdateJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateJobRequest()

Method Summary

Modifier and Type	Method and Description
UpdateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AbortConfig	getAbortConfig() Allows you to create criteria to abort a job.
String	getDescription() A short text description of the job.
JobExecutionsRetryConfig	getJobExecutionsRetryConfig() Allows you to create the criteria to retry a job.
JobExecutionsRolloutConfig	getJobExecutionsRolloutConfig() Allows you to create a staged rollout of the job.
String	getJobId() The ID of the job to be updated.
String	getNamespaceId() The namespace used to indicate that a job is a customer-managed job.
PresignedUrlConfig	getPresignedUrlConfig() Configuration information for pre-signed S3 URLs.
TimeoutConfig	getTimeoutConfig() Specifies the amount of time each device has to finish its execution of the job.
int	hashCode()
void	setAbortConfig(AbortConfig abortConfig) Allows you to create criteria to abort a job.
void	setDescription(String description) A short text description of the job.
void	setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.
void	setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) Allows you to create a staged rollout of the job.
void	setJobId(String jobId) The ID of the job to be updated.
void	setNamespaceId(String namespaceId) The namespace used to indicate that a job is a customer-managed job.
void	setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) Configuration information for pre-signed S3 URLs.
void	setTimeoutConfig(TimeoutConfig timeoutConfig) Specifies the amount of time each device has to finish its execution of the job.
String	toString() Returns a string representation of this object.
UpdateJobRequest	withAbortConfig(AbortConfig abortConfig) Allows you to create criteria to abort a job.
UpdateJobRequest	withDescription(String description) A short text description of the job.
UpdateJobRequest	withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.
UpdateJobRequest	withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) Allows you to create a staged rollout of the job.
UpdateJobRequest	withJobId(String jobId) The ID of the job to be updated.
UpdateJobRequest	withNamespaceId(String namespaceId) The namespace used to indicate that a job is a customer-managed job.
UpdateJobRequest	withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) Configuration information for pre-signed S3 URLs.
UpdateJobRequest	withTimeoutConfig(TimeoutConfig timeoutConfig) Specifies the amount of time each device has to finish its execution of the job.

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

UpdateJobRequest

public UpdateJobRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The ID of the job to be updated.

Parameters:

jobId - The ID of the job to be updated.

getJobId

public String getJobId()

The ID of the job to be updated.

Returns:

The ID of the job to be updated.

withJobId

public UpdateJobRequest withJobId(String jobId)

The ID of the job to be updated.

Parameters:

jobId - The ID of the job to be updated.

Returns:

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

setDescription

public void setDescription(String description)

A short text description of the job.

Parameters:

description - A short text description of the job.

getDescription

public String getDescription()

A short text description of the job.

Returns:

A short text description of the job.

withDescription

public UpdateJobRequest withDescription(String description)

A short text description of the job.

Parameters:

description - A short text description of the job.

Returns:

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

setPresignedUrlConfig

public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Configuration information for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration information for pre-signed S3 URLs.

getPresignedUrlConfig

public PresignedUrlConfig getPresignedUrlConfig()

Configuration information for pre-signed S3 URLs.

Returns:

Configuration information for pre-signed S3 URLs.

withPresignedUrlConfig

public UpdateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Configuration information for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration information for pre-signed S3 URLs.

Returns:

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

setJobExecutionsRolloutConfig

public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.

getJobExecutionsRolloutConfig

public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()

Allows you to create a staged rollout of the job.

Returns:

Allows you to create a staged rollout of the job.

withJobExecutionsRolloutConfig

public UpdateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.

Returns:

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

setAbortConfig

public void setAbortConfig(AbortConfig abortConfig)

Allows you to create criteria to abort a job.

Parameters:

abortConfig - Allows you to create criteria to abort a job.

getAbortConfig

public AbortConfig getAbortConfig()

Allows you to create criteria to abort a job.

Returns:

Allows you to create criteria to abort a job.

withAbortConfig

public UpdateJobRequest withAbortConfig(AbortConfig abortConfig)

Allows you to create criteria to abort a job.

Parameters:

abortConfig - Allows you to create criteria to abort a job.

Returns:

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

setTimeoutConfig

public void setTimeoutConfig(TimeoutConfig timeoutConfig)

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Parameters:

timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

getTimeoutConfig

public TimeoutConfig getTimeoutConfig()

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Returns:

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT .

withTimeoutConfig

public UpdateJobRequest withTimeoutConfig(TimeoutConfig timeoutConfig)

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Parameters:

timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Returns:

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

setNamespaceId

public void setNamespaceId(String namespaceId)

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Parameters:

namespaceId - The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

getNamespaceId

public String getNamespaceId()

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Returns:

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

withNamespaceId

public UpdateJobRequest withNamespaceId(String namespaceId)

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Parameters:

namespaceId - The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Returns:

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

setJobExecutionsRetryConfig

public void setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

getJobExecutionsRetryConfig

public JobExecutionsRetryConfig getJobExecutionsRetryConfig()

Allows you to create the criteria to retry a job.

Returns:

Allows you to create the criteria to retry a job.

withJobExecutionsRetryConfig

public UpdateJobRequest withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

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 UpdateJobRequest 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()