/* * 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.transfer.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 CreateWorkflowRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A textual description for the workflow. *

*/ private String description; /** *

* Specifies the details for the steps that are in the specified workflow. *

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. *

*/ private java.util.List steps; /** *

* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. *

* *

* For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off the * exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, the * exception steps are executed. *

* */ private java.util.List onExceptionSteps; /** *

* Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for * any purpose. *

*/ private java.util.List tags; /** *

* A textual description for the workflow. *

* * @param description * A textual description for the workflow. */ public void setDescription(String description) { this.description = description; } /** *

* A textual description for the workflow. *

* * @return A textual description for the workflow. */ public String getDescription() { return this.description; } /** *

* A textual description for the workflow. *

* * @param description * A textual description for the workflow. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withDescription(String description) { setDescription(description); return this; } /** *

* Specifies the details for the steps that are in the specified workflow. *

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. *

* * @return Specifies the details for the steps that are in the specified workflow.

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and * path. */ public java.util.List getSteps() { return steps; } /** *

* Specifies the details for the steps that are in the specified workflow. *

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. *

* * @param steps * Specifies the details for the steps that are in the specified workflow.

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and * path. */ public void setSteps(java.util.Collection steps) { if (steps == null) { this.steps = null; return; } this.steps = new java.util.ArrayList(steps); } /** *

* Specifies the details for the steps that are in the specified workflow. *

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSteps(java.util.Collection)} or {@link #withSteps(java.util.Collection)} if you want to override the * existing values. *

* * @param steps * Specifies the details for the steps that are in the specified workflow.

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and * path. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withSteps(WorkflowStep... steps) { if (this.steps == null) { setSteps(new java.util.ArrayList(steps.length)); } for (WorkflowStep ele : steps) { this.steps.add(ele); } return this; } /** *

* Specifies the details for the steps that are in the specified workflow. *

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path. *

* * @param steps * Specifies the details for the steps that are in the specified workflow.

* The TYPE specifies which of the following actions is being taken for this step. *

*
* COPY - Copy the file to another location. *
*
*
* CUSTOM - Perform a custom step with an Lambda function target. *
*
*
* DECRYPT - Decrypt a file that was encrypted before it was uploaded. *
*
*
* DELETE - Delete the file. *
*
*
* TAG - Add a tag to the file. *
*

* *

* Currently, copying and tagging are supported only on S3. *

* *

* For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and * path. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withSteps(java.util.Collection steps) { setSteps(steps); return this; } /** *

* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. *

* *

* * * @return Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

* *

* For custom steps, the Lambda function needs to send FAILURE to the call back API to kick off * the exception steps. Additionally, if the Lambda does not send SUCCESS before it times out, * the exception steps are executed. *

*/ public java.util.List getOnExceptionSteps() { return onExceptionSteps; } /** *

* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. *

* *

* * * @param onExceptionSteps * Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

* *

*/ public void setOnExceptionSteps(java.util.Collection onExceptionSteps) { if (onExceptionSteps == null) { this.onExceptionSteps = null; return; } this.onExceptionSteps = new java.util.ArrayList(onExceptionSteps); } /** *

* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setOnExceptionSteps(java.util.Collection)} or {@link #withOnExceptionSteps(java.util.Collection)} if you * want to override the existing values. *

* * @param onExceptionSteps * Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withOnExceptionSteps(WorkflowStep... onExceptionSteps) { if (this.onExceptionSteps == null) { setOnExceptionSteps(new java.util.ArrayList(onExceptionSteps.length)); } for (WorkflowStep ele : onExceptionSteps) { this.onExceptionSteps.add(ele); } return this; } /** *

* Specifies the steps (actions) to take if errors are encountered during execution of the workflow. *

* *

* * * @param onExceptionSteps * Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

* *

* @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withOnExceptionSteps(java.util.Collection onExceptionSteps) { setOnExceptionSteps(onExceptionSteps); return this; } /** *

* Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for * any purpose. *

* * @return Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to * workflows for any purpose. */ public java.util.List getTags() { return tags; } /** *

* Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for * any purpose. *

* * @param tags * Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to * workflows for any purpose. */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for * any purpose. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *

* Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for * any purpose. *

* * @param tags * Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to * workflows for any purpose. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateWorkflowRequest withTags(java.util.Collection tags) { setTags(tags); 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 (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getSteps() != null) sb.append("Steps: ").append(getSteps()).append(","); if (getOnExceptionSteps() != null) sb.append("OnExceptionSteps: ").append(getOnExceptionSteps()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateWorkflowRequest == false) return false; CreateWorkflowRequest other = (CreateWorkflowRequest) obj; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getSteps() == null ^ this.getSteps() == null) return false; if (other.getSteps() != null && other.getSteps().equals(this.getSteps()) == false) return false; if (other.getOnExceptionSteps() == null ^ this.getOnExceptionSteps() == null) return false; if (other.getOnExceptionSteps() != null && other.getOnExceptionSteps().equals(this.getOnExceptionSteps()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getSteps() == null) ? 0 : getSteps().hashCode()); hashCode = prime * hashCode + ((getOnExceptionSteps() == null) ? 0 : getOnExceptionSteps().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public CreateWorkflowRequest clone() { return (CreateWorkflowRequest) super.clone(); } }