org.apache.tez.mapreduce.examples

Class TezExampleBase

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.tez.mapreduce.examples.TezExampleBase

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Direct Known Subclasses:

BroadcastLoadGen, RPCLoadGen

public abstract class TezExampleBase
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

Constructor Summary

Constructors

Constructor and Description
TezExampleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	printUsage() Print usage instructions for this example
int	run(String[] args)
int	run(org.apache.tez.dag.api.TezConfiguration conf, String[] args, org.apache.tez.client.TezClient tezClient) Utility method to use the example from within code or a test.
int	runDag(org.apache.tez.dag.api.DAG dag, boolean printCounters, org.apache.commons.logging.Log logger)
protected abstract int	runJob(String[] args, org.apache.tez.dag.api.TezConfiguration tezConf, org.apache.tez.client.TezClient tezClient) Create and execute the actual DAG for the example
protected abstract int	validateArgs(String[] otherArgs) Validate the arguments

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Constructor Detail

TezExampleBase

public TezExampleBase()

Method Detail

run

public final int run(String[] args)
              throws Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

Exception

run

public int run(org.apache.tez.dag.api.TezConfiguration conf,
      String[] args,
      @Nullable
      org.apache.tez.client.TezClient tezClient)
        throws IOException,
               org.apache.tez.dag.api.TezException,
               InterruptedException

Utility method to use the example from within code or a test.

Parameters:

conf - the tez configuration instance which will be used to crate the DAG and possible the Tez Client.

args - arguments to the example

tezClient - an existing running TezClient instance if one exists. If no TezClient is specified (null), one will be created based on the provided configuration

Returns:

Throws:

IOException

org.apache.tez.dag.api.TezException

InterruptedException

runDag

public int runDag(org.apache.tez.dag.api.DAG dag,
         boolean printCounters,
         org.apache.commons.logging.Log logger)
           throws org.apache.tez.dag.api.TezException,
                  InterruptedException,
                  IOException

Parameters:

dag - the dag to execute

printCounters - whether to print counters or not

logger - the logger to use while printing diagnostics

Returns:

Throws:

org.apache.tez.dag.api.TezException

InterruptedException

IOException

printUsage

protected abstract void printUsage()

Print usage instructions for this example

validateArgs

protected abstract int validateArgs(String[] otherArgs)

Validate the arguments

Parameters:

otherArgs - arguments, if any

Returns:

runJob

protected abstract int runJob(String[] args,
         org.apache.tez.dag.api.TezConfiguration tezConf,
         org.apache.tez.client.TezClient tezClient)
                       throws IOException,
                              org.apache.tez.dag.api.TezException,
                              InterruptedException

Create and execute the actual DAG for the example

Parameters:

args - arguments for execution

tezConf - the tez configuration instance to be used while processing the DAG

tezClient - the tez client instance to use to run the DAG if any custom monitoring is required. Otherwise the utility method runDag(org.apache.tez.dag.api.DAG, boolean, org.apache.commons.logging.Log) should be used

Returns:

Throws:

IOException

org.apache.tez.dag.api.TezException

InterruptedException