DescribeExecutionResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeExecutionResult()

Constructors
Constructor and Description
`DescribeExecutionResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeExecutionResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getExecutionArn()` The Amazon Resource Name (ARN) that identifies the execution.
`String`	`getInput()` The string that contains the JSON input data of the execution.
`CloudWatchEventsExecutionDataDetails`	`getInputDetails()`
`String`	`getName()` The name of the execution.
`String`	`getOutput()` The JSON output data of the execution.
`CloudWatchEventsExecutionDataDetails`	`getOutputDetails()`
`Date`	`getStartDate()` The date the execution is started.
`String`	`getStateMachineArn()` The Amazon Resource Name (ARN) of the executed stated machine.
`String`	`getStatus()` The current status of the execution.
`Date`	`getStopDate()` If the execution has already ended, the date the execution stopped.
`String`	`getTraceHeader()` The AWS X-Ray trace header that was passed to the execution.
`int`	`hashCode()`
`void`	`setExecutionArn(String executionArn)` The Amazon Resource Name (ARN) that identifies the execution.
`void`	`setInput(String input)` The string that contains the JSON input data of the execution.
`void`	`setInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)`
`void`	`setName(String name)` The name of the execution.
`void`	`setOutput(String output)` The JSON output data of the execution.
`void`	`setOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)`
`void`	`setStartDate(Date startDate)` The date the execution is started.
`void`	`setStateMachineArn(String stateMachineArn)` The Amazon Resource Name (ARN) of the executed stated machine.
`void`	`setStatus(ExecutionStatus status)` The current status of the execution.
`void`	`setStatus(String status)` The current status of the execution.
`void`	`setStopDate(Date stopDate)` If the execution has already ended, the date the execution stopped.
`void`	`setTraceHeader(String traceHeader)` The AWS X-Ray trace header that was passed to the execution.
`String`	`toString()` Returns a string representation of this object.
`DescribeExecutionResult`	`withExecutionArn(String executionArn)` The Amazon Resource Name (ARN) that identifies the execution.
`DescribeExecutionResult`	`withInput(String input)` The string that contains the JSON input data of the execution.
`DescribeExecutionResult`	`withInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)`
`DescribeExecutionResult`	`withName(String name)` The name of the execution.
`DescribeExecutionResult`	`withOutput(String output)` The JSON output data of the execution.
`DescribeExecutionResult`	`withOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)`
`DescribeExecutionResult`	`withStartDate(Date startDate)` The date the execution is started.
`DescribeExecutionResult`	`withStateMachineArn(String stateMachineArn)` The Amazon Resource Name (ARN) of the executed stated machine.
`DescribeExecutionResult`	`withStatus(ExecutionStatus status)` The current status of the execution.
`DescribeExecutionResult`	`withStatus(String status)` The current status of the execution.
`DescribeExecutionResult`	`withStopDate(Date stopDate)` If the execution has already ended, the date the execution stopped.
`DescribeExecutionResult`	`withTraceHeader(String traceHeader)` The AWS X-Ray trace header that was passed to the execution.

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
  - DescribeExecutionResult
```
public DescribeExecutionResult()
```
- Method Detail
  - setExecutionArn
```
public void setExecutionArn(String executionArn)
```
    The Amazon Resource Name (ARN) that identifies the execution.
    
    Parameters:
    
    executionArn - The Amazon Resource Name (ARN) that identifies the execution.
  - getExecutionArn
```
public String getExecutionArn()
```
    The Amazon Resource Name (ARN) that identifies the execution.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the execution.
  - withExecutionArn
```
public DescribeExecutionResult withExecutionArn(String executionArn)
```
    The Amazon Resource Name (ARN) that identifies the execution.
    
    Parameters:
    
    executionArn - The Amazon Resource Name (ARN) that identifies the execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStateMachineArn
```
public void setStateMachineArn(String stateMachineArn)
```
    The Amazon Resource Name (ARN) of the executed stated machine.
    
    Parameters:
    
    stateMachineArn - The Amazon Resource Name (ARN) of the executed stated machine.
  - getStateMachineArn
```
public String getStateMachineArn()
```
    The Amazon Resource Name (ARN) of the executed stated machine.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the executed stated machine.
  - withStateMachineArn
```
public DescribeExecutionResult withStateMachineArn(String stateMachineArn)
```
    The Amazon Resource Name (ARN) of the executed stated machine.
    
    Parameters:
    
    stateMachineArn - The Amazon Resource Name (ARN) of the executed stated machine.
    
    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 execution.
    
    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 execution.
    
    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 execution.
    
    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 execution.
    
    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 DescribeExecutionResult withName(String name)
```
    The name of the execution.
    
    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 execution.
    
    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 execution.
    
    Parameters:
    
    status - The current status of the execution.
    
    See Also:
    
    ExecutionStatus
  - getStatus
```
public String getStatus()
```
    The current status of the execution.
    
    Returns:
    
    The current status of the execution.
    
    See Also:
    
    ExecutionStatus
  - withStatus
```
public DescribeExecutionResult withStatus(String status)
```
    The current status of the execution.
    
    Parameters:
    
    status - The current status of the execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionStatus
  - setStatus
```
public void setStatus(ExecutionStatus status)
```
    The current status of the execution.
    
    Parameters:
    
    status - The current status of the execution.
    
    See Also:
    
    ExecutionStatus
  - withStatus
```
public DescribeExecutionResult withStatus(ExecutionStatus status)
```
    The current status of the execution.
    
    Parameters:
    
    status - The current status of the execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionStatus
  - setStartDate
```
public void setStartDate(Date startDate)
```
    The date the execution is started.
    
    Parameters:
    
    startDate - The date the execution is started.
  - getStartDate
```
public Date getStartDate()
```
    The date the execution is started.
    
    Returns:
    
    The date the execution is started.
  - withStartDate
```
public DescribeExecutionResult withStartDate(Date startDate)
```
    The date the execution is started.
    
    Parameters:
    
    startDate - The date the execution is started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStopDate
```
public void setStopDate(Date stopDate)
```
    If the execution has already ended, the date the execution stopped.
    
    Parameters:
    
    stopDate - If the execution has already ended, the date the execution stopped.
  - getStopDate
```
public Date getStopDate()
```
    If the execution has already ended, the date the execution stopped.
    
    Returns:
    
    If the execution has already ended, the date the execution stopped.
  - withStopDate
```
public DescribeExecutionResult withStopDate(Date stopDate)
```
    If the execution has already ended, the date the execution stopped.
    
    Parameters:
    
    stopDate - If the execution has already ended, the date the execution stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInput
```
public void setInput(String input)
```
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Parameters:
    
    input - The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
  - getInput
```
public String getInput()
```
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Returns:
    
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
  - withInput
```
public DescribeExecutionResult withInput(String input)
```
    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Parameters:
    
    input - The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputDetails
```
public void setInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)
```
    Parameters:
    
    inputDetails -
  - getInputDetails
```
public CloudWatchEventsExecutionDataDetails getInputDetails()
```
    Returns:
  - withInputDetails
```
public DescribeExecutionResult withInputDetails(CloudWatchEventsExecutionDataDetails inputDetails)
```
    Parameters:
    
    inputDetails -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutput
```
public void setOutput(String output)
```
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
    
    Parameters:
    
    output - The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
  - getOutput
```
public String getOutput()
```
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
    
    Returns:
    
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
  - withOutput
```
public DescribeExecutionResult withOutput(String output)
```
    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
    
    Parameters:
    
    output - The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
    
    This field is set only if the execution succeeds. If the execution fails, this field is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputDetails
```
public void setOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)
```
    Parameters:
    
    outputDetails -
  - getOutputDetails
```
public CloudWatchEventsExecutionDataDetails getOutputDetails()
```
    Returns:
  - withOutputDetails
```
public DescribeExecutionResult withOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails)
```
    Parameters:
    
    outputDetails -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTraceHeader
```
public void setTraceHeader(String traceHeader)
```
    The AWS X-Ray trace header that was passed to the execution.
    
    Parameters:
    
    traceHeader - The AWS X-Ray trace header that was passed to the execution.
  - getTraceHeader
```
public String getTraceHeader()
```
    The AWS X-Ray trace header that was passed to the execution.
    
    Returns:
    
    The AWS X-Ray trace header that was passed to the execution.
  - withTraceHeader
```
public DescribeExecutionResult withTraceHeader(String traceHeader)
```
    The AWS X-Ray trace header that was passed to the execution.
    
    Parameters:
    
    traceHeader - The AWS X-Ray trace header that was passed to the execution.
    
    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 DescribeExecutionResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeExecutionResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeExecutionResult

Method Detail

setExecutionArn

getExecutionArn

withExecutionArn

setStateMachineArn

getStateMachineArn

withStateMachineArn

setName

getName

withName

setStatus

getStatus

withStatus

setStatus

withStatus

setStartDate

getStartDate

withStartDate

setStopDate

getStopDate

withStopDate

setInput

getInput

withInput

setInputDetails

getInputDetails

withInputDetails

setOutput

getOutput

withOutput

setOutputDetails

getOutputDetails

withOutputDetails

setTraceHeader

getTraceHeader

withTraceHeader

toString

equals

hashCode

clone