| Package | Description | 
|---|---|
| org.apache.reef.client | 
 Client APIs for REEF. 
 | 
| org.apache.reef.driver | 
 Driver APIs for REEF in terms of Rx. 
 | 
| org.apache.reef.driver.context | |
| org.apache.reef.driver.evaluator | |
| org.apache.reef.examples.hello | 
 The Hello REEF example. 
 | 
| org.apache.reef.examples.helloCLR | 
 The Hello REEF example for the CLR. 
 | 
| org.apache.reef.examples.hellohttp | |
| org.apache.reef.examples.retained_eval | 
 The Retained Evaluators example. 
 | 
| org.apache.reef.examples.scheduler | 
 Task scheduler example based on reef-webserver 
 | 
| org.apache.reef.io.data.loading.api | |
| org.apache.reef.io.data.loading.impl | |
| org.apache.reef.runtime.common.client | 
 Implementation of the client-side REEF API. 
 | 
| org.apache.reef.runtime.common.driver.api | 
 Driver-Side Event Handlers to be implemented by a specific resource manager. 
 | 
| org.apache.reef.runtime.common.driver.context | 
 Implementations of Driver-Side representations of Contexts running on an Evaluator 
 | 
| org.apache.reef.runtime.common.evaluator.context | 
 Context implementation of the Evaluator resourcemanager. 
 | 
| org.apache.reef.runtime.common.evaluator.task | 
 Task-related implementation of the Evaluator resourcemanager. 
 | 
| org.apache.reef.runtime.common.files | 
 This package will contain the implementation of the REEF file system standard. 
 | 
| org.apache.reef.runtime.hdinsight.client | 
 The client to submit jobs to HDInsight. 
 | 
| org.apache.reef.tang | 
 Public interfaces and factories for Tang's core API. 
 | 
| org.apache.reef.tang.formats | 
 Tang format classes encode and decode information that Tang gathers at
 runtime. 
 | 
| org.apache.reef.tang.implementation | 
 Tang's implementation. 
 | 
| org.apache.reef.tang.implementation.java | 
 Private implementation classes that configure and inject code written
 in Java. 
 | 
| org.apache.reef.tang.util.walk.graphviz | 
 produce Graphviz representation of TANG configuration graph and injection plan. 
 | 
| org.apache.reef.tests | |
| org.apache.reef.tests.fail.driver | |
| org.apache.reef.tests.fail.task | |
| org.apache.reef.tests.messaging.driver | |
| org.apache.reef.tests.yarn.failure | 
| Modifier and Type | Method and Description | 
|---|---|
static DriverLauncher | 
DriverLauncher.getLauncher(Configuration runtimeConfiguration)
Instantiate a launcher for the given Configuration. 
 | 
LauncherStatus | 
DriverLauncher.run(Configuration driverConfig)
Run a job. 
 | 
LauncherStatus | 
DriverLauncher.run(Configuration driverConfig,
      long timeOut)
Run a job with a waiting timeout after which it will be killed, if it did not complete yet. 
 | 
void | 
REEF.submit(Configuration driverConf)
Submits the Driver set up in the given Configuration for execution. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ContextSubmittable.submitContext(Configuration contextConfiguration)
Submit a Context. 
 | 
void | 
ContextSubmittable.submitContextAndService(Configuration contextConfiguration,
                                              Configuration serviceConfiguration)
Submit a Context and a Service Configuration. 
 | 
void | 
ContextAndTaskSubmittable.submitContextAndServiceAndTask(Configuration contextConfiguration,
                                                            Configuration serviceConfiguration,
                                                            Configuration taskConfiguration)
Subkit a Context with Services and a Task. 
 | 
void | 
ContextAndTaskSubmittable.submitContextAndTask(Configuration contextConfiguration,
                                        Configuration taskConfiguration)
Submit a Context and a Task. 
 | 
