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

Class StepConfig

java.lang.Object

software.amazon.awssdk.services.emr.model.StepConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StepConfig.Builder,StepConfig>

@Generated("software.amazon.awssdk:codegen")
public final class StepConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StepConfig.Builder,StepConfig>

Specification for a cluster (job flow) step.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StepConfig.Builder

Method Summary

Modifier and Type	Method	Description
ActionOnFailure	actionOnFailure()	The action to take when the step fails.
String	actionOnFailureAsString()	The action to take when the step fails.
static StepConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
HadoopJarStepConfig	hadoopJarStep()	The JAR file used for the step.
int	hashCode()
String	name()	The name of the step.
List<SdkField<?>>	sdkFields()
static Class<? extends StepConfig.Builder>	serializableBuilderClass()
StepConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the step.

Returns:

The name of the step.

actionOnFailure

public final 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.

If the service returns an enum value that is not available in the current SDK version, actionOnFailure will return ActionOnFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionOnFailureAsString().

Returns:

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.

See Also:

ActionOnFailure

actionOnFailureAsString

public final String actionOnFailureAsString()

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.

If the service returns an enum value that is not available in the current SDK version, actionOnFailure will return ActionOnFailure.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionOnFailureAsString().

Returns:

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.

See Also:

ActionOnFailure

hadoopJarStep

public final HadoopJarStepConfig hadoopJarStep()

The JAR file used for the step.

Returns:

The JAR file used for the step.

toBuilder

public StepConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StepConfig.Builder,StepConfig>

builder

public static StepConfig.Builder builder()

serializableBuilderClass

public static Class<? extends StepConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo