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

Class DescribeStateMachineResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sfn.model.SfnResponse

software.amazon.awssdk.services.sfn.model.DescribeStateMachineResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeStateMachineResponse
extends SfnResponse
implements ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStateMachineResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStateMachineResponse.Builder	builder()
Instant	creationDate()	The date the state machine is created.
String	definition()	The Amazon States Language definition of the state machine.
String	description()	The description of the state machine version.
EncryptionConfiguration	encryptionConfiguration()	Settings to configure server-side encryption.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	label()	A user-defined or an auto-generated string that identifies a Map state.
LoggingConfiguration	loggingConfiguration()	Returns the value of the LoggingConfiguration property for this object.
String	name()	The name of the state machine.
String	revisionId()	The revision identifier for the state machine.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStateMachineResponse.Builder>	serializableBuilderClass()
String	stateMachineArn()	The Amazon Resource Name (ARN) that identifies the state machine.
StateMachineStatus	status()	The current status of the state machine.
String	statusAsString()	The current status of the state machine.
DescribeStateMachineResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TracingConfiguration	tracingConfiguration()	Selects whether X-Ray tracing is enabled.
StateMachineType	type()	The type of the state machine (STANDARD or EXPRESS).
String	typeAsString()	The type of the state machine (STANDARD or EXPRESS).

Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

stateMachineArn

public final 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.

Returns:

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.

name

public final 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 _.

Returns:

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

status

public final StateMachineStatus status()

The current status of the state machine.

If the service returns an enum value that is not available in the current SDK version, status will return StateMachineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the state machine.

See Also:

StateMachineStatus

statusAsString

public final String statusAsString()

The current status of the state machine.

If the service returns an enum value that is not available in the current SDK version, status will return StateMachineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the state machine.

See Also:

StateMachineStatus

definition

public final String definition()

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

Returns:

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

roleArn

public final 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.)

Returns:

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

type

public final StateMachineType type()

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

If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

StateMachineType

typeAsString

public final String typeAsString()

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

If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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

See Also:

StateMachineType

creationDate

public final Instant creationDate()

The date the state machine is created.

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

Returns:

The date the state machine is created.

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

loggingConfiguration

public final LoggingConfiguration loggingConfiguration()

Returns the value of the LoggingConfiguration property for this object.

Returns:

The value of the LoggingConfiguration property for this object.

tracingConfiguration

public final TracingConfiguration tracingConfiguration()

Selects whether X-Ray tracing is enabled.

Returns:

Selects whether X-Ray tracing is enabled.

label

public final 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.

Returns:

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.

revisionId

public final 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.

Returns:

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.

description

public final String description()

The description of the state machine version.

Returns:

The description of the state machine version.

encryptionConfiguration

public final EncryptionConfiguration encryptionConfiguration()

Settings to configure server-side encryption.

Returns:

Settings to configure server-side encryption.

toBuilder

public DescribeStateMachineResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeStateMachineResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStateMachineResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo