Interface BlueprintRun.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<BlueprintRun.Builder,
,BlueprintRun> SdkBuilder<BlueprintRun.Builder,
,BlueprintRun> SdkPojo
- Enclosing class:
BlueprintRun
-
Method Summary
Modifier and TypeMethodDescriptionblueprintName
(String blueprintName) The name of the blueprint.completedOn
(Instant completedOn) The date and time that the blueprint run completed.errorMessage
(String errorMessage) Indicates any errors that are seen while running the blueprint.parameters
(String parameters) The blueprint parameters as a string.The role ARN.rollbackErrorMessage
(String rollbackErrorMessage) If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them.The run ID for this blueprint run.The date and time that the blueprint run started.The state of the blueprint run.state
(BlueprintRunState state) The state of the blueprint run.workflowName
(String workflowName) The name of a workflow that is created as a result of a successful blueprint run.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 Details
-
blueprintName
The name of the blueprint.
- Parameters:
blueprintName
- The name of the blueprint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runId
The run ID for this blueprint run.
- Parameters:
runId
- The run ID for this blueprint run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflowName
The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
- Parameters:
workflowName
- The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
- Parameters:
state
- The state of the blueprint run. Possible values are:-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
state
The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
- Parameters:
state
- The state of the blueprint run. Possible values are:-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
startedOn
The date and time that the blueprint run started.
- Parameters:
startedOn
- The date and time that the blueprint run started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completedOn
The date and time that the blueprint run completed.
- Parameters:
completedOn
- The date and time that the blueprint run completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorMessage
Indicates any errors that are seen while running the blueprint.
- Parameters:
errorMessage
- Indicates any errors that are seen while running the blueprint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rollbackErrorMessage
If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
- Parameters:
rollbackErrorMessage
- If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the
Blueprint$ParameterSpec
.- Parameters:
parameters
- The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in theBlueprint$ParameterSpec
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
- Parameters:
roleArn
- The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-