Interface Workflow.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Workflow.Builder,Workflow>,SdkBuilder<Workflow.Builder,Workflow>,SdkPojo
- Enclosing class:
- Workflow
public static interface Workflow.Builder extends SdkPojo, CopyableBuilder<Workflow.Builder,Workflow>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Workflow.BuilderblueprintDetails(Consumer<BlueprintDetails.Builder> blueprintDetails)This structure indicates the details of the blueprint that this particular workflow is created from.Workflow.BuilderblueprintDetails(BlueprintDetails blueprintDetails)This structure indicates the details of the blueprint that this particular workflow is created from.Workflow.BuildercreatedOn(Instant createdOn)The date and time when the workflow was created.Workflow.BuilderdefaultRunProperties(Map<String,String> defaultRunProperties)A collection of properties to be used as part of each execution of the workflow.Workflow.Builderdescription(String description)A description of the workflow.default Workflow.Buildergraph(Consumer<WorkflowGraph.Builder> graph)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.Workflow.Buildergraph(WorkflowGraph graph)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.Workflow.BuilderlastModifiedOn(Instant lastModifiedOn)The date and time when the workflow was last modified.default Workflow.BuilderlastRun(Consumer<WorkflowRun.Builder> lastRun)The information about the last execution of the workflow.Workflow.BuilderlastRun(WorkflowRun lastRun)The information about the last execution of the workflow.Workflow.BuildermaxConcurrentRuns(Integer maxConcurrentRuns)You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.Workflow.Buildername(String name)The name of the workflow.-
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
-
-
-
-
Method Detail
-
name
Workflow.Builder name(String name)
The name of the workflow.
- Parameters:
name- The name of the workflow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
Workflow.Builder description(String description)
A description of the workflow.
- Parameters:
description- A description of the workflow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultRunProperties
Workflow.Builder defaultRunProperties(Map<String,String> defaultRunProperties)
A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
- Parameters:
defaultRunProperties- A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdOn
Workflow.Builder createdOn(Instant createdOn)
The date and time when the workflow was created.
- Parameters:
createdOn- The date and time when the workflow was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedOn
Workflow.Builder lastModifiedOn(Instant lastModifiedOn)
The date and time when the workflow was last modified.
- Parameters:
lastModifiedOn- The date and time when the workflow was last modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastRun
Workflow.Builder lastRun(WorkflowRun lastRun)
The information about the last execution of the workflow.
- Parameters:
lastRun- The information about the last execution of the workflow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastRun
default Workflow.Builder lastRun(Consumer<WorkflowRun.Builder> lastRun)
The information about the last execution of the workflow.
This is a convenience method that creates an instance of theWorkflowRun.Builderavoiding the need to create one manually viaWorkflowRun.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolastRun(WorkflowRun).- Parameters:
lastRun- a consumer that will call methods onWorkflowRun.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
lastRun(WorkflowRun)
-
graph
Workflow.Builder graph(WorkflowGraph graph)
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
- Parameters:
graph- The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
graph
default Workflow.Builder graph(Consumer<WorkflowGraph.Builder> graph)
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
This is a convenience method that creates an instance of theWorkflowGraph.Builderavoiding the need to create one manually viaWorkflowGraph.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tograph(WorkflowGraph).- Parameters:
graph- a consumer that will call methods onWorkflowGraph.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
graph(WorkflowGraph)
-
maxConcurrentRuns
Workflow.Builder maxConcurrentRuns(Integer maxConcurrentRuns)
You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
- Parameters:
maxConcurrentRuns- You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprintDetails
Workflow.Builder blueprintDetails(BlueprintDetails blueprintDetails)
This structure indicates the details of the blueprint that this particular workflow is created from.
- Parameters:
blueprintDetails- This structure indicates the details of the blueprint that this particular workflow is created from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blueprintDetails
default Workflow.Builder blueprintDetails(Consumer<BlueprintDetails.Builder> blueprintDetails)
This structure indicates the details of the blueprint that this particular workflow is created from.
This is a convenience method that creates an instance of theBlueprintDetails.Builderavoiding the need to create one manually viaBlueprintDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toblueprintDetails(BlueprintDetails).- Parameters:
blueprintDetails- a consumer that will call methods onBlueprintDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
blueprintDetails(BlueprintDetails)
-
-