software.amazon.awssdk.services.transfer.model

Interface CopyStepDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CopyStepDetails.Builder,CopyStepDetails>, SdkBuilder<CopyStepDetails.Builder,CopyStepDetails>, SdkPojo

Enclosing class:

CopyStepDetails

public static interface CopyStepDetails.Builder
extends SdkPojo, CopyableBuilder<CopyStepDetails.Builder,CopyStepDetails>

Method Summary

Modifier and Type	Method and Description
default CopyStepDetails.Builder	destinationFileLocation(Consumer<InputFileLocation.Builder> destinationFileLocation) Specifies the location for the file being copied.
CopyStepDetails.Builder	destinationFileLocation(InputFileLocation destinationFileLocation) Specifies the location for the file being copied.
CopyStepDetails.Builder	name(String name) The name of the step, used as an identifier.
CopyStepDetails.Builder	overwriteExisting(OverwriteExisting overwriteExisting) A flag that indicates whether or not to overwrite an existing file of the same name.
CopyStepDetails.Builder	overwriteExisting(String overwriteExisting) A flag that indicates whether or not to overwrite an existing file of the same name.
CopyStepDetails.Builder	sourceFileLocation(String sourceFileLocation) Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CopyStepDetails.Builder name(String name)

The name of the step, used as an identifier.

Parameters:

name - The name of the step, used as an identifier.

Returns:

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

destinationFileLocation

CopyStepDetails.Builder destinationFileLocation(InputFileLocation destinationFileLocation)

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

Parameters:

destinationFileLocation - Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

Returns:

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

destinationFileLocation

default CopyStepDetails.Builder destinationFileLocation(Consumer<InputFileLocation.Builder> destinationFileLocation)

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

This is a convenience method that creates an instance of the InputFileLocation.Builder avoiding the need to create one manually via InputFileLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationFileLocation(InputFileLocation).

Parameters:

destinationFileLocation - a consumer that will call methods on InputFileLocation.Builder

Returns:

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

See Also:

destinationFileLocation(InputFileLocation)

overwriteExisting

CopyStepDetails.Builder overwriteExisting(String overwriteExisting)

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

Parameters:

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

Returns:

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

See Also:

OverwriteExisting, OverwriteExisting

overwriteExisting

CopyStepDetails.Builder overwriteExisting(OverwriteExisting overwriteExisting)

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

Parameters:

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

Returns:

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

See Also:

OverwriteExisting, OverwriteExisting

sourceFileLocation

CopyStepDetails.Builder sourceFileLocation(String sourceFileLocation)

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

Parameters:

sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

• Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• Enter ${original.file} to use the originally-uploaded file location as input for this step.

Returns:

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