DescribeStateMachineResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.stepfunctions.model

Class DescribeStateMachineResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.stepfunctions.model.DescribeStateMachineResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeStateMachineResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeStateMachineResult ()

Constructors
Constructor and Description
`DescribeStateMachineResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`DescribeStateMachineResult`	`clone ()`
`boolean`	`equals (Object obj)`
`Date`	`getCreationDate ()` The date the state machine is created.
`String`	`getDefinition ()` The Amazon States Language definition of the state machine.
`String`	`getDescription ()` The description of the state machine version.
`EncryptionConfiguration`	`getEncryptionConfiguration ()` Settings to configure server-side encryption.
`String`	`getLabel ()` A user-defined or an auto-generated string that identifies a `Map` state.
`LoggingConfiguration`	`getLoggingConfiguration ()`
`String`	`getName ()` The name of the state machine.
`String`	`getRevisionId ()` The revision identifier for the state machine.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
`String`	`getStateMachineArn ()` The Amazon Resource Name (ARN) that identifies the state machine.
`String`	`getStatus ()` The current status of the state machine.
`TracingConfiguration`	`getTracingConfiguration ()` Selects whether X-Ray tracing is enabled.
`String`	`getType ()` The `type` of the state machine (`STANDARD` or `EXPRESS`).
`int`	`hashCode ()`
`void`	`setCreationDate (Date creationDate)` The date the state machine is created.
`void`	`setDefinition (String definition)` The Amazon States Language definition of the state machine.
`void`	`setDescription (String description)` The description of the state machine version.
`void`	`setEncryptionConfiguration (EncryptionConfiguration encryptionConfiguration)` Settings to configure server-side encryption.
`void`	`setLabel (String label)` A user-defined or an auto-generated string that identifies a `Map` state.
`void`	`setLoggingConfiguration (LoggingConfiguration loggingConfiguration)`
`void`	`setName (String name)` The name of the state machine.
`void`	`setRevisionId (String revisionId)` The revision identifier for the state machine.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
`void`	`setStateMachineArn (String stateMachineArn)` The Amazon Resource Name (ARN) that identifies the state machine.
`void`	`setStatus (StateMachineStatus status)` The current status of the state machine.
`void`	`setStatus (String status)` The current status of the state machine.
`void`	`setTracingConfiguration (TracingConfiguration tracingConfiguration)` Selects whether X-Ray tracing is enabled.
`void`	`setType (StateMachineType type)` The `type` of the state machine (`STANDARD` or `EXPRESS`).
`void`	`setType (String type)` The `type` of the state machine (`STANDARD` or `EXPRESS`).
`String`	`toString ()` Returns a string representation of this object.
`DescribeStateMachineResult`	`withCreationDate (Date creationDate)` The date the state machine is created.
`DescribeStateMachineResult`	`withDefinition (String definition)` The Amazon States Language definition of the state machine.
`DescribeStateMachineResult`	`withDescription (String description)` The description of the state machine version.
`DescribeStateMachineResult`	`withEncryptionConfiguration (EncryptionConfiguration encryptionConfiguration)` Settings to configure server-side encryption.
`DescribeStateMachineResult`	`withLabel (String label)` A user-defined or an auto-generated string that identifies a `Map` state.
`DescribeStateMachineResult`	`withLoggingConfiguration (LoggingConfiguration loggingConfiguration)`
`DescribeStateMachineResult`	`withName (String name)` The name of the state machine.
`DescribeStateMachineResult`	`withRevisionId (String revisionId)` The revision identifier for the state machine.
`DescribeStateMachineResult`	`withRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
`DescribeStateMachineResult`	`withStateMachineArn (String stateMachineArn)` The Amazon Resource Name (ARN) that identifies the state machine.
`DescribeStateMachineResult`	`withStatus (StateMachineStatus status)` The current status of the state machine.
`DescribeStateMachineResult`	`withStatus (String status)` The current status of the state machine.
`DescribeStateMachineResult`	`withTracingConfiguration (TracingConfiguration tracingConfiguration)` Selects whether X-Ray tracing is enabled.
`DescribeStateMachineResult`	`withType (StateMachineType type)` The `type` of the state machine (`STANDARD` or `EXPRESS`).
`DescribeStateMachineResult`	`withType (String type)` The `type` of the state machine (`STANDARD` or `EXPRESS`).

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeStateMachineResult
```
public DescribeStateMachineResult()
```
- Method Detail
  - setStateMachineArn
