com.amazonaws.services.transfer.model.CopyStepDetails Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transfer Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.transfer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Each step type has its own StepDetails structure.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CopyStepDetails implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the step, used as an identifier.
*
*/
private String name;
/**
*
* 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.
*
*
*
*/
private InputFileLocation destinationFileLocation;
/**
*
* 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.
*
*
*
*/
private String overwriteExisting;
/**
*
* 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}.
*
*
*
*/
private String sourceFileLocation;
/**
*
* The name of the step, used as an identifier.
*
*
* @param name
* The name of the step, used as an identifier.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the step, used as an identifier.
*
*
* @return The name of the step, used as an identifier.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the step, used as an identifier.
*
*
* @param name
* The name of the step, used as an identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyStepDetails withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setDestinationFileLocation(InputFileLocation destinationFileLocation) {
this.destinationFileLocation = 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.
*
*
*
*
* @return 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.
*
*
*/
public InputFileLocation getDestinationFileLocation() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyStepDetails withDestinationFileLocation(InputFileLocation destinationFileLocation) {
setDestinationFileLocation(destinationFileLocation);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 OverwriteExisting
*/
public void setOverwriteExisting(String overwriteExisting) {
this.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.
*
*
*
*
* @return 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 OverwriteExisting
*/
public String getOverwriteExisting() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteExisting
*/
public CopyStepDetails withOverwriteExisting(String overwriteExisting) {
setOverwriteExisting(overwriteExisting);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteExisting
*/
public CopyStepDetails withOverwriteExisting(OverwriteExisting overwriteExisting) {
this.overwriteExisting = overwriteExisting.toString();
return this;
}
/**
*
* 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}.
*
*
*
*
* @param 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}.
*
*
*/
public void setSourceFileLocation(String sourceFileLocation) {
this.sourceFileLocation = 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}.
*
*
*
*
* @return 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}.
*
*
*/
public String getSourceFileLocation() {
return this.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}.
*
*
*
*
* @param 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}.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyStepDetails withSourceFileLocation(String sourceFileLocation) {
setSourceFileLocation(sourceFileLocation);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDestinationFileLocation() != null)
sb.append("DestinationFileLocation: ").append(getDestinationFileLocation()).append(",");
if (getOverwriteExisting() != null)
sb.append("OverwriteExisting: ").append(getOverwriteExisting()).append(",");
if (getSourceFileLocation() != null)
sb.append("SourceFileLocation: ").append(getSourceFileLocation());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CopyStepDetails == false)
return false;
CopyStepDetails other = (CopyStepDetails) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDestinationFileLocation() == null ^ this.getDestinationFileLocation() == null)
return false;
if (other.getDestinationFileLocation() != null && other.getDestinationFileLocation().equals(this.getDestinationFileLocation()) == false)
return false;
if (other.getOverwriteExisting() == null ^ this.getOverwriteExisting() == null)
return false;
if (other.getOverwriteExisting() != null && other.getOverwriteExisting().equals(this.getOverwriteExisting()) == false)
return false;
if (other.getSourceFileLocation() == null ^ this.getSourceFileLocation() == null)
return false;
if (other.getSourceFileLocation() != null && other.getSourceFileLocation().equals(this.getSourceFileLocation()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDestinationFileLocation() == null) ? 0 : getDestinationFileLocation().hashCode());
hashCode = prime * hashCode + ((getOverwriteExisting() == null) ? 0 : getOverwriteExisting().hashCode());
hashCode = prime * hashCode + ((getSourceFileLocation() == null) ? 0 : getSourceFileLocation().hashCode());
return hashCode;
}
@Override
public CopyStepDetails clone() {
try {
return (CopyStepDetails) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transfer.model.transform.CopyStepDetailsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}