Class HadoopStepConfig
- java.lang.Object
-
- com.amazonaws.services.elasticmapreduce.model.HadoopStepConfig
-
- All Implemented Interfaces:
Serializable,Cloneable
public class HadoopStepConfig extends Object implements Serializable, Cloneable
A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description HadoopStepConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HadoopStepConfigaddPropertiesEntry(String key, String value)HadoopStepConfigclearPropertiesEntries()Removes all the entries added into Properties.HadoopStepConfigclone()booleanequals(Object obj)List<String>getArgs()The list of command line arguments to pass to the JAR file's main function for execution.StringgetJar()The path to the JAR file that runs during the step.StringgetMainClass()The name of the main class in the specified Java file.Map<String,String>getProperties()The list of Java properties that are set when the step runs.inthashCode()voidsetArgs(Collection<String> args)The list of command line arguments to pass to the JAR file's main function for execution.voidsetJar(String jar)The path to the JAR file that runs during the step.voidsetMainClass(String mainClass)The name of the main class in the specified Java file.voidsetProperties(Map<String,String> properties)The list of Java properties that are set when the step runs.StringtoString()Returns a string representation of this object; useful for testing and debugging.HadoopStepConfigwithArgs(String... args)The list of command line arguments to pass to the JAR file's main function for execution.HadoopStepConfigwithArgs(Collection<String> args)The list of command line arguments to pass to the JAR file's main function for execution.HadoopStepConfigwithJar(String jar)The path to the JAR file that runs during the step.HadoopStepConfigwithMainClass(String mainClass)The name of the main class in the specified Java file.HadoopStepConfigwithProperties(Map<String,String> properties)The list of Java properties that are set when the step runs.
-
-
-
Method Detail
-
setJar
public void setJar(String jar)
The path to the JAR file that runs during the step.
- Parameters:
jar- The path to the JAR file that runs during the step.
-
getJar
public String getJar()
The path to the JAR file that runs during the step.
- Returns:
- The path to the JAR file that runs during the step.
-
withJar
public HadoopStepConfig withJar(String jar)
The path to the JAR file that runs during the step.
- Parameters:
jar- The path to the JAR file that runs during the step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getProperties
public Map<String,String> getProperties()
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
- Returns:
- The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
-
setProperties
public void setProperties(Map<String,String> properties)
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
- Parameters:
properties- The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
-
withProperties
public HadoopStepConfig withProperties(Map<String,String> properties)
The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.
- Parameters:
properties- The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addPropertiesEntry
public HadoopStepConfig addPropertiesEntry(String key, String value)
-
clearPropertiesEntries
public HadoopStepConfig clearPropertiesEntries()
Removes all the entries added into Properties. <p> Returns a reference to this object so that method calls can be chained together.
-
setMainClass
public void setMainClass(String mainClass)
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
- Parameters:
mainClass- The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
-
getMainClass
public String getMainClass()
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
- Returns:
- The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
-
withMainClass
public HadoopStepConfig withMainClass(String mainClass)
The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.
- Parameters:
mainClass- The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getArgs
public List<String> getArgs()
The list of command line arguments to pass to the JAR file's main function for execution.
- Returns:
- The list of command line arguments to pass to the JAR file's main function for execution.
-
setArgs
public void setArgs(Collection<String> args)
The list of command line arguments to pass to the JAR file's main function for execution.
- Parameters:
args- The list of command line arguments to pass to the JAR file's main function for execution.
-
withArgs
public HadoopStepConfig withArgs(String... args)
The list of command line arguments to pass to the JAR file's main function for execution.
NOTE: This method appends the values to the existing list (if any). Use
setArgs(java.util.Collection)orwithArgs(java.util.Collection)if you want to override the existing values.- Parameters:
args- The list of command line arguments to pass to the JAR file's main function for execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withArgs
public HadoopStepConfig withArgs(Collection<String> args)
The list of command line arguments to pass to the JAR file's main function for execution.
- Parameters:
args- The list of command line arguments to pass to the JAR file's main function for execution.- 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; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public HadoopStepConfig clone()
-
-