Class StepConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StepConfig.Builder,
StepConfig>
Specification for a cluster (job flow) step.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ActionOnFailure
The action to take when the step fails.final String
The action to take when the step fails.static StepConfig.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final HadoopJarStepConfig
The JAR file used for the step.final int
hashCode()
final String
name()
The name of the step.static Class
<? extends StepConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the step.
- Returns:
- The name of the step.
-
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.If the service returns an enum value that is not available in the current SDK version,
actionOnFailure
will returnActionOnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionOnFailureAsString()
.- 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 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. -
- See Also:
-
-
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 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.If the service returns an enum value that is not available in the current SDK version,
actionOnFailure
will returnActionOnFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionOnFailureAsString()
.- 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 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. -
- See Also:
-
-
hadoopJarStep
The JAR file used for the step.
- Returns:
- The JAR file used for the step.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StepConfig.Builder,
StepConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-