Interface CreateWorkflowRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>
,SdkBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>
,SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
- CreateWorkflowRequest
public static interface CreateWorkflowRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkflowRequest.Builder,CreateWorkflowRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateWorkflowRequest.Builder
description(String description)
A textual description for the workflow.CreateWorkflowRequest.Builder
onExceptionSteps(Collection<WorkflowStep> onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.CreateWorkflowRequest.Builder
onExceptionSteps(Consumer<WorkflowStep.Builder>... onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.CreateWorkflowRequest.Builder
onExceptionSteps(WorkflowStep... onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.CreateWorkflowRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateWorkflowRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateWorkflowRequest.Builder
steps(Collection<WorkflowStep> steps)
Specifies the details for the steps that are in the specified workflow.CreateWorkflowRequest.Builder
steps(Consumer<WorkflowStep.Builder>... steps)
Specifies the details for the steps that are in the specified workflow.CreateWorkflowRequest.Builder
steps(WorkflowStep... steps)
Specifies the details for the steps that are in the specified workflow.CreateWorkflowRequest.Builder
tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for workflows.CreateWorkflowRequest.Builder
tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for workflows.CreateWorkflowRequest.Builder
tags(Tag... tags)
Key-value pairs that can be used to group and search for workflows.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
-
-
-
Method Detail
-
description
CreateWorkflowRequest.Builder description(String description)
A textual description for the workflow.
- Parameters:
description
- A textual description for the workflow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
steps
CreateWorkflowRequest.Builder steps(Collection<WorkflowStep> steps)
Specifies the details for the steps that are in the specified workflow.
The
TYPE
specifies which of the following actions is being taken for this step.-
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.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
- Parameters:
steps
- Specifies the details for the steps that are in the specified workflow.The
TYPE
specifies which of the following actions is being taken for this step.-
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.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
steps
CreateWorkflowRequest.Builder steps(WorkflowStep... steps)
Specifies the details for the steps that are in the specified workflow.
The
TYPE
specifies which of the following actions is being taken for this step.-
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.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
- Parameters:
steps
- Specifies the details for the steps that are in the specified workflow.The
TYPE
specifies which of the following actions is being taken for this step.-
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.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
steps
CreateWorkflowRequest.Builder steps(Consumer<WorkflowStep.Builder>... steps)
Specifies the details for the steps that are in the specified workflow.
The
TYPE
specifies which of the following actions is being taken for this step.-
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.
Currently, copying and tagging are supported only on S3.
For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.
This is a convenience method that creates an instance of theWorkflowStep.Builder
avoiding the need to create one manually viaWorkflowStep.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#steps(List
.) - Parameters:
steps
- a consumer that will call methods onWorkflowStep.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#steps(java.util.Collection
)
-
-
onExceptionSteps
CreateWorkflowRequest.Builder onExceptionSteps(Collection<WorkflowStep> onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.- Parameters:
onExceptionSteps
- Specifies the steps (actions) to take if errors are encountered during execution of the workflow.For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
onExceptionSteps
CreateWorkflowRequest.Builder onExceptionSteps(WorkflowStep... onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.- Parameters:
onExceptionSteps
- Specifies the steps (actions) to take if errors are encountered during execution of the workflow.For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
onExceptionSteps
CreateWorkflowRequest.Builder onExceptionSteps(Consumer<WorkflowStep.Builder>... onExceptionSteps)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
For custom steps, the Lambda function needs to send
FAILURE
to the call back API to kick off the exception steps. Additionally, if the Lambda does not sendSUCCESS
before it times out, the exception steps are executed.WorkflowStep.Builder
avoiding the need to create one manually viaWorkflowStep.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#onExceptionSteps(List
.) - Parameters:
onExceptionSteps
- a consumer that will call methods onWorkflowStep.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#onExceptionSteps(java.util.Collection
)
-
tags
CreateWorkflowRequest.Builder tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- Parameters:
tags
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateWorkflowRequest.Builder tags(Tag... tags)
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- Parameters:
tags
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateWorkflowRequest.Builder tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
overrideConfiguration
CreateWorkflowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateWorkflowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-