AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::EMR::Model::StepConfig Class Reference

#include <StepConfig.h>

Public Member Functions

 StepConfig ()
 
 StepConfig (Aws::Utils::Json::JsonView jsonValue)
 
StepConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
StepConfigWithName (const Aws::String &value)
 
StepConfigWithName (Aws::String &&value)
 
StepConfigWithName (const char *value)
 
const ActionOnFailureGetActionOnFailure () const
 
bool ActionOnFailureHasBeenSet () const
 
void SetActionOnFailure (const ActionOnFailure &value)
 
void SetActionOnFailure (ActionOnFailure &&value)
 
StepConfigWithActionOnFailure (const ActionOnFailure &value)
 
StepConfigWithActionOnFailure (ActionOnFailure &&value)
 
const HadoopJarStepConfigGetHadoopJarStep () const
 
bool HadoopJarStepHasBeenSet () const
 
void SetHadoopJarStep (const HadoopJarStepConfig &value)
 
void SetHadoopJarStep (HadoopJarStepConfig &&value)
 
StepConfigWithHadoopJarStep (const HadoopJarStepConfig &value)
 
StepConfigWithHadoopJarStep (HadoopJarStepConfig &&value)
 

Detailed Description

Specification for a cluster (job flow) step.

See Also:

AWS API Reference

Definition at line 33 of file StepConfig.h.

Constructor & Destructor Documentation

◆ StepConfig() [1/2]

Aws::EMR::Model::StepConfig::StepConfig ( )

◆ StepConfig() [2/2]

Aws::EMR::Model::StepConfig::StepConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionOnFailureHasBeenSet()

bool Aws::EMR::Model::StepConfig::ActionOnFailureHasBeenSet ( ) const
inline

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.

Definition at line 127 of file StepConfig.h.

◆ GetActionOnFailure()

const ActionOnFailure& Aws::EMR::Model::StepConfig::GetActionOnFailure ( ) const
inline

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.

Definition at line 104 of file StepConfig.h.

◆ GetHadoopJarStep()

const HadoopJarStepConfig& Aws::EMR::Model::StepConfig::GetHadoopJarStep ( ) const
inline

The JAR file used for the step.

Definition at line 225 of file StepConfig.h.

◆ GetName()

const Aws::String& Aws::EMR::Model::StepConfig::GetName ( ) const
inline

The name of the step.

Definition at line 45 of file StepConfig.h.

◆ HadoopJarStepHasBeenSet()

bool Aws::EMR::Model::StepConfig::HadoopJarStepHasBeenSet ( ) const
inline

The JAR file used for the step.

Definition at line 230 of file StepConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EMR::Model::StepConfig::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::EMR::Model::StepConfig::NameHasBeenSet ( ) const
inline

The name of the step.

Definition at line 50 of file StepConfig.h.

◆ operator=()

StepConfig& Aws::EMR::Model::StepConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetActionOnFailure() [1/2]

void Aws::EMR::Model::StepConfig::SetActionOnFailure ( ActionOnFailure &&  value)
inline

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.

Definition at line 173 of file StepConfig.h.

◆ SetActionOnFailure() [2/2]

void Aws::EMR::Model::StepConfig::SetActionOnFailure ( const ActionOnFailure value)
inline

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.

Definition at line 150 of file StepConfig.h.

◆ SetHadoopJarStep() [1/2]

void Aws::EMR::Model::StepConfig::SetHadoopJarStep ( const HadoopJarStepConfig value)
inline

The JAR file used for the step.

Definition at line 235 of file StepConfig.h.

◆ SetHadoopJarStep() [2/2]

void Aws::EMR::Model::StepConfig::SetHadoopJarStep ( HadoopJarStepConfig &&  value)
inline

The JAR file used for the step.

Definition at line 240 of file StepConfig.h.

◆ SetName() [1/3]

void Aws::EMR::Model::StepConfig::SetName ( Aws::String &&  value)
inline

The name of the step.

Definition at line 60 of file StepConfig.h.

◆ SetName() [2/3]

void Aws::EMR::Model::StepConfig::SetName ( const Aws::String value)
inline

The name of the step.

Definition at line 55 of file StepConfig.h.

◆ SetName() [3/3]

void Aws::EMR::Model::StepConfig::SetName ( const char *  value)
inline

The name of the step.

Definition at line 65 of file StepConfig.h.

◆ WithActionOnFailure() [1/2]

StepConfig& Aws::EMR::Model::StepConfig::WithActionOnFailure ( ActionOnFailure &&  value)
inline

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.

Definition at line 219 of file StepConfig.h.

◆ WithActionOnFailure() [2/2]

StepConfig& Aws::EMR::Model::StepConfig::WithActionOnFailure ( const ActionOnFailure value)
inline

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.

Definition at line 196 of file StepConfig.h.

◆ WithHadoopJarStep() [1/2]

StepConfig& Aws::EMR::Model::StepConfig::WithHadoopJarStep ( const HadoopJarStepConfig value)
inline

The JAR file used for the step.

Definition at line 245 of file StepConfig.h.

◆ WithHadoopJarStep() [2/2]

StepConfig& Aws::EMR::Model::StepConfig::WithHadoopJarStep ( HadoopJarStepConfig &&  value)
inline

The JAR file used for the step.

Definition at line 250 of file StepConfig.h.

◆ WithName() [1/3]

StepConfig& Aws::EMR::Model::StepConfig::WithName ( Aws::String &&  value)
inline

The name of the step.

Definition at line 75 of file StepConfig.h.

◆ WithName() [2/3]

StepConfig& Aws::EMR::Model::StepConfig::WithName ( const Aws::String value)
inline

The name of the step.

Definition at line 70 of file StepConfig.h.

◆ WithName() [3/3]

StepConfig& Aws::EMR::Model::StepConfig::WithName ( const char *  value)
inline

The name of the step.

Definition at line 80 of file StepConfig.h.


The documentation for this class was generated from the following file: