com.amazonaws.services.stepfunctions.model.StartExecutionRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the state machine to execute.
*
*/
private String stateMachineArn;
/**
*
* The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days.
* For more information, see
* Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
*
* 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 _.
*
*/
private String name;
/**
*
* The string that contains the JSON input data for the execution, for example:
*
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*
*/
private String input;
/**
*
* The Amazon Resource Name (ARN) of the state machine to execute.
*
*
* @param stateMachineArn
* The Amazon Resource Name (ARN) of the state machine to execute.
*/
public void setStateMachineArn(String stateMachineArn) {
this.stateMachineArn = stateMachineArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine to execute.
*
*
* @return The Amazon Resource Name (ARN) of the state machine to execute.
*/
public String getStateMachineArn() {
return this.stateMachineArn;
}
/**
*
* The Amazon Resource Name (ARN) of the state machine to execute.
*
*
* @param stateMachineArn
* The Amazon Resource Name (ARN) of the state machine to execute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartExecutionRequest withStateMachineArn(String stateMachineArn) {
setStateMachineArn(stateMachineArn);
return this;
}
/**
*
* The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days.
* For more information, see
* Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
*
* 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. This name must be unique for your AWS account, region, and state machine for 90
* days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
* 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. This name must be unique for your AWS account, region, and state machine for 90 days.
* For more information, see
* Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
*
* 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. This name must be unique for your AWS account, region, and state machine for
* 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
* 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. This name must be unique for your AWS account, region, and state machine for 90 days.
* For more information, see
* Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
*
* 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. This name must be unique for your AWS account, region, and state machine for 90
* days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
*
* 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 StartExecutionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The string that contains the JSON input data for the execution, for example:
*
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*
*
* @param input
* The string that contains the JSON input data for the execution, for example:
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*/
public void setInput(String input) {
this.input = input;
}
/**
*
* The string that contains the JSON input data for the execution, for example:
*
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*
*
* @return The string that contains the JSON input data for the execution, for example:
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*/
public String getInput() {
return this.input;
}
/**
*
* The string that contains the JSON input data for the execution, for example:
*
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
*
*
* @param input
* The string that contains the JSON input data for the execution, for example:
*
* "input": "{\"first_name\" : \"test\"}"
*
*
*
* If you don't include any JSON input data, you still must include the two braces, for example:
* "input": "{}"
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartExecutionRequest withInput(String input) {
setInput(input);
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 (getStateMachineArn() != null)
sb.append("StateMachineArn: ").append(getStateMachineArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getInput() != null)
sb.append("Input: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartExecutionRequest == false)
return false;
StartExecutionRequest other = (StartExecutionRequest) obj;
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.getInput() == null ^ this.getInput() == null)
return false;
if (other.getInput() != null && other.getInput().equals(this.getInput()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStateMachineArn() == null) ? 0 : getStateMachineArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getInput() == null) ? 0 : getInput().hashCode());
return hashCode;
}
@Override
public StartExecutionRequest clone() {
return (StartExecutionRequest) super.clone();
}
}