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

Interface Step.Builder

All Superinterfaces:

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

Enclosing class:

Step

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

Method Summary

Modifier and Type	Method	Description
Step.Builder	actionOnFailure(String actionOnFailure)	The action to take when the cluster step fails.
Step.Builder	actionOnFailure(ActionOnFailure actionOnFailure)	The action to take when the cluster step fails.
default Step.Builder	config(Consumer<HadoopStepConfig.Builder> config)	The Hadoop job configuration of the cluster step.
Step.Builder	config(HadoopStepConfig config)	The Hadoop job configuration of the cluster step.
Step.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
Step.Builder	id(String id)	The identifier of the cluster step.
Step.Builder	name(String name)	The name of the cluster step.
default Step.Builder	status(Consumer<StepStatus.Builder> status)	The current execution status details of the cluster step.
Step.Builder	status(StepStatus status)	The current execution status details of the cluster 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, sdkFieldNameToField, sdkFields

Method Detail

id

Step.Builder id(String id)

The identifier of the cluster step.

Parameters:

id - The identifier of the cluster step.

Returns:

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

name

Step.Builder name(String name)

The name of the cluster step.

Parameters:

name - The name of the cluster step.

Returns:

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

config

Step.Builder config(HadoopStepConfig config)

The Hadoop job configuration of the cluster step.

Parameters:

config - The Hadoop job configuration of the cluster step.

Returns:

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

config

default Step.Builder config(Consumer<HadoopStepConfig.Builder> config)

The Hadoop job configuration of the cluster step.

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

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

Parameters:

config - a consumer that will call methods on HadoopStepConfig.Builder

Returns:

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

See Also:

config(HadoopStepConfig)

actionOnFailure

Step.Builder actionOnFailure(String actionOnFailure)

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. 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 cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. 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

Step.Builder actionOnFailure(ActionOnFailure actionOnFailure)

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. 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 cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. 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

status

Step.Builder status(StepStatus status)

The current execution status details of the cluster step.

Parameters:

status - The current execution status details of the cluster step.

Returns:

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

status

default Step.Builder status(Consumer<StepStatus.Builder> status)

The current execution status details of the cluster step.

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

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

Parameters:

status - a consumer that will call methods on StepStatus.Builder

Returns:

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

See Also:

status(StepStatus)

executionRoleArn

Step.Builder executionRoleArn(String executionRoleArn)

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.

For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.

For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.

Returns:

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