DriverConfiguration (REEF 0.14.0 API)

java.lang.Object
- org.apache.reef.tang.formats.ConfigurationModuleBuilder
- - org.apache.reef.client.DriverConfiguration

public final class DriverConfiguration
extends ConfigurationModuleBuilder

A ConfigurationModule for Drivers.

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigurationModule`	`CONF` ConfigurationModule to fill out to get a legal Driver Configuration.
`static OptionalParameter<String>`	`DRIVER_IDENTIFIER` Identifies the driver and therefore the JOB.
`static OptionalParameter<String>`	`DRIVER_JOB_SUBMISSION_DIRECTORY` Job submission directory to be used by driver.
`static OptionalParameter<Integer>`	`DRIVER_MEMORY` The amount of memory to be allocated for the Driver.
`static OptionalParameter<Integer>`	`EVALUATOR_DISPATCHER_THREADS` Number of threads allocated per evaluator to dispatch events from this Evaluator.
`static OptionalParameter<String>`	`GLOBAL_FILES` Files to be made available on the Driver and all Evaluators.
`static OptionalParameter<String>`	`GLOBAL_LIBRARIES` Libraries to be made available on the Driver and all Evaluators.
`static OptionalParameter<String>`	`LOCAL_FILES` Files to be made available on the Driver only.
`static OptionalParameter<String>`	`LOCAL_LIBRARIES` Libraries to be made available on the Driver only.
`static OptionalParameter<Integer>`	`MAX_APPLICATION_SUBMISSIONS` The number of submissions that the resource manager will attempt to submit the application.
`static OptionalImpl<EventHandler<Void>>`	`ON_CLIENT_CLOSED` Event handler for close messages sent by the client.
`static OptionalImpl<EventHandler<byte[]>>`	`ON_CLIENT_CLOSED_MESSAGE` Event handler for close messages sent by the client.
`static OptionalImpl<EventHandler<byte[]>>`	`ON_CLIENT_MESSAGE` Event handler for client messages.
`static OptionalImpl<EventHandler<ActiveContext>>`	`ON_CONTEXT_ACTIVE` Event handler for active context.
`static OptionalImpl<EventHandler<ClosedContext>>`	`ON_CONTEXT_CLOSED` Event handler for closed context.
`static OptionalImpl<EventHandler<FailedContext>>`	`ON_CONTEXT_FAILED` Event handler for closed context.
`static OptionalImpl<EventHandler<ContextMessage>>`	`ON_CONTEXT_MESSAGE` Event handler for context messages.
`static RequiredImpl<EventHandler<StartTime>>`	`ON_DRIVER_STARTED` The event handler invoked right after the driver boots up.
`static OptionalImpl<EventHandler<StopTime>>`	`ON_DRIVER_STOP` The event handler invoked right before the driver shuts down.
`static OptionalImpl<EventHandler<AllocatedEvaluator>>`	`ON_EVALUATOR_ALLOCATED` Event handler for allocated evaluators.
`static OptionalImpl<EventHandler<CompletedEvaluator>>`	`ON_EVALUATOR_COMPLETED` Event handler for completed evaluators.
`static OptionalImpl<EventHandler<FailedEvaluator>>`	`ON_EVALUATOR_FAILED` Event handler for failed evaluators.
`static OptionalImpl<EventHandler<CompletedTask>>`	`ON_TASK_COMPLETED` Event handler for completed tasks.
`static OptionalImpl<EventHandler<FailedTask>>`	`ON_TASK_FAILED` Event handler for failed tasks.
`static OptionalImpl<EventHandler<TaskMessage>>`	`ON_TASK_MESSAGE` Event handler for task messages.
`static OptionalImpl<EventHandler<RunningTask>>`	`ON_TASK_RUNNING` Event handler for running tasks.
`static OptionalImpl<EventHandler<SuspendedTask>>`	`ON_TASK_SUSPENDED` Event handler for suspended tasks.
`static OptionalImpl<ProgressProvider>`	`PROGRESS_PROVIDER` Progress provider.

Constructor Summary

Constructors
Constructor and Description

DriverConfiguration()

Constructors
Constructor and Description
`DriverConfiguration()`

Method Summary
- Methods inherited from class org.apache.reef.tang.formats.ConfigurationModuleBuilder
  bind, bindConstructor, bindConstructor, bindImplementation, bindImplementation, bindImplementation, bindList, bindList, bindList, bindNamedParameter, bindNamedParameter, bindNamedParameter, bindNamedParameter, bindSetEntry, bindSetEntry, bindSetEntry, bindSetEntry, build, merge
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DRIVER_IDENTIFIER
```
public static final OptionalParameter<String> DRIVER_IDENTIFIER
```
    Identifies the driver and therefore the JOB. Expect to see this e.g. on YARN's dashboard.
  - DRIVER_MEMORY
```
public static final OptionalParameter<Integer> DRIVER_MEMORY
```
    The amount of memory to be allocated for the Driver. This is the size of the AM container in YARN.
  - GLOBAL_FILES
```
public static final OptionalParameter<String> GLOBAL_FILES
```
    Files to be made available on the Driver and all Evaluators.
  - GLOBAL_LIBRARIES
```
public static final OptionalParameter<String> GLOBAL_LIBRARIES
```
    Libraries to be made available on the Driver and all Evaluators.
  - LOCAL_FILES
```
public static final OptionalParameter<String> LOCAL_FILES
```
    Files to be made available on the Driver only.
  - LOCAL_LIBRARIES
```
public static final OptionalParameter<String> LOCAL_LIBRARIES
```
    Libraries to be made available on the Driver only.
  - DRIVER_JOB_SUBMISSION_DIRECTORY
```
public static final OptionalParameter<String> DRIVER_JOB_SUBMISSION_DIRECTORY
```
    Job submission directory to be used by driver. This is the folder on the DFS used to stage the files for the Driver and subsequently for the Evaluators. It will be created if it doesn't exist yet. If this is set by the user, user must make sure its uniqueness across different jobs.
  - ON_DRIVER_STARTED
```
public static final RequiredImpl<EventHandler<StartTime>> ON_DRIVER_STARTED
```
    The event handler invoked right after the driver boots up.
  - ON_DRIVER_STOP
```
public static final OptionalImpl<EventHandler<StopTime>> ON_DRIVER_STOP
```
    The event handler invoked right before the driver shuts down. Defaults to ignore.
  - ON_EVALUATOR_ALLOCATED
```
public static final OptionalImpl<EventHandler<AllocatedEvaluator>> ON_EVALUATOR_ALLOCATED
```
    Event handler for allocated evaluators. Defaults to returning the evaluator if not bound.
  - ON_EVALUATOR_COMPLETED
```
public static final OptionalImpl<EventHandler<CompletedEvaluator>> ON_EVALUATOR_COMPLETED
```
    Event handler for completed evaluators. Defaults to logging if not bound.
  - ON_EVALUATOR_FAILED
```
public static final OptionalImpl<EventHandler<FailedEvaluator>> ON_EVALUATOR_FAILED
```
    Event handler for failed evaluators. Defaults to job failure if not bound.
  - ON_TASK_MESSAGE
```
public static final OptionalImpl<EventHandler<TaskMessage>> ON_TASK_MESSAGE
```
    Event handler for task messages. Defaults to logging if not bound.
  - ON_TASK_COMPLETED
```
public static final OptionalImpl<EventHandler<CompletedTask>> ON_TASK_COMPLETED
```
    Event handler for completed tasks. Defaults to closing the context the task ran on if not bound.
  - ON_TASK_FAILED
```
public static final OptionalImpl<EventHandler<FailedTask>> ON_TASK_FAILED
```
    Event handler for failed tasks. Defaults to job failure if not bound.
  - ON_TASK_RUNNING
```
public static final OptionalImpl<EventHandler<RunningTask>> ON_TASK_RUNNING
```
    Event handler for running tasks. Defaults to logging if not bound.
  - ON_TASK_SUSPENDED
```
public static final OptionalImpl<EventHandler<SuspendedTask>> ON_TASK_SUSPENDED
```
    Event handler for suspended tasks. Defaults to job failure if not bound. Rationale: many jobs don't support task suspension. Hence, this parameter should be optional. The only sane default is to crash the job, then.
  - ON_CLIENT_MESSAGE
```
public static final OptionalImpl<EventHandler<byte[]>> ON_CLIENT_MESSAGE
```
    Event handler for client messages. Defaults to logging if not bound.
  - ON_CLIENT_CLOSED
```
public static final OptionalImpl<EventHandler<Void>> ON_CLIENT_CLOSED
```
    Event handler for close messages sent by the client. Defaults to job failure if not bound.
  - ON_CLIENT_CLOSED_MESSAGE
```
public static final OptionalImpl<EventHandler<byte[]>> ON_CLIENT_CLOSED_MESSAGE
```
    Event handler for close messages sent by the client. Defaults to job failure if not bound.
  - ON_CONTEXT_ACTIVE
```
public static final OptionalImpl<EventHandler<ActiveContext>> ON_CONTEXT_ACTIVE
```
    Event handler for active context. Defaults to closing the context if not bound.
  - ON_CONTEXT_CLOSED
```
public static final OptionalImpl<EventHandler<ClosedContext>> ON_CONTEXT_CLOSED
```
    Event handler for closed context. Defaults to logging if not bound.
  - ON_CONTEXT_FAILED
```
public static final OptionalImpl<EventHandler<FailedContext>> ON_CONTEXT_FAILED
```
    Event handler for closed context. Defaults to job failure if not bound.
  - ON_CONTEXT_MESSAGE
```
public static final OptionalImpl<EventHandler<ContextMessage>> ON_CONTEXT_MESSAGE
```
    Event handler for context messages. Defaults to logging if not bound.
  - PROGRESS_PROVIDER
```
public static final OptionalImpl<ProgressProvider> PROGRESS_PROVIDER
```
    Progress provider. See ProgressProvider.
  - EVALUATOR_DISPATCHER_THREADS
```
public static final OptionalParameter<Integer> EVALUATOR_DISPATCHER_THREADS
```
    Number of threads allocated per evaluator to dispatch events from this Evaluator.
  - MAX_APPLICATION_SUBMISSIONS
```
public static final OptionalParameter<Integer> MAX_APPLICATION_SUBMISSIONS
```
    The number of submissions that the resource manager will attempt to submit the application. Defaults to 1.
  - CONF
```
public static final ConfigurationModule CONF
```
    ConfigurationModule to fill out to get a legal Driver Configuration.
- Constructor Detail
  - DriverConfiguration
```
public DriverConfiguration()
```

Class DriverConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.reef.tang.formats.ConfigurationModuleBuilder

Methods inherited from class java.lang.Object

Field Detail

DRIVER_IDENTIFIER

DRIVER_MEMORY

GLOBAL_FILES

GLOBAL_LIBRARIES

LOCAL_FILES

LOCAL_LIBRARIES

DRIVER_JOB_SUBMISSION_DIRECTORY

ON_DRIVER_STARTED

ON_DRIVER_STOP

ON_EVALUATOR_ALLOCATED

ON_EVALUATOR_COMPLETED

ON_EVALUATOR_FAILED

ON_TASK_MESSAGE

ON_TASK_COMPLETED

ON_TASK_FAILED

ON_TASK_RUNNING

ON_TASK_SUSPENDED

ON_CLIENT_MESSAGE

ON_CLIENT_CLOSED

ON_CLIENT_CLOSED_MESSAGE

ON_CONTEXT_ACTIVE

ON_CONTEXT_CLOSED

ON_CONTEXT_FAILED

ON_CONTEXT_MESSAGE

PROGRESS_PROVIDER

EVALUATOR_DISPATCHER_THREADS

MAX_APPLICATION_SUBMISSIONS

CONF

Constructor Detail

DriverConfiguration