Class CopyStepDetails

java.lang.Object
software.amazon.awssdk.services.transfer.model.CopyStepDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CopyStepDetails.Builder,CopyStepDetails>
@Generated("software.amazon.awssdk:codegen") public final class CopyStepDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CopyStepDetails.Builder,CopyStepDetails>

Each step type has its own StepDetails structure.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the step, used as an identifier.

      Returns:
      The name of the step, used as an identifier.

    • destinationFileLocation

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

      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.

    • overwriteExisting

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

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

      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:

    • overwriteExistingAsString

      public final String overwriteExistingAsString()

      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.

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

      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:

    • sourceFileLocation

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

      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}.

    • toBuilder

      public CopyStepDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CopyStepDetails.Builder,CopyStepDetails>
      Returns:
      a builder for type T

    • builder

      public static CopyStepDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CopyStepDetails.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.