software.amazon.awssdk.services.sfn.model

Interface DescribeStateMachineResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeStateMachineResponse

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

Method Summary

Modifier and Type	Method and Description
DescribeStateMachineResponse.Builder	creationDate(Instant creationDate) The date the state machine is created.
DescribeStateMachineResponse.Builder	definition(String definition) The Amazon States Language definition of the state machine.
DescribeStateMachineResponse.Builder	description(String description) The description of the state machine version.
DescribeStateMachineResponse.Builder	label(String label) A user-defined or an auto-generated string that identifies a Map state.
default DescribeStateMachineResponse.Builder	loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration) Sets the value of the LoggingConfiguration property for this object.
DescribeStateMachineResponse.Builder	loggingConfiguration(LoggingConfiguration loggingConfiguration) Sets the value of the LoggingConfiguration property for this object.
DescribeStateMachineResponse.Builder	name(String name) The name of the state machine.
DescribeStateMachineResponse.Builder	revisionId(String revisionId) The revision identifier for the state machine.
DescribeStateMachineResponse.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
DescribeStateMachineResponse.Builder	stateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) that identifies the state machine.
DescribeStateMachineResponse.Builder	status(StateMachineStatus status) The current status of the state machine.
DescribeStateMachineResponse.Builder	status(String status) The current status of the state machine.
default DescribeStateMachineResponse.Builder	tracingConfiguration(Consumer<TracingConfiguration.Builder> tracingConfiguration) Selects whether X-Ray tracing is enabled.
DescribeStateMachineResponse.Builder	tracingConfiguration(TracingConfiguration tracingConfiguration) Selects whether X-Ray tracing is enabled.
DescribeStateMachineResponse.Builder	type(StateMachineType type) The type of the state machine (STANDARD or EXPRESS).
DescribeStateMachineResponse.Builder	type(String type) The type of the state machine (STANDARD or EXPRESS).

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

stateMachineArn

DescribeStateMachineResponse.Builder stateMachineArn(String stateMachineArn)

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

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

Parameters:

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

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

Returns:

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

name

DescribeStateMachineResponse.Builder name(String name)

The name of the state machine.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Parameters:

name - The name of the state machine.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

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

status

DescribeStateMachineResponse.Builder status(String status)

The current status of the state machine.

Parameters:

status - The current status of the state machine.

Returns:

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

See Also:

StateMachineStatus, StateMachineStatus

status

DescribeStateMachineResponse.Builder status(StateMachineStatus status)

The current status of the state machine.

Parameters:

status - The current status of the state machine.

Returns:

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

See Also:

StateMachineStatus, StateMachineStatus

definition

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

DescribeStateMachineResponse.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

Returns:

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

type

DescribeStateMachineResponse.Builder type(String type)

The type of the state machine (STANDARD or EXPRESS).

Parameters:

type - The type of the state machine (STANDARD or EXPRESS).

Returns:

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

See Also:

StateMachineType, StateMachineType

type

DescribeStateMachineResponse.Builder type(StateMachineType type)

The type of the state machine (STANDARD or EXPRESS).

Parameters:

type - The type of the state machine (STANDARD or EXPRESS).

Returns:

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

See Also:

StateMachineType, StateMachineType

creationDate

DescribeStateMachineResponse.Builder creationDate(Instant creationDate)

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

Parameters:

creationDate - The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

Returns:

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

loggingConfiguration

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

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

label

DescribeStateMachineResponse.Builder label(String label)

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

Parameters:

label - A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

Returns:

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

revisionId

DescribeStateMachineResponse.Builder revisionId(String revisionId)

The revision identifier for the state machine.

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

Parameters:

revisionId - The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration 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.

description

DescribeStateMachineResponse.Builder description(String description)

The description of the state machine version.

Parameters:

description - The description of the state machine version.

Returns:

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