software.amazon.awssdk.services.transfer.model

Class WorkflowStep

java.lang.Object

software.amazon.awssdk.services.transfer.model.WorkflowStep

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowStep
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>

The basic building block of a workflow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowStep.Builder

Method Summary

Modifier and Type	Method and Description
static WorkflowStep.Builder	builder()
CopyStepDetails	copyStepDetails() Details for a step that performs a file copy.
CustomStepDetails	customStepDetails() Details for a step that invokes a lambda function.
DeleteStepDetails	deleteStepDetails() Details for a step that deletes the file.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowStep.Builder>	serializableBuilderClass()
TagStepDetails	tagStepDetails() Details for a step that creates one or more tags.
WorkflowStep.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WorkflowStepType	type() Currently, the following step types are supported.
String	typeAsString() Currently, the following step types are supported.

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

type

public final WorkflowStepType type()

Currently, the following step types are supported.

• Copy: copy the file to another location

• Custom: custom step with a lambda target

• Delete: delete the file

• Tag: add a tag to the file

If the service returns an enum value that is not available in the current SDK version, type will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Currently, the following step types are supported.

• Copy: copy the file to another location

• Custom: custom step with a lambda target

• Delete: delete the file

• Tag: add a tag to the file

See Also:

WorkflowStepType

typeAsString

public final String typeAsString()

Currently, the following step types are supported.

• Copy: copy the file to another location

• Custom: custom step with a lambda target

• Delete: delete the file

• Tag: add a tag to the file

If the service returns an enum value that is not available in the current SDK version, type will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Currently, the following step types are supported.

• Copy: copy the file to another location

• Custom: custom step with a lambda target

• Delete: delete the file

• Tag: add a tag to the file

See Also:

WorkflowStepType

copyStepDetails

public final CopyStepDetails copyStepDetails()

Details for a step that performs a file copy.

Consists of the following values:

• A description

• An S3 location for the destination of the file copy.

• A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

Returns:

Details for a step that performs a file copy.

Consists of the following values:

• A description

• An S3 location for the destination of the file copy.

• A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

customStepDetails

public final CustomStepDetails customStepDetails()

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

Returns:

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

deleteStepDetails

public final DeleteStepDetails deleteStepDetails()

Details for a step that deletes the file.

Returns:

Details for a step that deletes the file.

tagStepDetails

public final TagStepDetails tagStepDetails()

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

Returns:

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

toBuilder

public WorkflowStep.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>

builder

public static WorkflowStep.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo