Class HadoopJarStepConfig
- All Implemented Interfaces:
Serializable
,Cloneable
A job flow 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:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for HadoopJarStepConfig object.Constructs a new HadoopJarStepConfig object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getArgs()
A list of command line arguments passed to the JAR file's main function when executed.getJar()
A path to a JAR file run during the step.The name of the main class in the specified Java file.A list of Java properties that are set when the step runs.int
hashCode()
void
setArgs
(Collection<String> args) A list of command line arguments passed to the JAR file's main function when executed.void
A path to a JAR file run during the step.void
setMainClass
(String mainClass) The name of the main class in the specified Java file.void
setProperties
(Collection<KeyValue> properties) A list of Java properties that are set when the step runs.toString()
Returns a string representation of this object; useful for testing and debugging.A list of command line arguments passed to the JAR file's main function when executed.withArgs
(Collection<String> args) A list of command line arguments passed to the JAR file's main function when executed.A path to a JAR file run during the step.withMainClass
(String mainClass) The name of the main class in the specified Java file.withProperties
(KeyValue... properties) A list of Java properties that are set when the step runs.withProperties
(Collection<KeyValue> properties) A list of Java properties that are set when the step runs.
-
Constructor Details
-
HadoopJarStepConfig
public HadoopJarStepConfig()Default constructor for HadoopJarStepConfig object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
HadoopJarStepConfig
Constructs a new HadoopJarStepConfig object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
jar
- A path to a JAR file run during the step.
-
-
Method Details
-
getProperties
A 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:
- A 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
A 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
- A 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
A 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.
NOTE: This method appends the values to the existing list (if any). Use
setProperties(java.util.Collection)
orwithProperties(java.util.Collection)
if you want to override the existing values.- Parameters:
properties
- A 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.
-
withProperties
A 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
- A 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.
-
setJar
A path to a JAR file run during the step.
- Parameters:
jar
- A path to a JAR file run during the step.
-
getJar
A path to a JAR file run during the step.
- Returns:
- A path to a JAR file run during the step.
-
withJar
A path to a JAR file run during the step.
- Parameters:
jar
- A path to a JAR file run during the step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMainClass
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
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
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
A list of command line arguments passed to the JAR file's main function when executed.
- Returns:
- A list of command line arguments passed to the JAR file's main function when executed.
-
setArgs
A list of command line arguments passed to the JAR file's main function when executed.
- Parameters:
args
- A list of command line arguments passed to the JAR file's main function when executed.
-
withArgs
A list of command line arguments passed to the JAR file's main function when executed.
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
- A list of command line arguments passed to the JAR file's main function when executed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withArgs
A list of command line arguments passed to the JAR file's main function when executed.
- Parameters:
args
- A list of command line arguments passed to the JAR file's main function when executed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-