void | 
TaskSubmittable.submitTask(Configuration taskConf)
Submits a Task (encoded in the Configuration) for execution. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ActiveContext.submitContext(Configuration contextConfiguration)  | 
void | 
ActiveContext.submitContextAndService(Configuration contextConfiguration,
                                              Configuration serviceConfiguration)  | 
void | 
ActiveContext.submitTask(Configuration taskConf)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
AllocatedEvaluator.submitContext(Configuration contextConfiguration)  | 
void | 
AllocatedEvaluator.submitContextAndService(Configuration contextConfiguration,
                                              Configuration serviceConfiguration)  | 
void | 
AllocatedEvaluator.submitContextAndServiceAndTask(Configuration contextConfiguration,
                                                            Configuration serviceConfiguration,
                                                            Configuration taskConfiguration)  | 
void | 
AllocatedEvaluator.submitContextAndTask(Configuration contextConfiguration,
                                        Configuration taskConfiguration)  | 
void | 
AllocatedEvaluator.submitTask(Configuration taskConfiguration)
Submits the given Task for execution. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Configuration | 
HelloREEF.getDriverConfiguration()  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
HelloREEF.runHelloReef(Configuration runtimeConf,
                        int timeOut)  | 
static void | 
HelloREEFNoClient.runHelloReefWithoutClient(Configuration runtimeConf)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
HelloCLR.runHelloCLR(Configuration runtimeConf,
                      int timeOut,
                      File clrFolder)  | 
| Modifier and Type | Method and Description | 
|---|---|
static Configuration | 
HelloREEFHttp.getDriverConfiguration()  | 
static Configuration | 
HelloREEFHttp.getHTTPConfiguration()  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
HelloREEFHttp.runHelloReef(Configuration runtimeConf,
                        int timeOut)
Run Hello Reef with merged configuration 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Configuration | 
JobClient.getClientConfiguration()  | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
Launch.run(Configuration config)
Main method that starts the Retained Evaluators job. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
SchedulerREEF.runTaskScheduler(Configuration runtimeConf,
                                String[] args)
Run the Task scheduler. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
DataLoadingRequestBuilder.build()  | 
Configuration | 
DataLoadingService.getContextConfiguration(AllocatedEvaluator allocatedEvaluator)  | 
Configuration | 
DataLoadingService.getServiceConfiguration(AllocatedEvaluator allocatedEvaluator)  | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
InputFormatLoadingService.getContextConfiguration(AllocatedEvaluator allocatedEvaluator)  | 
Configuration | 
InputFormatLoadingService.getServiceConfiguration(AllocatedEvaluator allocatedEvaluator)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
REEFImplementation.submit(Configuration driverConf)  | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
AbstractDriverRuntimeConfiguration.build()
Deprecated.  
  | 
| Modifier and Type | Method and Description | 
|---|---|
AbstractDriverRuntimeConfiguration | 
AbstractDriverRuntimeConfiguration.addClientConfiguration(Configuration conf)
Deprecated.  
  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
EvaluatorContext.submitContext(Configuration contextConfiguration)  | 
void | 
EvaluatorContext.submitContextAndService(Configuration contextConfiguration,
                                              Configuration serviceConfiguration)  | 
void | 
EvaluatorContext.submitTask(Configuration taskConf)  | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
ContextClientCodeException.getIdentifier(Configuration c)
Extracts a context id from the given configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
TaskClientCodeException.getTaskId(Configuration config)
Extracts a task id from the given configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
File | 
JobJarMaker.createJobSubmissionJAR(ClientRuntimeProtocol.JobSubmissionProto jobSubmissionProto,
                                            Configuration driverConfiguration)  | 
| Modifier and Type | Method and Description | 
|---|---|
static Configuration | 
UnsafeHDInsightRuntimeConfiguration.fromEnvironment()  | 
static Configuration | 
HDInsightRuntimeConfiguration.fromEnvironment()  | 
static Configuration | 
UnsafeHDInsightRuntimeConfiguration.fromTextFile(File file)
Returns an UNSAFE HDInsight runtime configuration from the credentials stored in the given file. 
 | 
