Package software.amazon.awssdk.services.emr.model

Interface StepConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StepConfig.Builder,StepConfig>, SdkBuilder<StepConfig.Builder,StepConfig>, SdkPojo

Enclosing class:

StepConfig

public static interface StepConfig.Builder
extends SdkPojo, CopyableBuilder<StepConfig.Builder,StepConfig>

Method Summary

Modifier and Type	Method	Description
StepConfig.Builder	actionOnFailure(String actionOnFailure)	The action to take when the step fails.
StepConfig.Builder	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.
StepConfig.Builder	hadoopJarStep(HadoopJarStepConfig hadoopJarStep)	The JAR file used for the step.
StepConfig.Builder	name(String name)	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 Detail

name

StepConfig.Builder name(String 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

StepConfig.Builder actionOnFailure(String 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 the WAITING 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 using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_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 the WAITING 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 using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER , the cluster does not terminate.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionOnFailure, ActionOnFailure

actionOnFailure

StepConfig.Builder actionOnFailure(ActionOnFailure 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 the WAITING 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 using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_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 the WAITING 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 using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER , the cluster does not terminate.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionOnFailure, ActionOnFailure

hadoopJarStep

StepConfig.Builder hadoopJarStep(HadoopJarStepConfig 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

default StepConfig.Builder hadoopJarStep(Consumer<HadoopJarStepConfig.Builder> hadoopJarStep)

The JAR file used for the step.

This is a convenience method that creates an instance of the HadoopJarStepConfig.Builder avoiding the need to create one manually via HadoopJarStepConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hadoopJarStep(HadoopJarStepConfig).

Parameters:

hadoopJarStep - a consumer that will call methods on HadoopJarStepConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

hadoopJarStep(HadoopJarStepConfig)