WorkflowStep (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.WorkflowStep

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkflowStep
extends Object
implements Serializable, Cloneable, StructuredPojo

The basic building block of a workflow.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkflowStep()

Constructors
Constructor and Description
`WorkflowStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkflowStep`	`clone()`
`boolean`	`equals(Object obj)`
`CopyStepDetails`	`getCopyStepDetails()` Details for a step that performs a file copy.
`CustomStepDetails`	`getCustomStepDetails()` Details for a step that invokes a lambda function.
`DeleteStepDetails`	`getDeleteStepDetails()` Details for a step that deletes the file.
`TagStepDetails`	`getTagStepDetails()` Details for a step that creates one or more tags.
`String`	`getType()` Currently, the following step types are supported.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCopyStepDetails(CopyStepDetails copyStepDetails)` Details for a step that performs a file copy.
`void`	`setCustomStepDetails(CustomStepDetails customStepDetails)` Details for a step that invokes a lambda function.
`void`	`setDeleteStepDetails(DeleteStepDetails deleteStepDetails)` Details for a step that deletes the file.
`void`	`setTagStepDetails(TagStepDetails tagStepDetails)` Details for a step that creates one or more tags.
`void`	`setType(String type)` Currently, the following step types are supported.
`String`	`toString()` Returns a string representation of this object.
`WorkflowStep`	`withCopyStepDetails(CopyStepDetails copyStepDetails)` Details for a step that performs a file copy.
`WorkflowStep`	`withCustomStepDetails(CustomStepDetails customStepDetails)` Details for a step that invokes a lambda function.
`WorkflowStep`	`withDeleteStepDetails(DeleteStepDetails deleteStepDetails)` Details for a step that deletes the file.
`WorkflowStep`	`withTagStepDetails(TagStepDetails tagStepDetails)` Details for a step that creates one or more tags.
`WorkflowStep`	`withType(String type)` Currently, the following step types are supported.
`WorkflowStep`	`withType(WorkflowStepType type)` Currently, the following step types are supported.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkflowStep
```
public WorkflowStep()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    Currently, the following step types are supported.
    - Copy: copy the file to another location
    - Custom: custom step with a lambda target
    - Delete: delete the file
    - Tag: add a tag to the file
    Parameters:
    type - Currently, the following step types are supported.
    
    Copy: copy the file to another location
    
    Custom: custom step with a lambda target
    
    Delete: delete the file
    
    Tag: add a tag to the file
    See Also:
    
    WorkflowStepType
  - getType
```
public String getType()
```
    Currently, the following step types are supported.
    - Copy: copy the file to another location
    - Custom: custom step with a lambda target
    - Delete: delete the file
    - Tag: add a tag to the file
    Returns:
    Currently, the following step types are supported.
    
    Copy: copy the file to another location
    
    Custom: custom step with a lambda target
    
    Delete: delete the file
    
    Tag: add a tag to the file
    See Also:
    
    WorkflowStepType
  - withType
```
public WorkflowStep withType(String type)
```
    Currently, the following step types are supported.
    - Copy: copy the file to another location
    - Custom: custom step with a lambda target
    - Delete: delete the file
    - Tag: add a tag to the file
    Parameters:
    type - Currently, the following step types are supported.
    
    Copy: copy the file to another location
    
    Custom: custom step with a lambda target
    
    Delete: delete the file
    
    Tag: add a tag to the file
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepType
  - withType
```
public WorkflowStep withType(WorkflowStepType type)
```
    Currently, the following step types are supported.
    - Copy: copy the file to another location
    - Custom: custom step with a lambda target
    - Delete: delete the file
    - Tag: add a tag to the file
    Parameters:
    type - Currently, the following step types are supported.
    
    Copy: copy the file to another location
    
    Custom: custom step with a lambda target
    
    Delete: delete the file
    
    Tag: add a tag to the file
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowStepType
  - setCopyStepDetails
```
public void setCopyStepDetails(CopyStepDetails copyStepDetails)
```
    Details for a step that performs a file copy.
    
    Consists of the following values:
    - A description
    - An S3 location for the destination of the file copy.
    - A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
    Parameters:
    copyStepDetails - Details for a step that performs a file copy.
    
    Consists of the following values:
    
    A description
    
    An S3 location for the destination of the file copy.
    
    A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
  - getCopyStepDetails
```
public CopyStepDetails getCopyStepDetails()
```
    Details for a step that performs a file copy.
    
    Consists of the following values:
    - A description
    - An S3 location for the destination of the file copy.
    - A flag that indicates whether or not 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 S3 location for the destination of the file copy.
    
    A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
  - withCopyStepDetails
```
public WorkflowStep withCopyStepDetails(CopyStepDetails copyStepDetails)
```
    Details for a step that performs a file copy.
    
    Consists of the following values:
    - A description
    - An S3 location for the destination of the file copy.
    - A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
    Parameters:
    copyStepDetails - Details for a step that performs a file copy.
    
    Consists of the following values:
    
    A description
    
    An S3 location for the destination of the file copy.
    
    A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomStepDetails
```
public void setCustomStepDetails(CustomStepDetails customStepDetails)
```
    Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
    
    Parameters:
    
    customStepDetails - Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
  - getCustomStepDetails
```
public CustomStepDetails getCustomStepDetails()
```
    Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
    
    Returns:
    
    Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
  - withCustomStepDetails
```
public WorkflowStep withCustomStepDetails(CustomStepDetails customStepDetails)
```
    Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
    
    Parameters:
    
    customStepDetails - Details for a step that invokes a lambda function.
    
    Consists of the lambda function name, target, and timeout (in seconds).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteStepDetails
```
public void setDeleteStepDetails(DeleteStepDetails deleteStepDetails)
```
    Details for a step that deletes the file.
    
    Parameters:
    
    deleteStepDetails - Details for a step that deletes the file.
  - getDeleteStepDetails
```
public DeleteStepDetails getDeleteStepDetails()
```
    Details for a step that deletes the file.
    
    Returns:
    
    Details for a step that deletes the file.
  - withDeleteStepDetails
```
public WorkflowStep withDeleteStepDetails(DeleteStepDetails deleteStepDetails)
```
    Details for a step that deletes the file.
    
    Parameters:
    
    deleteStepDetails - Details for a step that deletes the file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTagStepDetails
```
public void setTagStepDetails(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.
    
    Parameters:
    
    tagStepDetails - Details for a step that creates one or more tags.
    
    You specify one or more tags: each tag contains a key/value pair.
  - getTagStepDetails
```
public TagStepDetails getTagStepDetails()
```
    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.
  - withTagStepDetails
```
public WorkflowStep withTagStepDetails(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkflowStep clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkflowStep

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowStep

Method Detail

setType

getType

withType

withType

setCopyStepDetails

getCopyStepDetails

withCopyStepDetails

setCustomStepDetails

getCustomStepDetails

withCustomStepDetails

setDeleteStepDetails

getDeleteStepDetails

withDeleteStepDetails

setTagStepDetails

getTagStepDetails

withTagStepDetails

toString

equals

hashCode

clone

marshall