Step (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

This represents a step in a cluster.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Step()

Constructors
Constructor and Description
`Step()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Step`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActionOnFailure()` The action to take when the cluster step fails.
`HadoopStepConfig`	`getConfig()` The Hadoop job configuration of the cluster step.
`String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
`String`	`getId()` The identifier of the cluster step.
`String`	`getName()` The name of the cluster step.
`StepStatus`	`getStatus()` The current execution status details of the cluster 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 cluster step fails.
`void`	`setActionOnFailure(String actionOnFailure)` The action to take when the cluster step fails.
`void`	`setConfig(HadoopStepConfig config)` The Hadoop job configuration of the cluster step.
`void`	`setExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
`void`	`setId(String id)` The identifier of the cluster step.
`void`	`setName(String name)` The name of the cluster step.
`void`	`setStatus(StepStatus status)` The current execution status details of the cluster step.
`String`	`toString()` Returns a string representation of this object.
`Step`	`withActionOnFailure(ActionOnFailure actionOnFailure)` The action to take when the cluster step fails.
`Step`	`withActionOnFailure(String actionOnFailure)` The action to take when the cluster step fails.
`Step`	`withConfig(HadoopStepConfig config)` The Hadoop job configuration of the cluster step.
`Step`	`withExecutionRoleArn(String executionRoleArn)` The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.
`Step`	`withId(String id)` The identifier of the cluster step.
`Step`	`withName(String name)` The name of the cluster step.
`Step`	`withStatus(StepStatus status)` The current execution status details of the cluster step.

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

- Constructor Detail
  - Step
```
public Step()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the cluster step.
    
    Parameters:
    
    id - The identifier of the cluster step.
  - getId
```
public String getId()
```
    The identifier of the cluster step.
    
    Returns:
    
    The identifier of the cluster step.
  - withId
```
public Step withId(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.
  - setName
```
public void setName(String name)
```
    The name of the cluster step.
    
    Parameters:
    
    name - The name of the cluster step.
  - getName
```
public String getName()
```
    The name of the cluster step.
    
    Returns:
    
    The name of the cluster step.
  - withName
```
public Step withName(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.
  - setConfig
```
public void setConfig(HadoopStepConfig config)
```
    The Hadoop job configuration of the cluster step.
    
    Parameters:
    
    config - The Hadoop job configuration of the cluster step.
  - getConfig
```
public HadoopStepConfig getConfig()
```
    The Hadoop job configuration of the cluster step.
    
    Returns:
    
    The Hadoop job configuration of the cluster step.
  - withConfig
```
public Step withConfig(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.
  - setActionOnFailure
```
public void setActionOnFailure(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.
    
    See Also:
    
    ActionOnFailure
  - getActionOnFailure
```
public String getActionOnFailure()
```
    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:
    
    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
  - withActionOnFailure
```
public Step withActionOnFailure(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
  - setActionOnFailure
```
public void setActionOnFailure(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.
    
    See Also:
    
    ActionOnFailure
  - withActionOnFailure
```
public Step withActionOnFailure(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
  - setStatus
```
public void setStatus(StepStatus status)
```
    The current execution status details of the cluster step.
    
    Parameters:
    
    status - The current execution status details of the cluster step.
  - getStatus
```
public StepStatus getStatus()
```
    The current execution status details of the cluster step.
    
    Returns:
    
    The current execution status details of the cluster step.
  - withStatus
```
public Step withStatus(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.
  - setExecutionRoleArn
```
public void setExecutionRoleArn(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.
  - getExecutionRoleArn
```
public String getExecutionRoleArn()
```
    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.
  - withExecutionRoleArn
```
public Step withExecutionRoleArn(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.
  - 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 Step 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.

Did this page help you?

Class Step

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Step

Method Detail

setId

getId

withId

setName

getName

withName

setConfig

getConfig

withConfig

setActionOnFailure

getActionOnFailure

withActionOnFailure

setActionOnFailure

withActionOnFailure

setStatus

getStatus

withStatus

setExecutionRoleArn

getExecutionRoleArn

withExecutionRoleArn

toString

equals

hashCode

clone

marshall