Interface ExecuteActionRequest.Builder

All Superinterfaces:

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

Enclosing class:

ExecuteActionRequest

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

Method Summary

Modifier and Type	Method	Description
ExecuteActionRequest.Builder	actionDefinitionId(String actionDefinitionId)	The ID of the action definition.
default ExecuteActionRequest.Builder	actionPayload(Consumer<ActionPayload.Builder> actionPayload)	The JSON payload of the action.
ExecuteActionRequest.Builder	actionPayload(ActionPayload actionPayload)	The JSON payload of the action.
ExecuteActionRequest.Builder	clientToken(String clientToken)	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
ExecuteActionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ExecuteActionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default ExecuteActionRequest.Builder	targetResource(Consumer<TargetResource.Builder> targetResource)	The resource the action will be taken on.
ExecuteActionRequest.Builder	targetResource(TargetResource targetResource)	The resource the action will be taken on.

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

targetResource

ExecuteActionRequest.Builder targetResource(TargetResource targetResource)

The resource the action will be taken on.

Parameters:

targetResource - The resource the action will be taken on.

Returns:

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

targetResource

default ExecuteActionRequest.Builder targetResource(Consumer<TargetResource.Builder> targetResource)

The resource the action will be taken on.

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

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

Parameters:

targetResource - a consumer that will call methods on TargetResource.Builder

Returns:

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

See Also:

• targetResource(TargetResource)

actionDefinitionId

ExecuteActionRequest.Builder actionDefinitionId(String actionDefinitionId)

The ID of the action definition.

Parameters:

actionDefinitionId - The ID of the action definition.

Returns:

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

actionPayload

ExecuteActionRequest.Builder actionPayload(ActionPayload actionPayload)

The JSON payload of the action.

Parameters:

actionPayload - The JSON payload of the action.

Returns:

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

actionPayload

default ExecuteActionRequest.Builder actionPayload(Consumer<ActionPayload.Builder> actionPayload)

The JSON payload of the action.

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

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

Parameters:

actionPayload - a consumer that will call methods on ActionPayload.Builder

Returns:

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

See Also:

• actionPayload(ActionPayload)

clientToken

ExecuteActionRequest.Builder clientToken(String clientToken)

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Parameters:

clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

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

overrideConfiguration

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

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