Uses of Class
org.apache.reef.tang.formats.OptionalParameter

Packages that use OptionalParameter

Package	Description
org.apache.reef.client	Client APIs for REEF.
org.apache.reef.driver.context	Driver Contexts and their configurations.
org.apache.reef.driver.task	Tasks and their configurations.
org.apache.reef.io.checkpoint.fs	FileSystem based checkpoints.
org.apache.reef.io.network.naming	TODO: Document.
org.apache.reef.poison	Fault injection for REEF.
org.apache.reef.runtime.common.evaluator	Evaluator-side implementation of the REEF API.
org.apache.reef.runtime.hdinsight.client	The client to submit jobs to HDInsight.
org.apache.reef.runtime.local.client	Client-side event handlers for the local resourcemanager.
org.apache.reef.runtime.local.driver	The resource manager for the local resourcemanager.
org.apache.reef.runtime.mesos.client	Client-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.mesos.driver	Driver-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.standalone.client	Client-side event handlers for the standalone resourcemanager.
org.apache.reef.runtime.yarn.client	Client-side event handlers for YARN resourcemanager.
org.apache.reef.runtime.yarn.driver	The Driver-Side implementation of the YARN adapter for REEF.
org.apache.reef.tang.examples.timer	A more complicated version of the Timer example, including delegating interfaces to default implementations.
org.apache.reef.vortex.driver	Vortex Code that runs as part of REEF Driver.
org.apache.reef.webserver	HTTP Server component to implement a REST API for the Driver or Evaluators.

Uses of OptionalParameter in org.apache.reef.client

Fields in org.apache.reef.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	DriverConfiguration.DRIVER_IDENTIFIER Identifies the driver and therefore the JOB.
static OptionalParameter<String>	DriverConfiguration.DRIVER_JOB_SUBMISSION_DIRECTORY Job submission directory to be used by driver.
static OptionalParameter<Integer>	DriverConfiguration.DRIVER_MEMORY The amount of memory to be allocated for the Driver.
static OptionalParameter<Integer>	DriverRestartConfiguration.DRIVER_RESTART_EVALUATOR_RECOVERY_SECONDS The amount of time in seconds the driver waits for evaluators to report back on restart.
static OptionalParameter<Integer>	DriverConfiguration.EVALUATOR_DISPATCHER_THREADS Number of threads allocated per evaluator to dispatch events from this Evaluator.
static OptionalParameter<Boolean>	DriverRestartConfiguration.FAIL_DRIVER_ON_EVALUATOR_LOG_ERROR Parameter to determine whether the driver should fail or continue if there are evaluator preservation log failures.
static OptionalParameter<String>	DriverServiceConfiguration.GLOBAL_FILES Files to be made available on the Driver and all Evaluators.
static OptionalParameter<String>	DriverConfiguration.GLOBAL_FILES Files to be made available on the Driver and all Evaluators.
static OptionalParameter<String>	DriverServiceConfiguration.GLOBAL_LIBRARIES Libraries to be made available on the Driver and all Evaluators.
static OptionalParameter<String>	DriverConfiguration.GLOBAL_LIBRARIES Libraries to be made available on the Driver and all Evaluators.
static OptionalParameter<String>	DriverServiceConfiguration.LOCAL_FILES Files to be made available on the Driver only.
static OptionalParameter<String>	DriverConfiguration.LOCAL_FILES Files to be made available on the Driver only.
static OptionalParameter<String>	DriverServiceConfiguration.LOCAL_LIBRARIES Libraries to be made available on the Driver only.
static OptionalParameter<String>	DriverConfiguration.LOCAL_LIBRARIES Libraries to be made available on the Driver only.
static OptionalParameter<Integer>	DriverConfiguration.MAX_APPLICATION_SUBMISSIONS The number of submissions that the resource manager will attempt to submit the application.

Uses of OptionalParameter in org.apache.reef.driver.context

Fields in org.apache.reef.driver.context declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Object>	ServiceConfiguration.SERVICES A set of services to instantiate.

Uses of OptionalParameter in org.apache.reef.driver.task

Fields in org.apache.reef.driver.task declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	TaskConfiguration.MEMENTO The Base64 encoded memento to be passed to Task.call().

Uses of OptionalParameter in org.apache.reef.io.checkpoint.fs

