@Generated(value="software.amazon.awssdk:codegen") public final class UpdateJobRequest extends IotRequest implements ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateJobRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AbortConfig |
abortConfig()
Allows you to create criteria to abort a job.
|
static UpdateJobRequest.Builder |
builder() |
String |
description()
A short text description of the job.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
JobExecutionsRolloutConfig |
jobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
|
String |
jobId()
The ID of the job to be updated.
|
String |
namespaceId()
The namespace used to indicate that a job is a customer-managed job.
|
PresignedUrlConfig |
presignedUrlConfig()
Configuration information for pre-signed S3 URLs.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateJobRequest.Builder> |
serializableBuilderClass() |
TimeoutConfig |
timeoutConfig()
Specifies the amount of time each device has to finish its execution of the job.
|
UpdateJobRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String jobId()
The ID of the job to be updated.
public final String description()
A short text description of the job.
public final PresignedUrlConfig presignedUrlConfig()
Configuration information for pre-signed S3 URLs.
public final JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
public final AbortConfig abortConfig()
Allows you to create criteria to abort a job.
public final 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
.
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 final 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.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>
toBuilder
in class IotRequest
public static UpdateJobRequest.Builder builder()
public static Class<? extends UpdateJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.