Class DecryptStepDetails
- java.lang.Object
-
- software.amazon.awssdk.services.transfer.model.DecryptStepDetails
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DecryptStepDetails.Builder,DecryptStepDetails>
@Generated("software.amazon.awssdk:codegen") public final class DecryptStepDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DecryptStepDetails.Builder,DecryptStepDetails>
Each step type has its own
StepDetails
structure.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DecryptStepDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DecryptStepDetails.Builder
builder()
InputFileLocation
destinationFileLocation()
Specifies the location for the file being decrypted.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
name()
The name of the step, used as an identifier.OverwriteExisting
overwriteExisting()
A flag that indicates whether to overwrite an existing file of the same name.String
overwriteExistingAsString()
A flag that indicates whether to overwrite an existing file of the same name.List<SdkField<?>>
sdkFields()
static Class<? extends DecryptStepDetails.Builder>
serializableBuilderClass()
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.DecryptStepDetails.Builder
toBuilder()
String
toString()
Returns a string representation of this object.EncryptionType
type()
The type of encryption used.String
typeAsString()
The type of encryption used.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the step, used as an identifier.
- Returns:
- The name of the step, used as an identifier.
-
type
public final EncryptionType type()
The type of encryption used. Currently, this value must be
PGP
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of encryption used. Currently, this value must be
PGP
. - See Also:
EncryptionType
-
typeAsString
public final String typeAsString()
The type of encryption used. Currently, this value must be
PGP
.If the service returns an enum value that is not available in the current SDK version,
type
will returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of encryption used. Currently, this value must be
PGP
. - See Also:
EncryptionType
-
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}
.
-
-
-
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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, 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 returnOverwriteExisting.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverwriteExistingAsString()
.- 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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
-
- See Also:
OverwriteExisting
-
-
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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, 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 returnOverwriteExisting.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverwriteExistingAsString()
.- 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
isTRUE
, the existing file is replaced with the file being processed. -
If
OverwriteExisting
isFALSE
, nothing happens, and the workflow processing stops.
-
- See Also:
OverwriteExisting
-
-
destinationFileLocation
public final InputFileLocation destinationFileLocation()
Specifies the location for the file being decrypted. 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 decrypt 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 decrypt 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 decrypted. 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 decrypt 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 decrypt 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.
-
-
-
toBuilder
public DecryptStepDetails.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DecryptStepDetails.Builder,DecryptStepDetails>
-
builder
public static DecryptStepDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends DecryptStepDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-