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

Interface DescribeStateMachineForExecutionResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeStateMachineForExecutionResponse

public static interface DescribeStateMachineForExecutionResponse.Builder
extends SfnResponse.Builder, SdkPojo, CopyableBuilder<DescribeStateMachineForExecutionResponse.Builder,DescribeStateMachineForExecutionResponse>

Method Summary

Modifier and Type	Method	Description
DescribeStateMachineForExecutionResponse.Builder	definition(String definition)	The Amazon States Language definition of the state machine.
DescribeStateMachineForExecutionResponse.Builder	label(String label)	A user-defined or an auto-generated string that identifies a Map state.
default DescribeStateMachineForExecutionResponse.Builder	loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)	Sets the value of the LoggingConfiguration property for this object.
DescribeStateMachineForExecutionResponse.Builder	loggingConfiguration(LoggingConfiguration loggingConfiguration)	Sets the value of the LoggingConfiguration property for this object.
DescribeStateMachineForExecutionResponse.Builder	mapRunArn(String mapRunArn)	The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution.
DescribeStateMachineForExecutionResponse.Builder	name(String name)	The name of the state machine associated with the execution.
DescribeStateMachineForExecutionResponse.Builder	revisionId(String revisionId)	The revision identifier for the state machine.
DescribeStateMachineForExecutionResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
DescribeStateMachineForExecutionResponse.Builder	stateMachineArn(String stateMachineArn)	The Amazon Resource Name (ARN) of the state machine associated with the execution.
default DescribeStateMachineForExecutionResponse.Builder	tracingConfiguration(Consumer<TracingConfiguration.Builder> tracingConfiguration)	Selects whether X-Ray tracing is enabled.
DescribeStateMachineForExecutionResponse.Builder	tracingConfiguration(TracingConfiguration tracingConfiguration)	Selects whether X-Ray tracing is enabled.
DescribeStateMachineForExecutionResponse.Builder	updateDate(Instant updateDate)	The date and time the state machine associated with an execution was updated.

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, 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

stateMachineArn

DescribeStateMachineForExecutionResponse.Builder stateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) of the state machine associated with the execution.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) of the state machine associated with the execution.

Returns:

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

name

DescribeStateMachineForExecutionResponse.Builder name(String name)

The name of the state machine associated with the execution.

Parameters:

name - The name of the state machine associated with the execution.

Returns:

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

definition

DescribeStateMachineForExecutionResponse.Builder definition(String definition)

The Amazon States Language definition of the state machine. See Amazon States Language.

Parameters:

definition - The Amazon States Language definition of the state machine. See Amazon States Language.

Returns:

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

roleArn

DescribeStateMachineForExecutionResponse.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

Returns:

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

updateDate

DescribeStateMachineForExecutionResponse.Builder updateDate(Instant updateDate)

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

Parameters:

updateDate - The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

Returns:

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

loggingConfiguration

DescribeStateMachineForExecutionResponse.Builder loggingConfiguration(LoggingConfiguration loggingConfiguration)

Sets the value of the LoggingConfiguration property for this object.

Parameters:

loggingConfiguration - The new value for the LoggingConfiguration property for this object.

Returns:

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

loggingConfiguration

default DescribeStateMachineForExecutionResponse.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)

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

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

Parameters:

loggingConfiguration - a consumer that will call methods on LoggingConfiguration.Builder

Returns:

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

See Also:

loggingConfiguration(LoggingConfiguration)

tracingConfiguration

DescribeStateMachineForExecutionResponse.Builder tracingConfiguration(TracingConfiguration tracingConfiguration)

Selects whether X-Ray tracing is enabled.

Parameters:

tracingConfiguration - Selects whether X-Ray tracing is enabled.

Returns:

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

tracingConfiguration

default DescribeStateMachineForExecutionResponse.Builder tracingConfiguration(Consumer<TracingConfiguration.Builder> tracingConfiguration)

Selects whether X-Ray tracing is enabled.

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

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

Parameters:

tracingConfiguration - a consumer that will call methods on TracingConfiguration.Builder

Returns:

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

See Also:

tracingConfiguration(TracingConfiguration)

mapRunArn

DescribeStateMachineForExecutionResponse.Builder mapRunArn(String mapRunArn)

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Parameters:

mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Returns:

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

label

DescribeStateMachineForExecutionResponse.Builder label(String label)

A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Parameters:

label - A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Returns:

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

revisionId

DescribeStateMachineForExecutionResponse.Builder revisionId(String revisionId)

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

Parameters:

revisionId - The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

Returns:

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