WorkflowStep (AWS Java SDK :: Services :: Transfer 2.20.147 API)

java.lang.Object
- software.amazon.awssdk.services.transfer.model.WorkflowStep

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowStep
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>

The basic building block of a workflow.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WorkflowStep.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WorkflowStep.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WorkflowStep.Builder`	`builder()`
`CopyStepDetails`	`copyStepDetails()` Details for a step that performs a file copy.
`CustomStepDetails`	`customStepDetails()` Details for a step that invokes an Lambda function.
`DecryptStepDetails`	`decryptStepDetails()` Details for a step that decrypts an encrypted file.
`DeleteStepDetails`	`deleteStepDetails()` Details for a step that deletes the file.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkflowStep.Builder>`	`serializableBuilderClass()`
`TagStepDetails`	`tagStepDetails()` Details for a step that creates one or more tags.
`WorkflowStep.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WorkflowStepType`	`type()` Currently, the following step types are supported.
`String`	`typeAsString()` Currently, the following step types are supported.

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
  - type
```
public final WorkflowStepType type()
```
    Currently, the following step types are supported.
    - COPY - Copy the file to another location.
    - CUSTOM - Perform a custom step with an Lambda function target.
    - DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    - DELETE - Delete the file.
    - TAG - Add a tag to the file.
    If the service returns an enum value that is not available in the current SDK version, type will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    Currently, the following step types are supported.
    
    COPY - Copy the file to another location.
    
    CUSTOM - Perform a custom step with an Lambda function target.
    
    DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    
    DELETE - Delete the file.
    
    TAG - Add a tag to the file.
    See Also:
    
    WorkflowStepType
  - typeAsString
```
public final String typeAsString()
```
    Currently, the following step types are supported.
    - COPY - Copy the file to another location.
    - CUSTOM - Perform a custom step with an Lambda function target.
    - DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    - DELETE - Delete the file.
    - TAG - Add a tag to the file.
    If the service returns an enum value that is not available in the current SDK version, type will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    Currently, the following step types are supported.
    
    COPY - Copy the file to another location.
    
    CUSTOM - Perform a custom step with an Lambda function target.
    
    DECRYPT - Decrypt a file that was encrypted before it was uploaded.
    
    DELETE - Delete the file.
    
    TAG - Add a tag to the file.
    See Also:
    
    WorkflowStepType
  - copyStepDetails
```
public final CopyStepDetails copyStepDetails()
```
    Details for a step that performs a file copy.
    
    Consists of the following values:
    - A description
    - An Amazon S3 location for the destination of the file copy.
    - A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    Returns:
    Details for a step that performs a file copy.
    
    Consists of the following values:
    
    A description
    
    An Amazon S3 location for the destination of the file copy.
    
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
  - customStepDetails
```
public final CustomStepDetails customStepDetails()
```
    Details for a step that invokes an Lambda function.
    
    Consists of the Lambda function's name, target, and timeout (in seconds).
    
    Returns:
    
    Details for a step that invokes an Lambda function.
    
    Consists of the Lambda function's name, target, and timeout (in seconds).
  - deleteStepDetails
```
public final DeleteStepDetails deleteStepDetails()
```
    Details for a step that deletes the file.
    
    Returns:
    
    Details for a step that deletes the file.
  - tagStepDetails
```
public final TagStepDetails tagStepDetails()
```
    Details for a step that creates one or more tags.
    
    You specify one or more tags. Each tag contains a key-value pair.
    
    Returns:
    
    Details for a step that creates one or more tags.
    
    You specify one or more tags. Each tag contains a key-value pair.
  - decryptStepDetails
```
public final DecryptStepDetails decryptStepDetails()
```
    Details for a step that decrypts an encrypted file.
    
    Consists of the following values:
    - A descriptive name
    - An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
    - An S3 or Amazon EFS location for the destination of the file decryption.
    - A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    - The type of encryption that's used. Currently, only PGP encryption is supported.
    Returns:
    Details for a step that decrypts an encrypted file.
    
    Consists of the following values:
    
    A descriptive name
    
    An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
    
    An S3 or Amazon EFS location for the destination of the file decryption.
    
    A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
    
    The type of encryption that's used. Currently, only PGP encryption is supported.
  - toBuilder
```
public WorkflowStep.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkflowStep.Builder,WorkflowStep>
  - builder
```
public static WorkflowStep.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkflowStep.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class WorkflowStep

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

type

typeAsString

copyStepDetails

customStepDetails

deleteStepDetails

tagStepDetails

decryptStepDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields