CopyStepDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.CopyStepDetails

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Each step type has its own StepDetails structure.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CopyStepDetails()

Constructors
Constructor and Description
`CopyStepDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CopyStepDetails`	`clone()`
`boolean`	`equals(Object obj)`
`InputFileLocation`	`getDestinationFileLocation()` Specifies the location for the file being copied.
`String`	`getName()` The name of the step, used as an identifier.
`String`	`getOverwriteExisting()` A flag that indicates whether to overwrite an existing file of the same name.
`String`	`getSourceFileLocation()` 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestinationFileLocation(InputFileLocation destinationFileLocation)` Specifies the location for the file being copied.
`void`	`setName(String name)` The name of the step, used as an identifier.
`void`	`setOverwriteExisting(String overwriteExisting)` A flag that indicates whether to overwrite an existing file of the same name.
`void`	`setSourceFileLocation(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.
`String`	`toString()` Returns a string representation of this object.
`CopyStepDetails`	`withDestinationFileLocation(InputFileLocation destinationFileLocation)` Specifies the location for the file being copied.
`CopyStepDetails`	`withName(String name)` The name of the step, used as an identifier.
`CopyStepDetails`	`withOverwriteExisting(OverwriteExisting overwriteExisting)` A flag that indicates whether to overwrite an existing file of the same name.
`CopyStepDetails`	`withOverwriteExisting(String overwriteExisting)` A flag that indicates whether to overwrite an existing file of the same name.
`CopyStepDetails`	`withSourceFileLocation(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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CopyStepDetails
```
public CopyStepDetails()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the step, used as an identifier.
    
    Parameters:
    
    name - The name of the step, used as an identifier.
  - getName
```
public String getName()
```
    The name of the step, used as an identifier.
    
    Returns:
    
    The name of the step, used as an identifier.
  - withName
```
public CopyStepDetails withName(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.
  - setDestinationFileLocation
```
public void setDestinationFileLocation(InputFileLocation destinationFileLocation)
```
    Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    - Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    - Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
      
      The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
    Parameters:
    destinationFileLocation - Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    
    Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    
    Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
    
    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
  - getDestinationFileLocation
```
public InputFileLocation getDestinationFileLocation()
```
    Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    - Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    - Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
      
      The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
    Returns:
    Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    
    Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    
    Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
    
    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
  - withDestinationFileLocation
```
public CopyStepDetails withDestinationFileLocation(InputFileLocation destinationFileLocation)
```
    Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    - Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    - Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
      
      The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
    Parameters:
    destinationFileLocation - Specifies the location for the file being copied. Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
    
    Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
    
    Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
    
    The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is uploaded in UTC.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverwriteExisting
```
public void setOverwriteExisting(String overwriteExisting)
```
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    - If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    - If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Parameters:
    overwriteExisting - A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    
    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    
    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    See Also:
    
    OverwriteExisting
  - getOverwriteExisting
```
public String getOverwriteExisting()
```
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    - If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    - If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Returns:
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    
    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    
    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    See Also:
    
    OverwriteExisting
  - withOverwriteExisting
```
public CopyStepDetails withOverwriteExisting(String overwriteExisting)
```
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    - If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    - If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Parameters:
    overwriteExisting - A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    
    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    
    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverwriteExisting
  - withOverwriteExisting
```
public CopyStepDetails withOverwriteExisting(OverwriteExisting overwriteExisting)
```
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    - If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    - If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Parameters:
    overwriteExisting - A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
    
    If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.
    
    If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverwriteExisting
  - setSourceFileLocation
```
public void setSourceFileLocation(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.
    - To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    - To use the originally uploaded file location as input for this step, enter ${original.file}.
    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.
    
    To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    
    To use the originally uploaded file location as input for this step, enter ${original.file}.
  - getSourceFileLocation
```
public String getSourceFileLocation()
```
    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.
    - To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    - To use the originally uploaded file location as input for this step, enter ${original.file}.
    Returns:
    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.
    
    To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    
    To use the originally uploaded file location as input for this step, enter ${original.file}.
  - withSourceFileLocation
```
public CopyStepDetails withSourceFileLocation(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.
    - To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    - To use the originally uploaded file location as input for this step, enter ${original.file}.
    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.
    
    To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    
    To use the originally uploaded file location as input for this step, enter ${original.file}.
    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 CopyStepDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class CopyStepDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CopyStepDetails

Method Detail

setName

getName

withName

setDestinationFileLocation

getDestinationFileLocation

withDestinationFileLocation

setOverwriteExisting

getOverwriteExisting

withOverwriteExisting

withOverwriteExisting

setSourceFileLocation

getSourceFileLocation

withSourceFileLocation

toString

equals

hashCode

clone

marshall