Package software.amazon.awssdk.services.sfn.model

Interface StartSyncExecutionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>, SdkBuilder<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>, SdkPojo, SdkResponse.Builder, SfnResponse.Builder

Enclosing class:

StartSyncExecutionResponse

@Mutable
@NotThreadSafe
public static interface StartSyncExecutionResponse.Builder
extends SfnResponse.Builder, SdkPojo, CopyableBuilder<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>

Method Summary

Modifier and Type	Method	Description
default StartSyncExecutionResponse.Builder	billingDetails(Consumer<BillingDetails.Builder> billingDetails)	An object that describes workflow billing details, including billed duration and memory use.
StartSyncExecutionResponse.Builder	billingDetails(BillingDetails billingDetails)	An object that describes workflow billing details, including billed duration and memory use.
StartSyncExecutionResponse.Builder	cause(String causeValue)	A more detailed explanation of the cause of the failure.
StartSyncExecutionResponse.Builder	error(String error)	The error code of the failure.
StartSyncExecutionResponse.Builder	executionArn(String executionArn)	The Amazon Resource Name (ARN) that identifies the execution.
StartSyncExecutionResponse.Builder	input(String input)	The string that contains the JSON input data of the execution.
default StartSyncExecutionResponse.Builder	inputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> inputDetails)	Sets the value of the InputDetails property for this object.
StartSyncExecutionResponse.Builder	inputDetails(CloudWatchEventsExecutionDataDetails inputDetails)	Sets the value of the InputDetails property for this object.
StartSyncExecutionResponse.Builder	name(String name)	The name of the execution.
StartSyncExecutionResponse.Builder	output(String output)	The JSON output data of the execution.
default StartSyncExecutionResponse.Builder	outputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> outputDetails)	Sets the value of the OutputDetails property for this object.
StartSyncExecutionResponse.Builder	outputDetails(CloudWatchEventsExecutionDataDetails outputDetails)	Sets the value of the OutputDetails property for this object.
StartSyncExecutionResponse.Builder	startDate(Instant startDate)	The date the execution is started.
StartSyncExecutionResponse.Builder	stateMachineArn(String stateMachineArn)	The Amazon Resource Name (ARN) that identifies the state machine.
StartSyncExecutionResponse.Builder	status(String status)	The current status of the execution.
StartSyncExecutionResponse.Builder	status(SyncExecutionStatus status)	The current status of the execution.
StartSyncExecutionResponse.Builder	stopDate(Instant stopDate)	If the execution has already ended, the date the execution stopped.
StartSyncExecutionResponse.Builder	traceHeader(String traceHeader)	The X-Ray trace header that was passed to the execution.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.sfn.model.SfnResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

executionArn

StartSyncExecutionResponse.Builder executionArn(String executionArn)

The Amazon Resource Name (ARN) that identifies the execution.

Parameters:

executionArn - The Amazon Resource Name (ARN) that identifies the execution.

Returns:

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

stateMachineArn

StartSyncExecutionResponse.Builder stateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) that identifies the state machine.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) that identifies the state machine.

Returns:

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

name

StartSyncExecutionResponse.Builder name(String name)

The name of the execution.

Parameters:

name - The name of the execution.

Returns:

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

startDate

StartSyncExecutionResponse.Builder startDate(Instant startDate)

The date the execution is started.

Parameters:

startDate - The date the execution is started.

Returns:

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

stopDate

StartSyncExecutionResponse.Builder stopDate(Instant stopDate)

If the execution has already ended, the date the execution stopped.

Parameters:

stopDate - If the execution has already ended, the date the execution stopped.

Returns:

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

status

StartSyncExecutionResponse.Builder status(String status)

The current status of the execution.

Parameters:

status - The current status of the execution.

Returns:

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

See Also:

SyncExecutionStatus, SyncExecutionStatus

status

StartSyncExecutionResponse.Builder status(SyncExecutionStatus status)

The current status of the execution.

Parameters:

status - The current status of the execution.

Returns:

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

See Also:

SyncExecutionStatus, SyncExecutionStatus

error

StartSyncExecutionResponse.Builder error(String error)

The error code of the failure.

Parameters:

error - The error code of the failure.

Returns:

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

cause

StartSyncExecutionResponse.Builder cause(String causeValue)

A more detailed explanation of the cause of the failure.

Parameters:

causeValue - A more detailed explanation of the cause of the failure.

Returns:

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

input

StartSyncExecutionResponse.Builder input(String input)

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Parameters:

input - The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

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

inputDetails

StartSyncExecutionResponse.Builder inputDetails(CloudWatchEventsExecutionDataDetails inputDetails)

Sets the value of the InputDetails property for this object.

Parameters:

inputDetails - The new value for the InputDetails property for this object.

Returns:

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

inputDetails

default StartSyncExecutionResponse.Builder inputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> inputDetails)

Sets the value of the InputDetails property for this object. This is a convenience method that creates an instance of the CloudWatchEventsExecutionDataDetails.Builder avoiding the need to create one manually via CloudWatchEventsExecutionDataDetails.builder().

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

Parameters:

inputDetails - a consumer that will call methods on CloudWatchEventsExecutionDataDetails.Builder

Returns:

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

See Also:

inputDetails(CloudWatchEventsExecutionDataDetails)

output

StartSyncExecutionResponse.Builder output(String output)

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Parameters:

output - The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Returns:

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

outputDetails

StartSyncExecutionResponse.Builder outputDetails(CloudWatchEventsExecutionDataDetails outputDetails)

Sets the value of the OutputDetails property for this object.

Parameters:

outputDetails - The new value for the OutputDetails property for this object.

Returns:

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

outputDetails

default StartSyncExecutionResponse.Builder outputDetails(Consumer<CloudWatchEventsExecutionDataDetails.Builder> outputDetails)

Sets the value of the OutputDetails property for this object. This is a convenience method that creates an instance of the CloudWatchEventsExecutionDataDetails.Builder avoiding the need to create one manually via CloudWatchEventsExecutionDataDetails.builder().

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

Parameters:

outputDetails - a consumer that will call methods on CloudWatchEventsExecutionDataDetails.Builder

Returns:

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

See Also:

outputDetails(CloudWatchEventsExecutionDataDetails)

traceHeader

StartSyncExecutionResponse.Builder traceHeader(String traceHeader)

The X-Ray trace header that was passed to the execution.

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

Parameters:

traceHeader - The X-Ray trace header that was passed to the execution.

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

Returns:

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

billingDetails

StartSyncExecutionResponse.Builder billingDetails(BillingDetails billingDetails)

An object that describes workflow billing details, including billed duration and memory use.

Parameters:

billingDetails - An object that describes workflow billing details, including billed duration and memory use.

Returns:

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

billingDetails

default StartSyncExecutionResponse.Builder billingDetails(Consumer<BillingDetails.Builder> billingDetails)

An object that describes workflow billing details, including billed duration and memory use.

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

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

Parameters:

billingDetails - a consumer that will call methods on BillingDetails.Builder

Returns:

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

See Also:

billingDetails(BillingDetails)