DescribeStateMachineResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeStateMachineResponse
extends SfnResponse
implements ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeStateMachineResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeStateMachineResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LoggingConfiguration`	`loggingConfiguration()` Returns the value of the LoggingConfiguration property for this object.
`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.
`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.
`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 String stateMachineArn()
```
    The Amazon Resource Name (ARN) that identifies the state machine.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the state machine.
  - name
```
public 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 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 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 String 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
```
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.)
    
    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 AWS resources.)
  - type
```
public 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 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 Instant creationDate()
```
    The date the state machine is created.
    
    Returns:
    
    The date the state machine is created.
  - loggingConfiguration
```
public LoggingConfiguration loggingConfiguration()
```
    Returns the value of the LoggingConfiguration property for this object.
    
    Returns:
    
    The value of the LoggingConfiguration property for this object.
  - toBuilder
```
public DescribeStateMachineResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeStateMachineResponse.Builder,DescribeStateMachineResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeStateMachineResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeStateMachineResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeStateMachineResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

stateMachineArn

name

status

statusAsString

definition

roleArn

type

typeAsString

creationDate

loggingConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields