software.amazon.awssdk.services.sfn.model.DescribeExecutionResponse Maven / Gradle / Ivy
Show all versions of stepfunctions Show documentation
/*
* Copyright 2013-2018 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 software.amazon.awssdk.services.sfn.model;
import java.time.Instant;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Generated;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public class DescribeExecutionResponse extends SFNResponse implements
ToCopyableBuilder {
private final String executionArn;
private final String stateMachineArn;
private final String name;
private final String status;
private final Instant startDate;
private final Instant stopDate;
private final String input;
private final String output;
private DescribeExecutionResponse(BuilderImpl builder) {
super(builder);
this.executionArn = builder.executionArn;
this.stateMachineArn = builder.stateMachineArn;
this.name = builder.name;
this.status = builder.status;
this.startDate = builder.startDate;
this.stopDate = builder.stopDate;
this.input = builder.input;
this.output = builder.output;
}
/**
*
* The Amazon Resource Name (ARN) that identifies the execution.
*
*
* @return The Amazon Resource Name (ARN) that identifies the execution.
*/
public String executionArn() {
return executionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
*
* @return The Amazon Resource Name (ARN) of the executed stated machine.
*/
public String stateMachineArn() {
return stateMachineArn;
}
/**
*
* The name of the execution.
*
*
* A name must not contain:
*
*
* -
*
* whitespace
*
*
* -
*
* brackets < > { } [ ]
*
*
* -
*
* wildcard characters ? *
*
*
* -
*
* special characters " # % \ ^ | ~ ` $ & , ; : /
*
*
* -
*
* control characters (U+0000-001F, U+007F-009F)
*
*
*
*
* @return The name of the execution.
*
* A name must not contain:
*
*
* -
*
* whitespace
*
*
* -
*
* brackets < > { } [ ]
*
*
* -
*
* wildcard characters ? *
*
*
* -
*
* special characters " # % \ ^ | ~ ` $ & , ; : /
*
*
* -
*
* control characters (U+0000-001F, U+007F-009F)
*
*
*/
public String name() {
return name;
}
/**
*
* The current status of the execution.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ExecutionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusString}.
*
*
* @return The current status of the execution.
* @see ExecutionStatus
*/
public ExecutionStatus status() {
return ExecutionStatus.fromValue(status);
}
/**
*
* The current status of the execution.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ExecutionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusString}.
*
*
* @return The current status of the execution.
* @see ExecutionStatus
*/
public String statusString() {
return status;
}
/**
*
* The date the execution is started.
*
*
* @return The date the execution is started.
*/
public Instant startDate() {
return startDate;
}
/**
*
* If the execution has already ended, the date the execution stopped.
*
*
* @return If the execution has already ended, the date the execution stopped.
*/
public Instant stopDate() {
return stopDate;
}
/**
*
* The string that contains the JSON input data of the execution.
*
*
* @return The string that contains the JSON input data of the execution.
*/
public String input() {
return input;
}
/**
*
* The JSON output data of the execution.
*
*
*
* This field is set only if the execution succeeds. If the execution fails, this field is null.
*
*
*
* @return The JSON output data of the execution.
*
* This field is set only if the execution succeeds. If the execution fails, this field is null.
*
*/
public String output() {
return output;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(executionArn());
hashCode = 31 * hashCode + Objects.hashCode(stateMachineArn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(statusString());
hashCode = 31 * hashCode + Objects.hashCode(startDate());
hashCode = 31 * hashCode + Objects.hashCode(stopDate());
hashCode = 31 * hashCode + Objects.hashCode(input());
hashCode = 31 * hashCode + Objects.hashCode(output());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeExecutionResponse)) {
return false;
}
DescribeExecutionResponse other = (DescribeExecutionResponse) obj;
return Objects.equals(executionArn(), other.executionArn()) && Objects.equals(stateMachineArn(), other.stateMachineArn())
&& Objects.equals(name(), other.name()) && Objects.equals(statusString(), other.statusString())
&& Objects.equals(startDate(), other.startDate()) && Objects.equals(stopDate(), other.stopDate())
&& Objects.equals(input(), other.input()) && Objects.equals(output(), other.output());
}
@Override
public String toString() {
return ToString.builder("DescribeExecutionResponse").add("ExecutionArn", executionArn())
.add("StateMachineArn", stateMachineArn()).add("Name", name()).add("Status", statusString())
.add("StartDate", startDate()).add("StopDate", stopDate()).add("Input", input()).add("Output", output()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "executionArn":
return Optional.of(clazz.cast(executionArn()));
case "stateMachineArn":
return Optional.of(clazz.cast(stateMachineArn()));
case "name":
return Optional.of(clazz.cast(name()));
case "status":
return Optional.of(clazz.cast(statusString()));
case "startDate":
return Optional.of(clazz.cast(startDate()));
case "stopDate":
return Optional.of(clazz.cast(stopDate()));
case "input":
return Optional.of(clazz.cast(input()));
case "output":
return Optional.of(clazz.cast(output()));
default:
return Optional.empty();
}
}
public interface Builder extends SFNResponse.Builder, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) that identifies the execution.
*
*
* @param executionArn
* The Amazon Resource Name (ARN) that identifies the execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executionArn(String executionArn);
/**
*
* The Amazon Resource Name (ARN) of the executed stated machine.
*
*
* @param stateMachineArn
* The Amazon Resource Name (ARN) of the executed stated machine.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stateMachineArn(String stateMachineArn);
/**
*
* The name of the execution.
*
*
* A name must not contain:
*
*
* -
*
* whitespace
*
*
* -
*
* brackets < > { } [ ]
*
*
* -
*
* wildcard characters ? *
*
*
* -
*
* special characters " # % \ ^ | ~ ` $ & , ; : /
*
*
* -
*
* control characters (U+0000-001F, U+007F-009F)
*
*
*
*
* @param name
* The name of the execution.
*
* A name must not contain:
*
*
* -
*
* whitespace
*
*
* -
*
* brackets < > { } [ ]
*
*
* -
*
* wildcard characters ? *
*
*
* -
*
* special characters " # % \ ^ | ~ ` $ & , ; : /
*
*
* -
*
* control characters (U+0000-001F, U+007F-009F)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The current status of the execution.
*
*
* @param status
* The current status of the execution.
* @see ExecutionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
Builder status(String status);
/**
*
* The current status of the execution.
*
*
* @param status
* The current status of the execution.
* @see ExecutionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
Builder status(ExecutionStatus status);
/**
*
* 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.
*/
Builder startDate(Instant startDate);
/**
*
* If the execution has already ended, the date the execution stopped.
*
*
* @param stopDate
* If the execution has already ended, the date the execution stopped.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stopDate(Instant stopDate);
/**
*
* The string that contains the JSON input data of the execution.
*
*
* @param input
* The string that contains the JSON input data of the execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder input(String input);
/**
*
* The JSON output data of the execution.
*
*
*
* This field is set only if the execution succeeds. If the execution fails, this field is null.
*
*
*
* @param output
* The JSON output data of the execution.
*
* 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.
*/
Builder output(String output);
}
static final class BuilderImpl extends SFNResponse.BuilderImpl implements Builder {
private String executionArn;
private String stateMachineArn;
private String name;
private String status;
private Instant startDate;
private Instant stopDate;
private String input;
private String output;
private BuilderImpl() {
}
private BuilderImpl(DescribeExecutionResponse model) {
executionArn(model.executionArn);
stateMachineArn(model.stateMachineArn);
name(model.name);
status(model.status);
startDate(model.startDate);
stopDate(model.stopDate);
input(model.input);
output(model.output);
}
public final String getExecutionArn() {
return executionArn;
}
@Override
public final Builder executionArn(String executionArn) {
this.executionArn = executionArn;
return this;
}
public final void setExecutionArn(String executionArn) {
this.executionArn = executionArn;
}
public final String getStateMachineArn() {
return stateMachineArn;
}
@Override
public final Builder stateMachineArn(String stateMachineArn) {
this.stateMachineArn = stateMachineArn;
return this;
}
public final void setStateMachineArn(String stateMachineArn) {
this.stateMachineArn = stateMachineArn;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ExecutionStatus status) {
this.status(status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final Instant getStartDate() {
return startDate;
}
@Override
public final Builder startDate(Instant startDate) {
this.startDate = startDate;
return this;
}
public final void setStartDate(Instant startDate) {
this.startDate = startDate;
}
public final Instant getStopDate() {
return stopDate;
}
@Override
public final Builder stopDate(Instant stopDate) {
this.stopDate = stopDate;
return this;
}
public final void setStopDate(Instant stopDate) {
this.stopDate = stopDate;
}
public final String getInput() {
return input;
}
@Override
public final Builder input(String input) {
this.input = input;
return this;
}
public final void setInput(String input) {
this.input = input;
}
public final String getOutput() {
return output;
}
@Override
public final Builder output(String output) {
this.output = output;
return this;
}
public final void setOutput(String output) {
this.output = output;
}
@Override
public DescribeExecutionResponse build() {
return new DescribeExecutionResponse(this);
}
}
}