Interface StepConfig.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StepConfig.Builder,
,StepConfig> SdkBuilder<StepConfig.Builder,
,StepConfig> SdkPojo
- Enclosing class:
StepConfig
-
Method Summary
Modifier and TypeMethodDescriptionactionOnFailure
(String actionOnFailure) The action to take when the step fails.actionOnFailure
(ActionOnFailure actionOnFailure) The action to take when the step fails.default StepConfig.Builder
hadoopJarStep
(Consumer<HadoopJarStepConfig.Builder> hadoopJarStep) The JAR file used for the step.hadoopJarStep
(HadoopJarStepConfig hadoopJarStep) The JAR file used for the step.The name of the step.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
-
name
The name of the step.
- Parameters:
name
- The name of the step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionOnFailure
The action to take when the step fails. Use one of the following values:
-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's
StepConcurrencyLevel
is greater than1
, do not useAddJobFlowSteps
to submit a step with this parameter set toCANCEL_AND_WAIT
orTERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that theActionOnFailure
setting is not valid.If you change a cluster's
StepConcurrencyLevel
to be greater than 1 while a step is running, theActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set toCANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set toTERMINATE_CLUSTER
, the cluster does not terminate.- Parameters:
actionOnFailure
- The action to take when the step fails. Use one of the following values:-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's
StepConcurrencyLevel
is greater than1
, do not useAddJobFlowSteps
to submit a step with this parameter set toCANCEL_AND_WAIT
orTERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that theActionOnFailure
setting is not valid.If you change a cluster's
StepConcurrencyLevel
to be greater than 1 while a step is running, theActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set toCANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set toTERMINATE_CLUSTER
, the cluster does not terminate.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
actionOnFailure
The action to take when the step fails. Use one of the following values:
-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's
StepConcurrencyLevel
is greater than1
, do not useAddJobFlowSteps
to submit a step with this parameter set toCANCEL_AND_WAIT
orTERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that theActionOnFailure
setting is not valid.If you change a cluster's
StepConcurrencyLevel
to be greater than 1 while a step is running, theActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set toCANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set toTERMINATE_CLUSTER
, the cluster does not terminate.- Parameters:
actionOnFailure
- The action to take when the step fails. Use one of the following values:-
TERMINATE_CLUSTER
- Shuts down the cluster. -
CANCEL_AND_WAIT
- Cancels any pending steps and returns the cluster to theWAITING
state. -
CONTINUE
- Continues to the next step in the queue. -
TERMINATE_JOB_FLOW
- Shuts down the cluster.TERMINATE_JOB_FLOW
is provided for backward compatibility. We recommend usingTERMINATE_CLUSTER
instead.
If a cluster's
StepConcurrencyLevel
is greater than1
, do not useAddJobFlowSteps
to submit a step with this parameter set toCANCEL_AND_WAIT
orTERMINATE_CLUSTER
. The step is not submitted and the action fails with a message that theActionOnFailure
setting is not valid.If you change a cluster's
StepConcurrencyLevel
to be greater than 1 while a step is running, theActionOnFailure
parameter may not behave as you expect. In this case, for a step that fails with this parameter set toCANCEL_AND_WAIT
, pending steps and the running step are not canceled; for a step that fails with this parameter set toTERMINATE_CLUSTER
, the cluster does not terminate.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
hadoopJarStep
The JAR file used for the step.
- Parameters:
hadoopJarStep
- The JAR file used for the step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hadoopJarStep
The JAR file used for the step.
This is a convenience method that creates an instance of theHadoopJarStepConfig.Builder
avoiding the need to create one manually viaHadoopJarStepConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohadoopJarStep(HadoopJarStepConfig)
.- Parameters:
hadoopJarStep
- a consumer that will call methods onHadoopJarStepConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-