static Configuration | 
HDInsightRuntimeConfiguration.fromTextFile(File file)
Returns a HDInsight runtime configuration from the credentials stored in the given file. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
ConfigurationBuilder.build()
Produce an immutable Configuration object that contains the current
 bindings and ClassHierarchy of this ConfigurationBuilder. 
 | 
static Configuration | 
Configurations.merge(Configuration... configurations)
Merge a set of Configurations. 
 | 
static Configuration | 
Configurations.merge(Iterable<Configuration> configurations)
Merge a set of Configurations. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfigurationBuilder.addConfiguration(Configuration c)
Add all configuration parameters from the given Configuration object. 
 | 
Injector | 
Injector.forkInjector(Configuration... configurations)
Create a copy of this Injector that inherits the instances that were already
 created by this Injector, but reflects additional Configuration objects. 
 | 
static Configuration | 
Configurations.merge(Configuration... configurations)
Merge a set of Configurations. 
 | 
JavaConfigurationBuilder | 
Tang.newConfigurationBuilder(Configuration... confs)
Merge a set of configurations into a new JavaConfiurationBuilder. 
 | 
JavaConfigurationBuilder | 
Tang.newConfigurationBuilder(URL[] jars,
                                              Configuration[] confs,
                                              Class<? extends ExternalConstructor<?>>[] parameterParsers)
Create a new JavaConfiguration builder that has additional jars,
 incorporates existing configuration data and / or can parse
 application-specific types. 
 | 
Injector | 
Tang.newInjector(Configuration... confs)
Returns an Injector for the given Configurations. 
 | 
Injector | 
Tang.newInjector(Configuration confs)
Returns an Injector for the given Configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Configuration | 
Configurations.merge(Iterable<Configuration> configurations)
Merge a set of Configurations. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Configuration | 
ConfigurationModule.build()  | 
Configuration | 
AvroConfigurationSerializer.fromAvro(AvroConfiguration avroConfiguration)
Converts a given AvroConfiguration to Configuration 
 | 
Configuration | 
AvroConfigurationSerializer.fromAvro(AvroConfiguration avroConfiguration,
                ClassHierarchy classHierarchy)
Converts a given AvroConfiguration to Configuration 
 | 
