Interface CreateJobTemplateRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateJobTemplateRequest

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

Method Summary

Modifier and Type	Method	Description
default CreateJobTemplateRequest.Builder	abortConfig(Consumer<AbortConfig.Builder> abortConfig)	Sets the value of the AbortConfig property for this object.
CreateJobTemplateRequest.Builder	abortConfig(AbortConfig abortConfig)	Sets the value of the AbortConfig property for this object.
CreateJobTemplateRequest.Builder	description(String description)	A description of the job document.
CreateJobTemplateRequest.Builder	destinationPackageVersions(String... destinationPackageVersions)	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
CreateJobTemplateRequest.Builder	destinationPackageVersions(Collection<String> destinationPackageVersions)	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
CreateJobTemplateRequest.Builder	document(String document)	The job document.
CreateJobTemplateRequest.Builder	documentSource(String documentSource)	An S3 link, or S3 object URL, to the job document.
CreateJobTemplateRequest.Builder	jobArn(String jobArn)	The ARN of the job to use as the basis for the job template.
default CreateJobTemplateRequest.Builder	jobExecutionsRetryConfig(Consumer<JobExecutionsRetryConfig.Builder> jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
CreateJobTemplateRequest.Builder	jobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
default CreateJobTemplateRequest.Builder	jobExecutionsRolloutConfig(Consumer<JobExecutionsRolloutConfig.Builder> jobExecutionsRolloutConfig)	Sets the value of the JobExecutionsRolloutConfig property for this object.
CreateJobTemplateRequest.Builder	jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)	Sets the value of the JobExecutionsRolloutConfig property for this object.
CreateJobTemplateRequest.Builder	jobTemplateId(String jobTemplateId)	A unique identifier for the job template.
CreateJobTemplateRequest.Builder	maintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows)	Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateJobTemplateRequest.Builder	maintenanceWindows(Consumer<MaintenanceWindow.Builder>... maintenanceWindows)	Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateJobTemplateRequest.Builder	maintenanceWindows(MaintenanceWindow... maintenanceWindows)	Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateJobTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateJobTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateJobTemplateRequest.Builder	presignedUrlConfig(Consumer<PresignedUrlConfig.Builder> presignedUrlConfig)	Sets the value of the PresignedUrlConfig property for this object.
CreateJobTemplateRequest.Builder	presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)	Sets the value of the PresignedUrlConfig property for this object.
CreateJobTemplateRequest.Builder	tags(Collection<Tag> tags)	Metadata that can be used to manage the job template.
CreateJobTemplateRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Metadata that can be used to manage the job template.
CreateJobTemplateRequest.Builder	tags(Tag... tags)	Metadata that can be used to manage the job template.
default CreateJobTemplateRequest.Builder	timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)	Sets the value of the TimeoutConfig property for this object.
CreateJobTemplateRequest.Builder	timeoutConfig(TimeoutConfig timeoutConfig)	Sets the value of the TimeoutConfig property for this object.

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

jobTemplateId

CreateJobTemplateRequest.Builder jobTemplateId(String jobTemplateId)

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Parameters:

jobTemplateId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Returns:

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

jobArn

CreateJobTemplateRequest.Builder jobArn(String jobArn)

The ARN of the job to use as the basis for the job template.

Parameters:

jobArn - The ARN of the job to use as the basis for the job template.

Returns:

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

documentSource

CreateJobTemplateRequest.Builder documentSource(String documentSource)

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Parameters:

documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Returns:

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

document

CreateJobTemplateRequest.Builder document(String document)

The job document. Required if you don't specify a value for documentSource.

Parameters:

document - The job document. Required if you don't specify a value for documentSource.

Returns:

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

description

CreateJobTemplateRequest.Builder description(String description)

A description of the job document.

Parameters:

description - A description of the job document.

Returns:

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

presignedUrlConfig

CreateJobTemplateRequest.Builder presignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Sets the value of the PresignedUrlConfig property for this object.

Parameters:

presignedUrlConfig - The new value for the PresignedUrlConfig property for this object.

Returns:

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

presignedUrlConfig

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

Sets the value of the PresignedUrlConfig property for this object. 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

CreateJobTemplateRequest.Builder jobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Sets the value of the JobExecutionsRolloutConfig property for this object.

Parameters:

jobExecutionsRolloutConfig - The new value for the JobExecutionsRolloutConfig property for this object.

Returns:

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

jobExecutionsRolloutConfig

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

Sets the value of the JobExecutionsRolloutConfig property for this object. 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

CreateJobTemplateRequest.Builder abortConfig(AbortConfig abortConfig)

Sets the value of the AbortConfig property for this object.

Parameters:

abortConfig - The new value for the AbortConfig property for this object.

Returns:

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

abortConfig

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

Sets the value of the AbortConfig property for this object. 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

CreateJobTemplateRequest.Builder timeoutConfig(TimeoutConfig timeoutConfig)

Sets the value of the TimeoutConfig property for this object.

Parameters:

timeoutConfig - The new value for the TimeoutConfig property for this object.

Returns:

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

timeoutConfig

default CreateJobTemplateRequest.Builder timeoutConfig(Consumer<TimeoutConfig.Builder> timeoutConfig)

Sets the value of the TimeoutConfig property for this object. 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)

tags

CreateJobTemplateRequest.Builder tags(Collection<Tag> tags)

Metadata that can be used to manage the job template.

Parameters:

tags - Metadata that can be used to manage the job template.

Returns:

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

tags

CreateJobTemplateRequest.Builder tags(Tag... tags)

Metadata that can be used to manage the job template.

Parameters:

tags - Metadata that can be used to manage the job template.

Returns:

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

tags

CreateJobTemplateRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata that can be used to manage the job template.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

jobExecutionsRetryConfig

CreateJobTemplateRequest.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 CreateJobTemplateRequest.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)

maintenanceWindows

CreateJobTemplateRequest.Builder maintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Parameters:

maintenanceWindows - Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:

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

maintenanceWindows

CreateJobTemplateRequest.Builder maintenanceWindows(MaintenanceWindow... maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Parameters:

maintenanceWindows - Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:

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

maintenanceWindows

CreateJobTemplateRequest.Builder maintenanceWindows(Consumer<MaintenanceWindow.Builder>... maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceWindows(List<MaintenanceWindow>).

Parameters:

maintenanceWindows - a consumer that will call methods on MaintenanceWindow.Builder

Returns:

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

See Also:

• maintenanceWindows(java.util.Collection<MaintenanceWindow>)

destinationPackageVersions

CreateJobTemplateRequest.Builder destinationPackageVersions(Collection<String> destinationPackageVersions)

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Returns:

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

destinationPackageVersions

CreateJobTemplateRequest.Builder destinationPackageVersions(String... destinationPackageVersions)

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Returns:

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

overrideConfiguration

CreateJobTemplateRequest.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

CreateJobTemplateRequest.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.