public class UpdateJobRequest extends AmazonWebServiceRequest implements java.io.Serializable
Updates supported fields of the specified job.
Constructor and Description |
---|
UpdateJobRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
AbortConfig |
getAbortConfig()
Allows you to create criteria to abort a job.
|
java.lang.String |
getDescription()
A short text description of the job.
|
JobExecutionsRolloutConfig |
getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
|
java.lang.String |
getJobId()
The ID of the job to be updated.
|
java.lang.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(java.lang.String description)
A short text description of the job.
|
void |
setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
|
void |
setJobId(java.lang.String jobId)
The ID of the job to be updated.
|
void |
setNamespaceId(java.lang.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.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateJobRequest |
withAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
|
UpdateJobRequest |
withDescription(java.lang.String description)
A short text description of the job.
|
UpdateJobRequest |
withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
|
UpdateJobRequest |
withJobId(java.lang.String jobId)
The ID of the job to be updated.
|
UpdateJobRequest |
withNamespaceId(java.lang.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.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getJobId()
The ID of the job to be updated.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
The ID of the job to be updated.
public void setJobId(java.lang.String jobId)
The ID of the job to be updated.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId
- The ID of the job to be updated.
public UpdateJobRequest withJobId(java.lang.String jobId)
The ID of the job to be updated.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
jobId
- The ID of the job to be updated.
public java.lang.String getDescription()
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
A short text description of the job.
public void setDescription(java.lang.String description)
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- A short text description of the job.
public UpdateJobRequest withDescription(java.lang.String description)
A short text description of the job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- A short text description of the job.
public PresignedUrlConfig getPresignedUrlConfig()
Configuration information for pre-signed S3 URLs.
Configuration information for pre-signed S3 URLs.
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
presignedUrlConfig
- Configuration information for pre-signed S3 URLs.
public UpdateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
Returns a reference to this object so that method calls can be chained together.
presignedUrlConfig
- Configuration information for pre-signed S3 URLs.
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
Allows you to create a staged rollout of the job.
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
jobExecutionsRolloutConfig
- Allows you to create a staged rollout of the job.
public UpdateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
Returns a reference to this object so that method calls can be chained together.
jobExecutionsRolloutConfig
- Allows you to create a staged rollout of the job.
public AbortConfig getAbortConfig()
Allows you to create criteria to abort a job.
Allows you to create criteria to abort a job.
public void setAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
abortConfig
- Allows you to create criteria to abort a job.
public UpdateJobRequest withAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
Returns a reference to this object so that method calls can be chained together.
abortConfig
- Allows you to create criteria to abort a job.
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
.
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
.
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
.
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
.
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
.
Returns a reference to this object so that method calls can be chained together.
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
.
public java.lang.String getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public void setNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public UpdateJobRequest withNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
namespaceId
- The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.