Fields in org.apache.reef.io.checkpoint.fs declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	FSCheckPointServiceConfiguration.PREFIX Prefix for checkpoint files (optional).
static OptionalParameter<Short>	FSCheckPointServiceConfiguration.REPLICATION_FACTOR Replication factor to be used for the checkpoints.

Uses of OptionalParameter in org.apache.reef.io.network.naming

Fields in org.apache.reef.io.network.naming declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Long>	NameResolverConfiguration.CACHE_TIMEOUT The timeout of caching lookup.
static OptionalParameter<Long>	LocalNameResolverConfiguration.CACHE_TIMEOUT The timeout of caching lookup.
static OptionalParameter<IdentifierFactory>	NameResolverConfiguration.IDENTIFIER_FACTORY Identifier factory for NameClient.
static OptionalParameter<String>	NameServerConfiguration.NAME_SERVER_HOSTNAME DNS hostname running the name service.
static OptionalParameter<IdentifierFactory>	NameServerConfiguration.NAME_SERVER_IDENTIFIER_FACTORY Identifier factory for the name service.
static OptionalParameter<Integer>	NameServerConfiguration.NAME_SERVICE_PORT The port used by name server.
static OptionalParameter<Integer>	NameResolverConfiguration.RETRY_COUNT The number of retrying connection.
static OptionalParameter<Integer>	LocalNameResolverConfiguration.RETRY_COUNT The number of retrying connection.
static OptionalParameter<Integer>	NameResolverConfiguration.RETRY_TIMEOUT The timeout of retrying connection.
static OptionalParameter<Integer>	LocalNameResolverConfiguration.RETRY_TIMEOUT The timeout of retrying connection.

Uses of OptionalParameter in org.apache.reef.poison

Fields in org.apache.reef.poison declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Double>	PoisonedConfiguration.CRASH_PROBABILITY The probability with which a crash is to occur.
static OptionalParameter<Integer>	PoisonedConfiguration.CRASH_TIMEOUT The time window in seconds beginning at ContextStart during which the crash is to occur.

Uses of OptionalParameter in org.apache.reef.runtime.common.evaluator

Fields in org.apache.reef.runtime.common.evaluator declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	EvaluatorConfiguration.APPLICATION_IDENTIFIER
static OptionalParameter<Integer>	EvaluatorConfiguration.HEARTBEAT_PERIOD
static OptionalParameter<String>	EvaluatorConfiguration.ROOT_SERVICE_CONFIGURATION
static OptionalParameter<String>	EvaluatorConfiguration.TASK_CONFIGURATION

Uses of OptionalParameter in org.apache.reef.runtime.hdinsight.client

Fields in org.apache.reef.runtime.hdinsight.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	HDInsightDriverConfiguration.CLIENT_REMOTE_IDENTIFIER The client remote identifier.
static OptionalParameter<Long>	HDInsightDriverConfiguration.EVALUATOR_TIMEOUT
static OptionalParameter<Double>	HDInsightDriverConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<Integer>	HDInsightDriverConfiguration.YARN_HEARTBEAT_INTERVAL

Uses of OptionalParameter in org.apache.reef.runtime.local.client

Fields in org.apache.reef.runtime.local.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Double>	LocalRuntimeConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<Double>	ExtensibleLocalRuntimeConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<Integer>	LocalRuntimeConfiguration.MAX_NUMBER_OF_EVALUATORS The number of threads or processes available to the resourcemanager.
static OptionalParameter<Integer>	ExtensibleLocalRuntimeConfiguration.MAX_NUMBER_OF_EVALUATORS The number of threads or processes available to the resourcemanager.
static OptionalParameter<String>	LocalRuntimeConfiguration.RACK_NAMES The rack names that will be available in the local runtime.
static OptionalParameter<String>	ExtensibleLocalRuntimeConfiguration.RACK_NAMES The rack names that will be available in the local runtime.
static OptionalParameter<String>	LocalRuntimeConfiguration.RUNTIME_ROOT_FOLDER The folder in which the sub-folders, one per Node, will be created.
static OptionalParameter<String>	ExtensibleLocalRuntimeConfiguration.RUNTIME_ROOT_FOLDER The folder in which the sub-folders, one per Node, will be created.

