Package software.amazon.awssdk.services.iot.model

Interface UpdateJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>, IotRequest.Builder, SdkBuilder<UpdateJobRequest.Builder,UpdateJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateJobRequest

public static interface UpdateJobRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<UpdateJobRequest.Builder,UpdateJobRequest>

Method Summary

Modifier and Type	Method	Description
default UpdateJobRequest.Builder	abortConfig(Consumer<AbortConfig.Builder> abortConfig)	Allows you to create criteria to abort a job.
UpdateJobRequest.Builder	abortConfig(AbortConfig abortConfig)	Allows you to create criteria to abort a job.
UpdateJobRequest.Builder	description(String description)	A short text description of the job.
default UpdateJobRequest.Builder	jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
UpdateJobRequest.Builder	jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
default UpdateJobRequest.Builder	jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)	Allows you to create a staged rollout of the job.
UpdateJobRequest.Builder	jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)	Allows you to create a staged rollout of the job.
UpdateJobRequest.Builder	jobId(String jobId)	The ID of the job to be updated.
UpdateJobRequest.Builder	namespaceId(String namespaceId)	The namespace used to indicate that a job is a customer-managed job.
UpdateJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateJobRequest.Builder	presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)	Configuration information for pre-signed S3 URLs.
UpdateJobRequest.Builder	presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)	Configuration information for pre-signed S3 URLs.
default UpdateJobRequest.Builder	timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)	Specifies the amount of time each device has to finish its execution of the job.
UpdateJobRequest.Builder	timeoutConfig(TimeoutConfig timeoutConfig)	Specifies the amount of time each device has to finish its execution of the job.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

jobId

UpdateJobRequest.Builder jobId(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.

description

UpdateJobRequest.Builder description(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.

presignedUrlConfig

UpdateJobRequest.Builder presignedUrlConfig(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.

presignedUrlConfig

default UpdateJobRequest.Builder presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)

Configuration information for pre-signed S3 URLs.

This is a convenience method that creates an instance of the PresignedUrlConfig.Builder avoiding the need to create one manually via PresignedUrlConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to presignedUrlConfig(PresignedUrlConfig).

Parameters:

presignedUrlConfig - a consumer that will call methods on PresignedUrlConfig.Builder

Returns:

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

See Also:

• presignedUrlConfig(PresignedUrlConfig)

jobExecutionsRolloutConfig

UpdateJobRequest.Builder jobExecutionsRolloutConfig(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.

jobExecutionsRolloutConfig

default UpdateJobRequest.Builder jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

This is a convenience method that creates an instance of the JobExecutionsRolloutConfig.Builder avoiding the need to create one manually via JobExecutionsRolloutConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionsRolloutConfig(JobExecutionsRolloutConfig).

Parameters:

jobExecutionsRolloutConfig - a consumer that will call methods on JobExecutionsRolloutConfig.Builder

Returns:

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

See Also:

• jobExecutionsRolloutConfig(JobExecutionsRolloutConfig)

abortConfig

UpdateJobRequest.Builder abortConfig(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.

abortConfig

default UpdateJobRequest.Builder abortConfig(Consumer<AbortConfig.Builder> abortConfig)

Allows you to create criteria to abort a job.

This is a convenience method that creates an instance of the AbortConfig.Builder avoiding the need to create one manually via AbortConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to abortConfig(AbortConfig).

Parameters:

abortConfig - a consumer that will call methods on AbortConfig.Builder

Returns:

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

See Also:

• abortConfig(AbortConfig)

timeoutConfig

UpdateJobRequest.Builder timeoutConfig(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.

timeoutConfig

default UpdateJobRequest.Builder timeoutConfig(Consumer<TimeoutConfig.Builder> 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.

This is a convenience method that creates an instance of the TimeoutConfig.Builder avoiding the need to create one manually via TimeoutConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeoutConfig(TimeoutConfig).

Parameters:

timeoutConfig - a consumer that will call methods on TimeoutConfig.Builder

Returns:

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

See Also:

• timeoutConfig(TimeoutConfig)

namespaceId

UpdateJobRequest.Builder namespaceId(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.

jobExecutionsRetryConfig

UpdateJobRequest.Builder jobExecutionsRetryConfig(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.

jobExecutionsRetryConfig

default UpdateJobRequest.Builder jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

This is a convenience method that creates an instance of the JobExecutionsRetryConfig.Builder avoiding the need to create one manually via JobExecutionsRetryConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionsRetryConfig(JobExecutionsRetryConfig).

Parameters:

jobExecutionsRetryConfig - a consumer that will call methods on JobExecutionsRetryConfig.Builder

Returns:

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

See Also:

• jobExecutionsRetryConfig(JobExecutionsRetryConfig)

overrideConfiguration

UpdateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.