software.amazon.awssdk.services.iot.model

Class UpdateJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.UpdateJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateJobRequest
extends IotRequest
implements ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateJobRequest.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobId

public final String jobId()

The ID of the job to be updated.

Returns:

The ID of the job to be updated.

description

public final String description()

A short text description of the job.

Returns:

A short text description of the job.

presignedUrlConfig

public final PresignedUrlConfig presignedUrlConfig()

Configuration information for pre-signed S3 URLs.

Returns:

Configuration information for pre-signed S3 URLs.

jobExecutionsRolloutConfig

public final JobExecutionsRolloutConfig jobExecutionsRolloutConfig()

Allows you to create a staged rollout of the job.

Returns:

Allows you to create a staged rollout of the job.

abortConfig

public final AbortConfig abortConfig()

Allows you to create criteria to abort a job.

Returns:

Allows you to create criteria to abort a job.

timeoutConfig

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.

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 .

namespaceId

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.

Returns:

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.

toBuilder

public UpdateJobRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static UpdateJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.