```
public void setStateMachineArn(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.
  - getStateMachineArn
```
public String getStateMachineArn()
```
    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.
  - withStateMachineArn
```
public DescribeStateMachineResult withStateMachineArn(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.
  - setName
```
public void setName(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 _.
  - getName
```
public String getName()
```
    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 _.
  - withName
```
public DescribeStateMachineResult withName(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.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the state machine.
    
    Parameters:
    
    status - The current status of the state machine.
    
    See Also:
    
    StateMachineStatus
  - getStatus
```
public String getStatus()
```
    The current status of the state machine.
    
    Returns:
    
    The current status of the state machine.
    
    See Also:
    
    StateMachineStatus
  - withStatus
```
public DescribeStateMachineResult withStatus(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
  - setStatus
```
public void setStatus(StateMachineStatus status)
```
    The current status of the state machine.
    
    Parameters:
    
    status - The current status of the state machine.
    
    See Also:
    
    StateMachineStatus
  - withStatus
```
public DescribeStateMachineResult withStatus(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
  - setDefinition
```
public void setDefinition(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 {}.
    
    Parameters:
    
    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 {}.
  - getDefinition
```
public String getDefinition()
```
    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 {}.
  - withDefinition
```
public DescribeStateMachineResult withDefinition(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 {}.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(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.)
  - getRoleArn
```
public String getRoleArn()
```
    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.)
  - withRoleArn
```
public DescribeStateMachineResult withRoleArn(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.
  - setType
```
public void setType(String type)
```
    The type of the state machine (STANDARD or EXPRESS).
    
    Parameters:
    
    type - The type of the state machine (STANDARD or EXPRESS).
    
    See Also:
    
    StateMachineType
  - getType
```
public String getType()
```
    The type of the state machine (STANDARD or EXPRESS).
    
    Returns:
    
    The type of the state machine (STANDARD or EXPRESS).
    
    See Also:
    
    StateMachineType
  - withType
```
public DescribeStateMachineResult withType(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
  - setType
```
public void setType(StateMachineType type)
```
    The type of the state machine (STANDARD or EXPRESS).
    
    Parameters:
    
    type - The type of the state machine (STANDARD or EXPRESS).
    
    See Also:
    
    StateMachineType
  - withType
```
public DescribeStateMachineResult withType(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
  - setCreationDate
```
public void setCreationDate(Date 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.
  - getCreationDate
```
public Date getCreationDate()
```
    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.
  - withCreationDate
```
public DescribeStateMachineResult withCreationDate(Date 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.
  - setLoggingConfiguration
```
public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    Parameters:
    
    loggingConfiguration -
  - getLoggingConfiguration
```
public LoggingConfiguration getLoggingConfiguration()
```
    Returns:
  - withLoggingConfiguration
```
public DescribeStateMachineResult withLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    Parameters:
    
    loggingConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTracingConfiguration
```
public void setTracingConfiguration(TracingConfiguration tracingConfiguration)
```
    Selects whether X-Ray tracing is enabled.
    
    Parameters:
    
    tracingConfiguration - Selects whether X-Ray tracing is enabled.
  - getTracingConfiguration
```
public TracingConfiguration getTracingConfiguration()
```
    Selects whether X-Ray tracing is enabled.
    
    Returns:
    
    Selects whether X-Ray tracing is enabled.
  - withTracingConfiguration
```
public DescribeStateMachineResult withTracingConfiguration(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.
  - setLabel
```
public void setLabel(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.
  - getLabel
```
public String getLabel()
```
    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.
  - withLabel
```
public DescribeStateMachineResult withLabel(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.
  - setRevisionId
```
public void setRevisionId(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.
  - getRevisionId
```
public String getRevisionId()
```
    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.
  - withRevisionId
```
public DescribeStateMachineResult withRevisionId(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.
  - setDescription
```
public void setDescription(String description)
```
    The description of the state machine version.
    
    Parameters:
    
    description - The description of the state machine version.
  - getDescription
```
public String getDescription()
```
    The description of the state machine version.
    
    Returns:
    
    The description of the state machine version.
  - withDescription
```
public DescribeStateMachineResult withDescription(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.
  - setEncryptionConfiguration
```
public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    Settings to configure server-side encryption.
    
    Parameters:
    
    encryptionConfiguration - Settings to configure server-side encryption.
  - getEncryptionConfiguration
```
public EncryptionConfiguration getEncryptionConfiguration()
```
    Settings to configure server-side encryption.
    
    Returns:
    
    Settings to configure server-side encryption.
  - withEncryptionConfiguration
```
public DescribeStateMachineResult withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    Settings to configure server-side encryption.
    
    Parameters:
    
    encryptionConfiguration - Settings to configure server-side encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeStateMachineResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class DescribeStateMachineResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeStateMachineResult

Method Detail

setStateMachineArn

getStateMachineArn

withStateMachineArn

setName

getName

withName

setStatus

getStatus

withStatus

setStatus

withStatus

setDefinition

getDefinition

withDefinition

setRoleArn

getRoleArn

withRoleArn

setType

getType

withType

setType

withType

setCreationDate

getCreationDate

withCreationDate

setLoggingConfiguration

getLoggingConfiguration

withLoggingConfiguration

setTracingConfiguration

getTracingConfiguration

withTracingConfiguration

setLabel

getLabel

withLabel

setRevisionId

getRevisionId

withRevisionId

setDescription

getDescription

withDescription

setEncryptionConfiguration

getEncryptionConfiguration

withEncryptionConfiguration

toString

equals

hashCode

clone