software.amazon.awssdk.services.transfer.model

Class CreateWorkflowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.CreateWorkflowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateWorkflowRequest
extends TransferRequest
implements ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateWorkflowRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateWorkflowRequest.Builder	builder()
String	description() A textual description for the workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOnExceptionSteps() For responses, this returns true if the service returned a value for the OnExceptionSteps property.
boolean	hasSteps() For responses, this returns true if the service returned a value for the Steps property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<WorkflowStep>	onExceptionSteps() Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkflowRequest.Builder>	serializableBuilderClass()
List<WorkflowStep>	steps() Specifies the details for the steps that are in the specified workflow.
List<Tag>	tags() Key-value pairs that can be used to group and search for workflows.
CreateWorkflowRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public final String description()

A textual description for the workflow.

Returns:

A textual description for the workflow.

hasSteps

public final boolean hasSteps()

For responses, this returns true if the service returned a value for the Steps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

steps

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSteps() method.

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.

hasOnExceptionSteps

public final boolean hasOnExceptionSteps()

For responses, this returns true if the service returned a value for the OnExceptionSteps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

onExceptionSteps

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOnExceptionSteps() method.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

toBuilder

public CreateWorkflowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static CreateWorkflowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWorkflowRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo