Class DescribeStateMachineResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeStateMachineResponse.Builder,
DescribeStateMachineResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date the state machine is created.final String
The Amazon States Language definition of the state machine.final String
The description of the state machine version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
label()
A user-defined or an auto-generated string that identifies aMap
state.final LoggingConfiguration
Returns the value of the LoggingConfiguration property for this object.final String
name()
The name of the state machine.final String
The revision identifier for the state machine.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.static Class
<? extends DescribeStateMachineResponse.Builder> final String
The Amazon Resource Name (ARN) that identifies the state machine.final StateMachineStatus
status()
The current status of the state machine.final String
The current status of the state machine.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TracingConfiguration
Selects whether X-Ray tracing is enabled.final StateMachineType
type()
Thetype
of the state machine (STANDARD
orEXPRESS
).final String
Thetype
of the state machine (STANDARD
orEXPRESS
).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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 returnStateMachineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the state machine.
- See Also:
-
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 returnStateMachineStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the state machine.
- See Also:
-
definition
The Amazon States Language definition of the state machine. See Amazon States Language.
- Returns:
- The Amazon States Language definition of the state machine. See Amazon States Language.
-
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
The
type
of the state machine (STANDARD
orEXPRESS
).If the service returns an enum value that is not available in the current SDK version,
type
will returnStateMachineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The
type
of the state machine (STANDARD
orEXPRESS
). - See Also:
-
typeAsString
The
type
of the state machine (STANDARD
orEXPRESS
).If the service returns an enum value that is not available in the current SDK version,
type
will returnStateMachineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The
type
of the state machine (STANDARD
orEXPRESS
). - See Also:
-
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
Returns the value of the LoggingConfiguration property for this object.- Returns:
- The value of the LoggingConfiguration property for this object.
-
tracingConfiguration
Selects whether X-Ray tracing is enabled.
- Returns:
- Selects whether X-Ray tracing is enabled.
-
label
A user-defined or an auto-generated string that identifies a
Map
state. This parameter is present only if thestateMachineArn
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 thestateMachineArn
specified in input is a qualified state machine ARN.
-
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 asdefinition
androleArn
.- 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 asdefinition
androleArn
.
-
description
The description of the state machine version.
- Returns:
- The description of the state machine version.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeStateMachineResponse.Builder,
DescribeStateMachineResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-