software.amazon.awssdk.services.emr.model

Class Step

java.lang.Object

software.amazon.awssdk.services.emr.model.Step

All Implemented Interfaces:

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

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

This represents a step in a cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Step.Builder

Method Summary

Modifier and Type	Method and Description
ActionOnFailure	actionOnFailure() The action to take when the cluster step fails.
String	actionOnFailureAsString() The action to take when the cluster step fails.
static Step.Builder	builder()
HadoopStepConfig	config() The Hadoop job configuration of the cluster step.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the cluster step.
String	name() The name of the cluster step.
List<SdkField<?>>	sdkFields()
static Class<? extends Step.Builder>	serializableBuilderClass()
StepStatus	status() The current execution status details of the cluster step.
Step.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

id

public final String id()

The identifier of the cluster step.

Returns:

The identifier of the cluster step.

name

public final String name()

The name of the cluster step.

Returns:

The name of the cluster step.

config

public final HadoopStepConfig config()

The Hadoop job configuration of the cluster step.

Returns:

The Hadoop job configuration of the cluster step.

actionOnFailure

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

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

See Also:

ActionOnFailure

actionOnFailureAsString

public final String actionOnFailureAsString()

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.

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

See Also:

ActionOnFailure

status

public final StepStatus status()

The current execution status details of the cluster step.

Returns:

The current execution status details of the cluster step.

executionRoleArn

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

Returns:

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.

toBuilder

public Step.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Step.Builder,Step>

builder

public static Step.Builder builder()

serializableBuilderClass

public static Class<? extends Step.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