/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.stepfunctions.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeExecutionResult extends com.amazonaws.AmazonWebServiceResult
* The Amazon Resource Name (ARN) that identifies the execution.
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
* The name of the execution.
*
* A name must not contain:
*
* white space
*
* brackets
* wildcard characters
* special characters
* control characters (
* To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*
* The current status of the execution.
*
* The date the execution is started.
*
* If the execution ended, the date the execution stopped.
*
* 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.
*
* 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.
*
* The X-Ray trace header that was passed to the execution.
*
* The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
*
* The error string if the state machine execution failed.
*
* The cause string if the state machine execution failed.
*
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a
* combination of state machine ARN and the version number separated by a colon (:). For example,
*
* If you start an execution from a
* The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a
* combination of state machine ARN and the alias name separated by a colon (:). For example,
*
* If you start an execution from a
* The Amazon Resource Name (ARN) that identifies the execution.
*
* The Amazon Resource Name (ARN) that identifies the execution.
*
* The Amazon Resource Name (ARN) that identifies the execution.
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
* The name of the execution.
*
* A name must not contain:
*
* white space
*
* brackets
* wildcard characters
* special characters
* control characters (
* To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*
*
* < > { } [ ]
* ? *
* " # % \ ^ | ~ ` $ & , ; : /
* U+0000-001F
, U+007F-009F
)
* stateMachineARN:1
.
* StartExecution
request without specifying a state machine version
* or alias ARN, Step Functions returns a null value.
* stateMachineARN:PROD
.
* StartExecution
request with a state machine version ARN, this field
* will be null.
*
*
* < > { } [ ]
* ? *
* " # % \ ^ | ~ ` $ & , ; : /
* U+0000-001F
, U+007F-009F
)
*
* 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 _. */ public void setName(String name) { this.name = 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 _. *
* * @return 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 _. */ public String getName() { return this.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 _. *
* * @param 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 _. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withName(String name) { setName(name); return this; } /** *
* The current status of the execution. *
* * @param status * The current status of the execution. * @see ExecutionStatus */ public void setStatus(String status) { this.status = status; } /** ** The current status of the execution. *
* * @return The current status of the execution. * @see ExecutionStatus */ public String getStatus() { return this.status; } /** ** The current status of the execution. *
* * @param status * The current status of the execution. * @return Returns a reference to this object so that method calls can be chained together. * @see ExecutionStatus */ public DescribeExecutionResult withStatus(String status) { setStatus(status); return this; } /** ** The current status of the execution. *
* * @param status * The current status of the execution. * @see ExecutionStatus */ public void setStatus(ExecutionStatus status) { withStatus(status); } /** ** The current status of the execution. *
* * @param status * The current status of the execution. * @return Returns a reference to this object so that method calls can be chained together. * @see ExecutionStatus */ public DescribeExecutionResult withStatus(ExecutionStatus status) { this.status = status.toString(); return this; } /** ** The date the execution is started. *
* * @param startDate * The date the execution is started. */ public void setStartDate(java.util.Date startDate) { this.startDate = startDate; } /** ** The date the execution is started. *
* * @return The date the execution is started. */ public java.util.Date getStartDate() { return this.startDate; } /** ** The date the execution is started. *
* * @param startDate * The date the execution is started. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withStartDate(java.util.Date startDate) { setStartDate(startDate); return this; } /** ** If the execution ended, the date the execution stopped. *
* * @param stopDate * If the execution ended, the date the execution stopped. */ public void setStopDate(java.util.Date stopDate) { this.stopDate = stopDate; } /** ** If the execution ended, the date the execution stopped. *
* * @return If the execution ended, the date the execution stopped. */ public java.util.Date getStopDate() { return this.stopDate; } /** ** If the execution ended, the date the execution stopped. *
* * @param stopDate * If the execution ended, the date the execution stopped. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withStopDate(java.util.Date stopDate) { setStopDate(stopDate); return this; } /** ** 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. *
* * @param 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. */ public void setInput(String input) { this.input = 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. *
* * @return 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. */ public String getInput() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withInput(String input) { setInput(input); return this; } /** * @param inputDetails */ public void setInputDetails(CloudWatchEventsExecutionDataDetails inputDetails) { this.inputDetails = inputDetails; } /** * @return */ public CloudWatchEventsExecutionDataDetails getInputDetails() { return this.inputDetails; } /** * @param inputDetails * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withInputDetails(CloudWatchEventsExecutionDataDetails inputDetails) { setInputDetails(inputDetails); return this; } /** ** 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. *
** This field is set only if the execution succeeds. If the execution fails, this field is null. *
*/ public void setOutput(String output) { this.output = 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. *
** This field is set only if the execution succeeds. If the execution fails, this field is null. *
*/ public String getOutput() { return this.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. *
** This field is set only if the execution succeeds. If the execution fails, this field is null. *
* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withOutput(String output) { setOutput(output); return this; } /** * @param outputDetails */ public void setOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails) { this.outputDetails = outputDetails; } /** * @return */ public CloudWatchEventsExecutionDataDetails getOutputDetails() { return this.outputDetails; } /** * @param outputDetails * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withOutputDetails(CloudWatchEventsExecutionDataDetails outputDetails) { setOutputDetails(outputDetails); return this; } /** ** The X-Ray trace header that was passed to the execution. *
* * @param traceHeader * The X-Ray trace header that was passed to the execution. */ public void setTraceHeader(String traceHeader) { this.traceHeader = traceHeader; } /** ** The X-Ray trace header that was passed to the execution. *
* * @return The X-Ray trace header that was passed to the execution. */ public String getTraceHeader() { return this.traceHeader; } /** ** The X-Ray trace header that was passed to the execution. *
* * @param traceHeader * The X-Ray trace header that was passed to the execution. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withTraceHeader(String traceHeader) { setTraceHeader(traceHeader); return this; } /** ** The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. *
* * @param mapRunArn * The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. */ public void setMapRunArn(String mapRunArn) { this.mapRunArn = mapRunArn; } /** ** The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. *
* * @return The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. */ public String getMapRunArn() { return this.mapRunArn; } /** ** The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. *
* * @param mapRunArn * The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withMapRunArn(String mapRunArn) { setMapRunArn(mapRunArn); return this; } /** ** The error string if the state machine execution failed. *
* * @param error * The error string if the state machine execution failed. */ public void setError(String error) { this.error = error; } /** ** The error string if the state machine execution failed. *
* * @return The error string if the state machine execution failed. */ public String getError() { return this.error; } /** ** The error string if the state machine execution failed. *
* * @param error * The error string if the state machine execution failed. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withError(String error) { setError(error); return this; } /** ** The cause string if the state machine execution failed. *
* * @param cause * The cause string if the state machine execution failed. */ public void setCause(String cause) { this.cause = cause; } /** ** The cause string if the state machine execution failed. *
* * @return The cause string if the state machine execution failed. */ public String getCause() { return this.cause; } /** ** The cause string if the state machine execution failed. *
* * @param cause * The cause string if the state machine execution failed. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExecutionResult withCause(String cause) { setCause(cause); return this; } /** *
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a
* combination of state machine ARN and the version number separated by a colon (:). For example,
* stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine version
* or alias ARN, Step Functions returns a null value.
*
stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine
* version or alias ARN, Step Functions returns a null value.
*/
public void setStateMachineVersionArn(String stateMachineVersionArn) {
this.stateMachineVersionArn = stateMachineVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a
* combination of state machine ARN and the version number separated by a colon (:). For example,
* stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine version
* or alias ARN, Step Functions returns a null value.
*
stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine
* version or alias ARN, Step Functions returns a null value.
*/
public String getStateMachineVersionArn() {
return this.stateMachineVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a
* combination of state machine ARN and the version number separated by a colon (:). For example,
* stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine version
* or alias ARN, Step Functions returns a null value.
*
stateMachineARN:1
.
*
* If you start an execution from a StartExecution
request without specifying a state machine
* version or alias ARN, Step Functions returns a null value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeExecutionResult withStateMachineVersionArn(String stateMachineVersionArn) {
setStateMachineVersionArn(stateMachineVersionArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a
* combination of state machine ARN and the alias name separated by a colon (:). For example,
* stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN, this field
* will be null.
*
stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN,
* this field will be null.
*/
public void setStateMachineAliasArn(String stateMachineAliasArn) {
this.stateMachineAliasArn = stateMachineAliasArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a
* combination of state machine ARN and the alias name separated by a colon (:). For example,
* stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN, this field
* will be null.
*
stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN,
* this field will be null.
*/
public String getStateMachineAliasArn() {
return this.stateMachineAliasArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a
* combination of state machine ARN and the alias name separated by a colon (:). For example,
* stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN, this field
* will be null.
*
stateMachineARN:PROD
.
*
* If you start an execution from a StartExecution
request with a state machine version ARN,
* this field will be null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeExecutionResult withStateMachineAliasArn(String stateMachineAliasArn) {
setStateMachineAliasArn(stateMachineAliasArn);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getExecutionArn() != null)
sb.append("ExecutionArn: ").append(getExecutionArn()).append(",");
if (getStateMachineArn() != null)
sb.append("StateMachineArn: ").append(getStateMachineArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStartDate() != null)
sb.append("StartDate: ").append(getStartDate()).append(",");
if (getStopDate() != null)
sb.append("StopDate: ").append(getStopDate()).append(",");
if (getInput() != null)
sb.append("Input: ").append("***Sensitive Data Redacted***").append(",");
if (getInputDetails() != null)
sb.append("InputDetails: ").append(getInputDetails()).append(",");
if (getOutput() != null)
sb.append("Output: ").append("***Sensitive Data Redacted***").append(",");
if (getOutputDetails() != null)
sb.append("OutputDetails: ").append(getOutputDetails()).append(",");
if (getTraceHeader() != null)
sb.append("TraceHeader: ").append(getTraceHeader()).append(",");
if (getMapRunArn() != null)
sb.append("MapRunArn: ").append(getMapRunArn()).append(",");
if (getError() != null)
sb.append("Error: ").append("***Sensitive Data Redacted***").append(",");
if (getCause() != null)
sb.append("Cause: ").append("***Sensitive Data Redacted***").append(",");
if (getStateMachineVersionArn() != null)
sb.append("StateMachineVersionArn: ").append(getStateMachineVersionArn()).append(",");
if (getStateMachineAliasArn() != null)
sb.append("StateMachineAliasArn: ").append(getStateMachineAliasArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeExecutionResult == false)
return false;
DescribeExecutionResult other = (DescribeExecutionResult) obj;
if (other.getExecutionArn() == null ^ this.getExecutionArn() == null)
return false;
if (other.getExecutionArn() != null && other.getExecutionArn().equals(this.getExecutionArn()) == false)
return false;
if (other.getStateMachineArn() == null ^ this.getStateMachineArn() == null)
return false;
if (other.getStateMachineArn() != null && other.getStateMachineArn().equals(this.getStateMachineArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStartDate() == null ^ this.getStartDate() == null)
return false;
if (other.getStartDate() != null && other.getStartDate().equals(this.getStartDate()) == false)
return false;
if (other.getStopDate() == null ^ this.getStopDate() == null)
return false;
if (other.getStopDate() != null && other.getStopDate().equals(this.getStopDate()) == false)
return false;
if (other.getInput() == null ^ this.getInput() == null)
return false;
if (other.getInput() != null && other.getInput().equals(this.getInput()) == false)
return false;
if (other.getInputDetails() == null ^ this.getInputDetails() == null)
return false;
if (other.getInputDetails() != null && other.getInputDetails().equals(this.getInputDetails()) == false)
return false;
if (other.getOutput() == null ^ this.getOutput() == null)
return false;
if (other.getOutput() != null && other.getOutput().equals(this.getOutput()) == false)
return false;
if (other.getOutputDetails() == null ^ this.getOutputDetails() == null)
return false;
if (other.getOutputDetails() != null && other.getOutputDetails().equals(this.getOutputDetails()) == false)
return false;
if (other.getTraceHeader() == null ^ this.getTraceHeader() == null)
return false;
if (other.getTraceHeader() != null && other.getTraceHeader().equals(this.getTraceHeader()) == false)
return false;
if (other.getMapRunArn() == null ^ this.getMapRunArn() == null)
return false;
if (other.getMapRunArn() != null && other.getMapRunArn().equals(this.getMapRunArn()) == false)
return false;
if (other.getError() == null ^ this.getError() == null)
return false;
if (other.getError() != null && other.getError().equals(this.getError()) == false)
return false;
if (other.getCause() == null ^ this.getCause() == null)
return false;
if (other.getCause() != null && other.getCause().equals(this.getCause()) == false)
return false;
if (other.getStateMachineVersionArn() == null ^ this.getStateMachineVersionArn() == null)
return false;
if (other.getStateMachineVersionArn() != null && other.getStateMachineVersionArn().equals(this.getStateMachineVersionArn()) == false)
return false;
if (other.getStateMachineAliasArn() == null ^ this.getStateMachineAliasArn() == null)
return false;
if (other.getStateMachineAliasArn() != null && other.getStateMachineAliasArn().equals(this.getStateMachineAliasArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExecutionArn() == null) ? 0 : getExecutionArn().hashCode());
hashCode = prime * hashCode + ((getStateMachineArn() == null) ? 0 : getStateMachineArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStartDate() == null) ? 0 : getStartDate().hashCode());
hashCode = prime * hashCode + ((getStopDate() == null) ? 0 : getStopDate().hashCode());
hashCode = prime * hashCode + ((getInput() == null) ? 0 : getInput().hashCode());
hashCode = prime * hashCode + ((getInputDetails() == null) ? 0 : getInputDetails().hashCode());
hashCode = prime * hashCode + ((getOutput() == null) ? 0 : getOutput().hashCode());
hashCode = prime * hashCode + ((getOutputDetails() == null) ? 0 : getOutputDetails().hashCode());
hashCode = prime * hashCode + ((getTraceHeader() == null) ? 0 : getTraceHeader().hashCode());
hashCode = prime * hashCode + ((getMapRunArn() == null) ? 0 : getMapRunArn().hashCode());
hashCode = prime * hashCode + ((getError() == null) ? 0 : getError().hashCode());
hashCode = prime * hashCode + ((getCause() == null) ? 0 : getCause().hashCode());
hashCode = prime * hashCode + ((getStateMachineVersionArn() == null) ? 0 : getStateMachineVersionArn().hashCode());
hashCode = prime * hashCode + ((getStateMachineAliasArn() == null) ? 0 : getStateMachineAliasArn().hashCode());
return hashCode;
}
@Override
public DescribeExecutionResult clone() {
try {
return (DescribeExecutionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}