Uses of OptionalParameter in org.apache.reef.runtime.local.driver

Fields in org.apache.reef.runtime.local.driver declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	LocalDriverConfiguration.CLIENT_REMOTE_IDENTIFIER The remote identifier to use for communications back to the client.
static OptionalParameter<Double>	LocalDriverConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<String>	LocalDriverConfiguration.RACK_NAMES The rack names that will be available in the local runtime.

Uses of OptionalParameter in org.apache.reef.runtime.mesos.client

Fields in org.apache.reef.runtime.mesos.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	MesosClientConfiguration.ROOT_FOLDER The folder in which the sub-folders for REEF drivers, one per job, will be created.

Uses of OptionalParameter in org.apache.reef.runtime.mesos.driver

Fields in org.apache.reef.runtime.mesos.driver declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	MesosDriverConfiguration.CLIENT_REMOTE_IDENTIFIER The client remote identifier.
static OptionalParameter<Long>	MesosDriverConfiguration.EVALUATOR_TIMEOUT
static OptionalParameter<String>	MesosDriverConfiguration.JOB_SUBMISSION_DIRECTORY_PREFIX The client remote identifier.
static OptionalParameter<Double>	MesosDriverConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<Integer>	MesosDriverConfiguration.MESOS_SLAVE_PORT The port number of Mesos Slave.

Uses of OptionalParameter in org.apache.reef.runtime.standalone.client

Fields in org.apache.reef.runtime.standalone.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	StandaloneRuntimeConfiguration.RUNTIME_ROOT_FOLDER The folder in which the sub-folders, one per Node, will be created.

Uses of OptionalParameter in org.apache.reef.runtime.yarn.client

Fields in org.apache.reef.runtime.yarn.client declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	YarnDriverConfiguration.JOB_SUBMISSION_DIRECTORY_PREFIX The job submission directory.
static OptionalParameter<Double>	YarnClientConfiguration.JVM_HEAP_SLACK
static OptionalParameter<Double>	ExtensibleYarnClientConfiguration.JVM_HEAP_SLACK
static OptionalParameter<String>	YarnDriverConfiguration.QUEUE The queue to submit this Driver to.
static OptionalParameter<Integer>	YarnClientConfiguration.YARN_PRIORITY
static OptionalParameter<Integer>	ExtensibleYarnClientConfiguration.YARN_PRIORITY
static OptionalParameter<String>	YarnClientConfiguration.YARN_QUEUE_NAME
static OptionalParameter<String>	ExtensibleYarnClientConfiguration.YARN_QUEUE_NAME

Uses of OptionalParameter in org.apache.reef.runtime.yarn.driver

Fields in org.apache.reef.runtime.yarn.driver declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<String>	YarnDriverConfiguration.CLIENT_REMOTE_IDENTIFIER The client remote identifier.
static OptionalParameter<Long>	YarnDriverConfiguration.EVALUATOR_TIMEOUT
static OptionalParameter<Double>	YarnDriverConfiguration.JVM_HEAP_SLACK The fraction of the container memory NOT to use for the Java Heap.
static OptionalParameter<Integer>	YarnDriverConfiguration.YARN_HEARTBEAT_INTERVAL

Uses of OptionalParameter in org.apache.reef.tang.examples.timer

Fields in org.apache.reef.tang.examples.timer declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Integer>	TimerMock.TimerMockConf.MOCK_SLEEP_TIME

Uses of OptionalParameter in org.apache.reef.vortex.driver

Fields in org.apache.reef.vortex.driver declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<Integer>	VortexMasterConf.FUTURE_CALLBACK_THREAD_POOL_SIZE Size of threadpool for callbacks on VortexFuture.
static OptionalParameter<Integer>	VortexMasterConf.NUM_OF_VORTEX_START_THREAD Number of Vortex Start threads.
static OptionalParameter<Integer>	VortexMasterConf.WORKER_CAPACITY Worker Cores.

Uses of OptionalParameter in org.apache.reef.webserver

Fields in org.apache.reef.webserver declared as OptionalParameter

Modifier and Type	Field and Description
static OptionalParameter<HttpHandler>	HttpHandlerConfiguration.HTTP_HANDLERS Specify optional parameter for HttpEventHandlers.