Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data CopyStepDetails = CopyStepDetails' {}
- newCopyStepDetails :: CopyStepDetails
- copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation)
- copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text)
- copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting)
- copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text)
Documentation
data CopyStepDetails Source #
Each step type has its own StepDetails
structure.
See: newCopyStepDetails
smart constructor.
CopyStepDetails' | |
|
Instances
newCopyStepDetails :: CopyStepDetails Source #
Create a value of CopyStepDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationFileLocation:CopyStepDetails'
, copyStepDetails_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.
$sel:name:CopyStepDetails'
, copyStepDetails_name
- The name of the step, used as an identifier.
$sel:overwriteExisting:CopyStepDetails'
, copyStepDetails_overwriteExisting
- A flag that indicates whether or not to overwrite an existing file of
the same name. The default is FALSE
.
$sel:sourceFileLocation:CopyStepDetails'
, copyStepDetails_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.
copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation) Source #
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.
copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text) Source #
The name of the step, used as an identifier.
copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting) Source #
A flag that indicates whether or not to overwrite an existing file of
the same name. The default is FALSE
.
copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (Maybe Text) Source #
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.