StepConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.elasticmapreduce.model

Class StepConfig

java.lang.Object
- com.amazonaws.services.elasticmapreduce.model.StepConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StepConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Specification for a cluster (job flow) step.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`StepConfig ()` Default constructor for StepConfig object.
`StepConfig (String name, HadoopJarStepConfig hadoopJarStep)` Constructs a new StepConfig object.

Method Summary

All Methods
Modifier and Type	Method and Description
`StepConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getActionOnFailure ()` The action to take when the step fails.
`HadoopJarStepConfig`	`getHadoopJarStep ()` The JAR file used for the step.
`String`	`getName ()` The name of the step.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionOnFailure (ActionOnFailure actionOnFailure)` The action to take when the step fails.
`void`	`setActionOnFailure (String actionOnFailure)` The action to take when the step fails.
`void`	`setHadoopJarStep (HadoopJarStepConfig hadoopJarStep)` The JAR file used for the step.
`void`	`setName (String name)` The name of the step.
`String`	`toString ()` Returns a string representation of this object.
`StepConfig`	`withActionOnFailure (ActionOnFailure actionOnFailure)` The action to take when the step fails.
`StepConfig`	`withActionOnFailure (String actionOnFailure)` The action to take when the step fails.
`StepConfig`	`withHadoopJarStep (HadoopJarStepConfig hadoopJarStep)` The JAR file used for the step.
`StepConfig`	`withName (String name)` The name of the step.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StepConfig
```
public StepConfig()
```
    Default constructor for StepConfig object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - StepConfig
```
public StepConfig(String name,
 HadoopJarStepConfig hadoopJarStep)
```
    Constructs a new StepConfig object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    name - The name of the step.
    
    hadoopJarStep - The JAR file used for the step.
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the step.
    
    Parameters:
    
    name - The name of the step.
  - getName
```
public String getName()
```
    The name of the step.
    
    Returns:
    
    The name of the step.
  - withName
```
public StepConfig withName(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.
  - setActionOnFailure
```
public void setActionOnFailure(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.
    See Also:
    
    ActionOnFailure
  - getActionOnFailure
```
public String getActionOnFailure()
```
    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:
    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
  - withActionOnFailure
```
public StepConfig withActionOnFailure(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
  - setActionOnFailure
```
public void setActionOnFailure(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.
    See Also:
    
    ActionOnFailure
  - withActionOnFailure
```
public StepConfig withActionOnFailure(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
  - setHadoopJarStep
```
public void setHadoopJarStep(HadoopJarStepConfig hadoopJarStep)
```
    The JAR file used for the step.
    
    Parameters:
    
    hadoopJarStep - The JAR file used for the step.
  - getHadoopJarStep
```
public HadoopJarStepConfig getHadoopJarStep()
```
    The JAR file used for the step.
    
    Returns:
    
    The JAR file used for the step.
  - withHadoopJarStep
```
public StepConfig withHadoopJarStep(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StepConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class StepConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StepConfig

StepConfig

Method Detail

setName

getName

withName

setActionOnFailure

getActionOnFailure

withActionOnFailure

setActionOnFailure

withActionOnFailure

setHadoopJarStep

getHadoopJarStep

withHadoopJarStep

toString

equals

hashCode

clone

marshall