com.amazonaws.services.transfer.model

Class CreateWorkflowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.CreateWorkflowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkflowRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWorkflowRequest()

Method Summary

Modifier and Type	Method and Description
CreateWorkflowRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A textual description for the workflow.
List<WorkflowStep>	getOnExceptionSteps() Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
List<WorkflowStep>	getSteps() Specifies the details for the steps that are in the specified workflow.
List<Tag>	getTags() Key-value pairs that can be used to group and search for workflows.
int	hashCode()
void	setDescription(String description) A textual description for the workflow.
void	setOnExceptionSteps(Collection<WorkflowStep> onExceptionSteps) Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
void	setSteps(Collection<WorkflowStep> steps) Specifies the details for the steps that are in the specified workflow.
void	setTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for workflows.
String	toString() Returns a string representation of this object.
CreateWorkflowRequest	withDescription(String description) A textual description for the workflow.
CreateWorkflowRequest	withOnExceptionSteps(Collection<WorkflowStep> onExceptionSteps) Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
CreateWorkflowRequest	withOnExceptionSteps(WorkflowStep... onExceptionSteps) Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
CreateWorkflowRequest	withSteps(Collection<WorkflowStep> steps) Specifies the details for the steps that are in the specified workflow.
CreateWorkflowRequest	withSteps(WorkflowStep... steps) Specifies the details for the steps that are in the specified workflow.
CreateWorkflowRequest	withTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for workflows.
CreateWorkflowRequest	withTags(Tag... tags) Key-value pairs that can be used to group and search for workflows.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWorkflowRequest

public CreateWorkflowRequest()

Method Detail

setDescription

public void setDescription(String description)

A textual description for the workflow.

Parameters:

description - A textual description for the workflow.

getDescription

public String getDescription()

A textual description for the workflow.

Returns:

A textual description for the workflow.

withDescription

public CreateWorkflowRequest withDescription(String description)

A textual description for the workflow.

Parameters:

description - A textual description for the workflow.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSteps

public List<WorkflowStep> getSteps()

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.

Returns:

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.

setSteps

public void setSteps(Collection<WorkflowStep> 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.

Parameters:

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.

withSteps

public CreateWorkflowRequest withSteps(WorkflowStep... 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 setSteps(java.util.Collection) or withSteps(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSteps

public CreateWorkflowRequest withSteps(Collection<WorkflowStep> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOnExceptionSteps

public List<WorkflowStep> getOnExceptionSteps()

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.

Returns:

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.

setOnExceptionSteps

public void setOnExceptionSteps(Collection<WorkflowStep> onExceptionSteps)

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.

Parameters:

onExceptionSteps - 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.

withOnExceptionSteps

public CreateWorkflowRequest withOnExceptionSteps(WorkflowStep... onExceptionSteps)

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.

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

Parameters:

onExceptionSteps - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withOnExceptionSteps

public CreateWorkflowRequest withOnExceptionSteps(Collection<WorkflowStep> onExceptionSteps)

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.

Parameters:

onExceptionSteps - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateWorkflowRequest withTags(Tag... 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 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateWorkflowRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateWorkflowRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()