software.amazon.awssdk.services.sfn.model.DescribeStateMachineResponse 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 DescribeStateMachineResponse extends SFNResponse implements
ToCopyableBuilder {
private final String stateMachineArn;
private final String name;
private final String status;
private final String definition;
private final String roleArn;
private final Instant creationDate;
private DescribeStateMachineResponse(BuilderImpl builder) {
super(builder);
this.stateMachineArn = builder.stateMachineArn;
this.name = builder.name;
this.status = builder.status;
this.definition = builder.definition;
this.roleArn = builder.roleArn;
this.creationDate = builder.creationDate;
}
/**
*
* The Amazon Resource Name (ARN) that identifies the state machine.
*
*
* @return The Amazon Resource Name (ARN) that identifies the state machine.
*/
public String stateMachineArn() {
return stateMachineArn;
}
/**
*
* The name of the state machine.
*
*
* A name must not contain:
*
*
* -
*
* whitespace
*
*
* -
*
* brackets < > { } [ ]
*
*
* -
*
* wildcard characters ? *
*
*
* -
*
* special characters " # % \ ^ | ~ ` $ & , ; : /
*
*
* -
*
* control characters (U+0000-001F, U+007F-009F)
*
*
*
*
* @return The name of the state machine.
*
* 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 state machine.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StateMachineStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusString}.
*
*
* @return The current status of the state machine.
* @see StateMachineStatus
*/
public StateMachineStatus status() {
return StateMachineStatus.fromValue(status);
}
/**
*
* The current status of the state machine.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StateMachineStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusString}.
*
*
* @return The current status of the state machine.
* @see StateMachineStatus
*/
public String statusString() {
return status;
}
/**
*
* The Amazon States Language definition of the state machine.
*
*
* @return The Amazon States Language definition of the state machine.
*/
public String definition() {
return definition;
}
/**
*
* 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.)
*
*
* @return 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.)
*/
public String roleArn() {
return roleArn;
}
/**
*
* The date the state machine is created.
*
*
* @return The date the state machine is created.
*/
public Instant creationDate() {
return creationDate;
}
@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(stateMachineArn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(statusString());
hashCode = 31 * hashCode + Objects.hashCode(definition());
hashCode = 31 * hashCode + Objects.hashCode(roleArn());
hashCode = 31 * hashCode + Objects.hashCode(creationDate());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeStateMachineResponse)) {
return false;
}
DescribeStateMachineResponse other = (DescribeStateMachineResponse) obj;
return Objects.equals(stateMachineArn(), other.stateMachineArn()) && Objects.equals(name(), other.name())
&& Objects.equals(statusString(), other.statusString()) && Objects.equals(definition(), other.definition())
&& Objects.equals(roleArn(), other.roleArn()) && Objects.equals(creationDate(), other.creationDate());
}
@Override
public String toString() {
return ToString.builder("DescribeStateMachineResponse").add("StateMachineArn", stateMachineArn()).add("Name", name())
.add("Status", statusString()).add("Definition", definition()).add("RoleArn", roleArn())
.add("CreationDate", creationDate()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
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 "definition":
return Optional.of(clazz.cast(definition()));
case "roleArn":
return Optional.of(clazz.cast(roleArn()));
case "creationDate":
return Optional.of(clazz.cast(creationDate()));
default:
return Optional.empty();
}
}
public interface Builder extends SFNResponse.Builder, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) that identifies the state machine.
*
*
* @param stateMachineArn
* The Amazon Resource Name (ARN) that identifies the state machine.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stateMachineArn(String stateMachineArn);
/**
*
* The name of the state machine.
*
*
* 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 state machine.
*
* 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 state machine.
*
*
* @param status
* The current status of the state machine.
* @see StateMachineStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StateMachineStatus
*/
Builder status(String status);
/**
*
* The current status of the state machine.
*
*
* @param status
* The current status of the state machine.
* @see StateMachineStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StateMachineStatus
*/
Builder status(StateMachineStatus status);
/**
*
* The Amazon States Language definition of the state machine.
*
*
* @param definition
* The Amazon States Language definition of the state machine.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder definition(String definition);
/**
*
* 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.)
*
*
* @param 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.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roleArn(String roleArn);
/**
*
* The date the state machine is created.
*
*
* @param creationDate
* The date the state machine is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationDate(Instant creationDate);
}
static final class BuilderImpl extends SFNResponse.BuilderImpl implements Builder {
private String stateMachineArn;
private String name;
private String status;
private String definition;
private String roleArn;
private Instant creationDate;
private BuilderImpl() {
}
private BuilderImpl(DescribeStateMachineResponse model) {
stateMachineArn(model.stateMachineArn);
name(model.name);
status(model.status);
definition(model.definition);
roleArn(model.roleArn);
creationDate(model.creationDate);
}
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(StateMachineStatus status) {
this.status(status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final String getDefinition() {
return definition;
}
@Override
public final Builder definition(String definition) {
this.definition = definition;
return this;
}
public final void setDefinition(String definition) {
this.definition = definition;
}
public final String getRoleArn() {
return roleArn;
}
@Override
public final Builder roleArn(String roleArn) {
this.roleArn = roleArn;
return this;
}
public final void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
public final Instant getCreationDate() {
return creationDate;
}
@Override
public final Builder creationDate(Instant creationDate) {
this.creationDate = creationDate;
return this;
}
public final void setCreationDate(Instant creationDate) {
this.creationDate = creationDate;
}
@Override
public DescribeStateMachineResponse build() {
return new DescribeStateMachineResponse(this);
}
}
}