@Generated(value="software.amazon.awssdk:codegen") public class DescribeStateMachineResponse extends SFNResponse implements ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeStateMachineResponse.Builder |
Modifier and Type | Method and 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.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
String |
name()
The name of the state machine.
|
String |
roleArn()
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
|
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 |
statusString()
The current status of the state machine.
|
DescribeStateMachineResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String stateMachineArn()
The Amazon Resource Name (ARN) that identifies the state machine.
public String name()
The name of the state machine.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
public 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
statusString()
.
StateMachineStatus
public String statusString()
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
statusString()
.
StateMachineStatus
public String definition()
The Amazon States Language definition of the state machine.
public 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 AWS resources.)
public Instant creationDate()
The date the state machine is created.
public DescribeStateMachineResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>
toBuilder
in class AwsResponse
public static DescribeStateMachineResponse.Builder builder()
public static Class<? extends DescribeStateMachineResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.