Interface CreateTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<CreateTaskRequest.Builder,CreateTaskRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateTaskRequest

@Mutable
@NotThreadSafe
public static interface CreateTaskRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

Method Summary

Modifier and Type	Method	Description
CreateTaskRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateTaskRequest.Builder	description(String description)	A description of the task.
CreateTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateTaskRequest.Builder	tags(Map<String,String> tags)	A list of key-value pairs that contain metadata for the task.
default CreateTaskRequest.Builder	taskConfiguration(Consumer<TaskConfiguration.Builder> taskConfiguration)	The task execution configuration.
CreateTaskRequest.Builder	taskConfiguration(TaskConfiguration taskConfiguration)	The task execution configuration.
CreateTaskRequest.Builder	taskName(String taskName)	The name of the task to create.
CreateTaskRequest.Builder	workspaceName(String workspaceName)	The name of the workspace.

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.iotsitewise.model.IoTSiteWiseRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

workspaceName

CreateTaskRequest.Builder workspaceName(String workspaceName)

The name of the workspace.

Parameters:

workspaceName - The name of the workspace.

Returns:

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

taskName

CreateTaskRequest.Builder taskName(String taskName)

The name of the task to create. Must be unique within the workspace.

Parameters:

taskName - The name of the task to create. Must be unique within the workspace.

Returns:

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

description

CreateTaskRequest.Builder description(String description)

A description of the task.

Parameters:

description - A description of the task.

Returns:

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

taskConfiguration

CreateTaskRequest.Builder taskConfiguration(TaskConfiguration taskConfiguration)

The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

Parameters:

taskConfiguration - The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

Returns:

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

taskConfiguration

default CreateTaskRequest.Builder taskConfiguration(Consumer<TaskConfiguration.Builder> taskConfiguration)

The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

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

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

Parameters:

taskConfiguration - a consumer that will call methods on TaskConfiguration.Builder

Returns:

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

See Also:

• taskConfiguration(TaskConfiguration)

tags

CreateTaskRequest.Builder tags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

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

clientToken

CreateTaskRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

Returns:

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

overrideConfiguration

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

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