Configuration | 
ConfigurationSerializer.fromByteArray(byte[] theBytes)
Loads a Configuration from a byte[] created with toByteArray(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromByteArray(byte[] theBytes)  | 
Configuration | 
ConfigurationSerializer.fromByteArray(byte[] theBytes,
                          ClassHierarchy classHierarchy)
Loads a Configuration from a byte[] created with toByteArray(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromByteArray(byte[] theBytes,
                          ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromFile(File file)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromFile(File file)  | 
Configuration | 
ConfigurationSerializer.fromFile(File file,
                ClassHierarchy classHierarchy)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromFile(File file,
                ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromString(String theString)
Decodes a String generated via toString() 
 | 
Configuration | 
AvroConfigurationSerializer.fromString(String theString)  | 
Configuration | 
ConfigurationSerializer.fromString(String theString,
                    ClassHierarchy classHierarchy)
Decodes a String generated via toString() 
 | 
Configuration | 
AvroConfigurationSerializer.fromString(String theString,
                    ClassHierarchy classHierarchy)  | 
Configuration | 
ConfigurationSerializer.fromTextFile(File file)
Loads a Configuration from a File created with toFile(). 
 | 
Configuration | 
AvroConfigurationSerializer.fromTextFile(File file)  | 
Configuration | 
ConfigurationSerializer.fromTextFile(File file,
                        ClassHierarchy classHierarchy)
Loads a Configuration from a File created with toFile() with ClassHierarchy 
 | 
Configuration | 
AvroConfigurationSerializer.fromTextFile(File file,
                        ClassHierarchy classHierarchy)  | 
static Configuration | 
CommandLine.parseToConfiguration(String[] args,
                                        Class<? extends Name<?>>... argClasses)
Utility method to quickly parse a command line to a Configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
AvroConfiguration | 
AvroConfigurationSerializer.toAvro(Configuration configuration)  | 
byte[] | 
ConfigurationSerializer.toByteArray(Configuration conf)
Writes the Configuration to a byte[]. 
 | 
byte[] | 
AvroConfigurationSerializer.toByteArray(Configuration conf)  | 
static String | 
ConfigurationFile.toConfigurationString(Configuration c)
Deprecated. 
 
in Tang 0.2 Use AvroConfigurationSerializer instead. 
 | 
void | 
ConfigurationSerializer.toFile(Configuration conf,
            File file)
Stores the given Configuration in the given File. 
 | 
void | 
AvroConfigurationSerializer.toFile(Configuration conf,
            File file)  | 
String | 
ConfigurationSerializer.toString(Configuration configuration)
Writes the Configuration as a String. 
 | 
String | 
AvroConfigurationSerializer.toString(Configuration configuration)  | 
void | 
ConfigurationSerializer.toTextFile(Configuration conf,
                    File file)
Stores the given Configuration in the given Text File. 
 | 
void | 
AvroConfigurationSerializer.toTextFile(Configuration conf,
                    File file)  | 
static void | 
ConfigurationFile.writeConfigurationFile(Configuration conf,
                                            File confFile)
Deprecated. 
 
in Tang 0.2 Use AvroConfigurationSerializer instead. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ConfigurationImpl  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfigurationBuilderImpl.addConfiguration(Configuration conf)  | 
JavaConfigurationBuilder | 
TangImpl.newConfigurationBuilder(Configuration... confs)  | 
JavaConfigurationBuilder | 
TangImpl.newConfigurationBuilder(URL[] jars,
                                              Configuration[] confs,
                                              Class<? extends ExternalConstructor<?>>[] parameterParsers)  | 
Injector | 
TangImpl.newInjector(Configuration... confs)  | 
Injector | 
TangImpl.newInjector(Configuration confs)  | 
| Modifier and Type | Method and Description | 
|---|---|
Injector | 
InjectorImpl.forkInjector(Configuration... configurations)  | 
| Constructor and Description | 
|---|
InjectorImpl(Configuration c)  | 
JavaConfigurationBuilderImpl(Configuration[] confs)  | 
JavaConfigurationBuilderImpl(URL[] jars,
                                                        Configuration[] confs,
                                                        Class<? extends ExternalConstructor<?>>[] parsers)  | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
GraphvizConfigVisitor.getGraphvizString(Configuration config,
                                  boolean showImpl,
                                  boolean showLegend)
Produce a Graphviz DOT string for a given TANG configuration. 
 | 
| Constructor and Description | 
|---|
GraphvizConfigVisitor(Configuration config,
                                          boolean showImpl,
                                          boolean showLegend)
Create a new TANG configuration visitor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static TestDriverLauncher | 
TestDriverLauncher.getLauncher(Configuration runtimeConfiguration)
Instantiate a launcher for the given Configuration. 
 | 
LauncherStatus | 
TestDriverLauncher.run(Configuration driverConfig)
Run a job. 
 | 
LauncherStatus | 
TestDriverLauncher.run(Configuration driverConfig,
      long timeOut)
Run a job with a waiting timeout after which it will be killed, if it did not complete yet. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
FailClient.run(Class<?> failMsgClass,
      Configuration runtimeConfig,
      int timeOut)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
Client.run(Class<? extends Task> failTaskClass,
      Configuration runtimeConfig,
      int timeOut)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
DriverMessaging.run(Configuration runtimeConfiguration,
      int launcherTimeout)  | 
| Modifier and Type | Method and Description | 
|---|---|
static LauncherStatus | 
FailureREEF.runFailureReef(Configuration runtimeConfig,
                            int timeout)  | 
Copyright © 2015 The Apache Software Foundation. All rights reserved.