Index (REEF Runtime for YARN 0.14.0 API)

A C D E G I J M N O Q R S T U W Y

A

addLocalResource(String, LocalResource) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Add a file to be localized on the driver.

C

CLIENT_REMOTE_IDENTIFIER - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration: The client remote identifier.
close() - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper
close() - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorLogAppendWriter: Closes the FileSystem.
close() - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorLogOverwriteWriter: Closes the FileSystem.
close() - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorPreserver: Closes the writer, which in turn closes the FileSystem.
CONF - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration
CONF - Static variable in class org.apache.reef.runtime.yarn.client.YarnClientConfiguration
CONF - Static variable in class org.apache.reef.runtime.yarn.client.YarnDriverConfiguration: ConfigurationModule to set YARN-Specific configuration options to be merged with DriverConfiguration.
CONF - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
CONF - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverRestartConfiguration: This event is fired in place of the ON_DRIVER_STARTED when the Driver is in fact restarted after failure.
createJobFolder(String) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobUploader: Convenience override for int ids.
createJobFolder(int) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobUploader: Convenience override for int ids.
createJobFolderWithApplicationId(String) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobUploader: Creates the Job folder on the DFS.

D

DefaultRackNameFormatter - Class in org.apache.reef.runtime.yarn.driver: Default implementation of rack names formatter.
DFSEvaluatorLogAppendWriter - Class in org.apache.reef.runtime.yarn.driver.restart: The DFS evaluator logger that performs regular append.
DFSEvaluatorLogOverwriteWriter - Class in org.apache.reef.runtime.yarn.driver.restart: The DFS evaluator logger that does not support append and does append by overwrite.
DFSEvaluatorLogWriter - Interface in org.apache.reef.runtime.yarn.driver.restart: The Evaluator log writer that writes to DFS.
DFSEvaluatorPreserver - Class in org.apache.reef.runtime.yarn.driver.restart: An Evaluator Preserver that uses the DFS on YARN.
DRIVER_CONFIGURATION_PROVIDER - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration: Driver configuration provider for the client.
DRIVER_CONFIGURATION_PROVIDERS - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration: Configuration provides whose Configuration will be merged into all Driver Configuration.
DRIVER_CONFIGURATION_PROVIDERS - Static variable in class org.apache.reef.runtime.yarn.client.YarnClientConfiguration: Configuration provides whose Configuration will be merged into all Driver Configuration.

E

EVALUATOR_PRESERVER - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverRestartConfiguration: The Evaluator Preserver implementation used for YARN.
EVALUATOR_TIMEOUT - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
ExtensibleYarnClientConfiguration - Class in org.apache.reef.runtime.yarn.client: An extensible ConfigurationModule for the YARN resourcemanager.
ExtensibleYarnClientConfiguration() - Constructor for class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration

G

getAppAttemptId() - Static method in class org.apache.reef.runtime.yarn.util.YarnUtilities
getAppAttemptId(String) - Static method in class org.apache.reef.runtime.yarn.util.YarnUtilities
getApplicationId() - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper
getApplicationId() - Static method in class org.apache.reef.runtime.yarn.util.YarnUtilities
getContainerIdString() - Static method in class org.apache.reef.runtime.yarn.util.YarnUtilities
getContainerLaunchContext(List<String>, Map<String, LocalResource>, byte[]) - Static method in class org.apache.reef.runtime.yarn.util.YarnTypes
getContainerLaunchContext(List<String>, Map<String, LocalResource>, byte[], ApplicationId) - Static method in class org.apache.reef.runtime.yarn.util.YarnTypes: Gets a LaunchContext and sets the environment variable YarnUtilities.REEF_YARN_APPLICATION_ID_ENV_VAR for REEF Evaluators.
getDriverClasspathPrefix() - Method in class org.apache.reef.runtime.yarn.YarnClasspathProvider
getDriverClasspathSuffix() - Method in class org.apache.reef.runtime.yarn.YarnClasspathProvider
getEvaluatorClasspathPrefix() - Method in class org.apache.reef.runtime.yarn.YarnClasspathProvider
getEvaluatorClasspathSuffix() - Method in class org.apache.reef.runtime.yarn.YarnClasspathProvider
getJobSubmissionDirectoryPath(String) - Method in interface org.apache.reef.runtime.yarn.driver.JobSubmissionDirectoryProvider: Returns path to job submission directory.
getJobSubmissionDirectoryPath(String) - Method in class org.apache.reef.runtime.yarn.driver.JobSubmissionDirectoryProviderImpl
getLocalResourceForPath(Path, LocalResourceType) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobFolder: Creates a LocalResource instance for the JAR file referenced by the given Path.
getPath() - Method in class org.apache.reef.runtime.yarn.client.uploader.JobFolder
getPreviousEvaluators() - Method in class org.apache.reef.runtime.yarn.driver.YarnDriverRuntimeRestartManager: Used by DriverRestartManager.
getRackName(Container) - Method in class org.apache.reef.runtime.yarn.driver.DefaultRackNameFormatter
getRackName(Container) - Method in interface org.apache.reef.runtime.yarn.driver.RackNameFormatter: The rack name of the Container.
getResubmissionAttempts() - Method in class org.apache.reef.runtime.yarn.driver.YarnDriverRuntimeRestartManager: Determines the number of times the Driver has been submitted based on the container ID environment variable provided by YARN.
getStringApplicationId() - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper
getTokens() - Method in interface org.apache.reef.runtime.yarn.client.SecurityTokenProvider: Returns a ByteBuffer containing security tokens.
getTrackingUrl() - Method in interface org.apache.reef.runtime.yarn.driver.TrackingURLProvider

I

informAboutEvaluatorFailures(Set<String>) - Method in class org.apache.reef.runtime.yarn.driver.YarnDriverRuntimeRestartManager: Calls the appropriate handler via REEFEventHandlers, which is a runtime specific implementation of the YARN runtime.
isAtOrAfterVersion(String) - Static method in class org.apache.reef.runtime.yarn.util.YarnTypes

J

JOB_IDENTIFIER - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
JOB_SUBMISSION_DIRECTORY - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
JOB_SUBMISSION_DIRECTORY_PREFIX - Static variable in class org.apache.reef.runtime.yarn.client.YarnDriverConfiguration: The job submission directory.
JobFolder - Class in org.apache.reef.runtime.yarn.client.uploader: Helper class that represents a folder on the destination filesystem.
JobPriority - Class in org.apache.reef.runtime.yarn.client.parameters: The priority of the submitted job.
JobPriority() - Constructor for class org.apache.reef.runtime.yarn.client.parameters.JobPriority
JobQueue - Class in org.apache.reef.runtime.yarn.client.parameters: The queue to submit a job to.
JobQueue() - Constructor for class org.apache.reef.runtime.yarn.client.parameters.JobQueue
JobSubmissionDirectory - Class in org.apache.reef.runtime.yarn.driver.parameters: The job submission directory.
JobSubmissionDirectory() - Constructor for class org.apache.reef.runtime.yarn.driver.parameters.JobSubmissionDirectory
JobSubmissionDirectoryPrefix - Class in org.apache.reef.runtime.yarn.driver.parameters: The job submission directory.
JobSubmissionDirectoryPrefix() - Constructor for class org.apache.reef.runtime.yarn.driver.parameters.JobSubmissionDirectoryPrefix
JobSubmissionDirectoryProvider - Interface in org.apache.reef.runtime.yarn.driver: Provides path to job submission directory.
JobSubmissionDirectoryProviderImpl - Class in org.apache.reef.runtime.yarn.driver: Default implementation of JobSubmissionDirectoryProvider.
JobUploader - Class in org.apache.reef.runtime.yarn.client.uploader: Helper class to upload the driver files to HDFS.
JVM_HEAP_SLACK - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration
JVM_HEAP_SLACK - Static variable in class org.apache.reef.runtime.yarn.client.YarnClientConfiguration
JVM_HEAP_SLACK - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration: The fraction of the container memory NOT to use for the Java Heap.

M

MIN_VERSION_KEEP_CONTAINERS_AVAILABLE - Static variable in class org.apache.reef.runtime.yarn.util.YarnTypes

N

newInstance() - Method in class org.apache.reef.runtime.yarn.util.YarnConfigurationConstructor

O

onContainerRequest(AMRMClient.ContainerRequest...) - Method in interface org.apache.reef.runtime.yarn.driver.YarnContainerRequestHandler: Enqueue a set of container requests with YARN.
onContainerRequest(AMRMClient.ContainerRequest...) - Method in class org.apache.reef.runtime.yarn.driver.YarnContainerRequestHandlerImpl
onNext(ResourceLaunchEvent) - Method in class org.apache.reef.runtime.yarn.driver.YARNResourceLaunchHandler
onNext(ResourceReleaseEvent) - Method in class org.apache.reef.runtime.yarn.driver.YARNResourceReleaseHandler
onNext(ResourceRequestEvent) - Method in class org.apache.reef.runtime.yarn.driver.YarnResourceRequestHandler
onNext(RuntimeStart) - Method in class org.apache.reef.runtime.yarn.driver.YARNRuntimeStartHandler
onNext(RuntimeStop) - Method in class org.apache.reef.runtime.yarn.driver.YARNRuntimeStopHandler
org.apache.reef.runtime.yarn - package org.apache.reef.runtime.yarn: An YARN implementation of REEF that uses YARN container for execution.
org.apache.reef.runtime.yarn.client - package org.apache.reef.runtime.yarn.client: Client-side event handlers for YARN resourcemanager.
org.apache.reef.runtime.yarn.client.parameters - package org.apache.reef.runtime.yarn.client.parameters: Client-side parameters for YARN job submission.
org.apache.reef.runtime.yarn.client.uploader - package org.apache.reef.runtime.yarn.client.uploader: Uploader to copy job resource files to YARN.
org.apache.reef.runtime.yarn.driver - package org.apache.reef.runtime.yarn.driver: The Driver-Side implementation of the YARN adapter for REEF.
org.apache.reef.runtime.yarn.driver.parameters - package org.apache.reef.runtime.yarn.driver.parameters: Driver-side parameters of YARN job submission.
org.apache.reef.runtime.yarn.driver.restart - package org.apache.reef.runtime.yarn.driver.restart: The package contains classes that are used specifically on restart.
org.apache.reef.runtime.yarn.util - package org.apache.reef.runtime.yarn.util: Utility for YARN runtime.

Q

QUEUE - Static variable in class org.apache.reef.runtime.yarn.client.YarnDriverConfiguration: The queue to submit this Driver to.

R

RACK_NAME_FORMATTER - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
RackNameFormatter - Interface in org.apache.reef.runtime.yarn.driver: Provides a method to retrieve the rack name from a container, which may be dependent on the Hadoop distribution.
recordAllocatedEvaluator(String) - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorPreserver: Adds the allocated evaluator entry to the evaluator log.
recordAllocatedEvaluator(String) - Method in class org.apache.reef.runtime.yarn.driver.YarnDriverRuntimeRestartManager
recordRemovedEvaluator(String) - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorPreserver: Adds the removed evaluator entry to the evaluator log.
recordRemovedEvaluator(String) - Method in class org.apache.reef.runtime.yarn.driver.YarnDriverRuntimeRestartManager
recoverEvaluators() - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorPreserver: Recovers the set of evaluators that are alive.
REEF_YARN_APPLICATION_ID_ENV_VAR - Static variable in class org.apache.reef.runtime.yarn.util.YarnUtilities
RUNTIME_NAME - Static variable in class org.apache.reef.runtime.yarn.driver.RuntimeIdentifier
RuntimeIdentifier - Class in org.apache.reef.runtime.yarn.driver: Runtime Identifier Implementation.

S

SecurityTokenProvider - Interface in org.apache.reef.runtime.yarn.client: Provides security token for setting up YARN container context.
setApplicationName(String) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Set the name of the application to be submitted.
setConfigurationFilePaths(List<String>) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Sets the configuration file for the job.
setDriverMemory(int) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Set the amount of memory to be allocated to the Driver.
setLauncherClass(Class) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Sets the launcher class for the job.
setMaxApplicationAttempts(int) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Sets the maximum application attempts for the application.
setPreserveEvaluators(boolean) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Set whether or not the resource manager should preserve evaluators across driver restarts.
setPriority(int) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Set the priority of the job.
setQueue(String) - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper: Assign this job submission to a queue.
submit() - Method in class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper

T

TrackingURLProvider - Interface in org.apache.reef.runtime.yarn.driver: Implement this interface to set the tracking URL reported to YARN.

U

upload(File) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobFolder: Uploads the given file to the DFS.
uploadAsLocalResource(File, LocalResourceType) - Method in class org.apache.reef.runtime.yarn.client.uploader.JobFolder: Shortcut to first upload the file and then form a LocalResource for the YARN submission.

W

writeToEvaluatorLog(String) - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorLogAppendWriter: Writes a formatted entry (addition or removal) for an Evaluator ID into the DFS evaluator log.
writeToEvaluatorLog(String) - Method in class org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorLogOverwriteWriter: Writes a formatted entry (addition or removal) for an Evaluator ID into the DFS evaluator log.
writeToEvaluatorLog(String) - Method in interface org.apache.reef.runtime.yarn.driver.restart.DFSEvaluatorLogWriter: Writes a formatted entry (addition or removal) for an Evaluator ID into the DFS evaluator log.

Y

YARN_HEARTBEAT_INTERVAL - Static variable in class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
YARN_PRIORITY - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration
YARN_PRIORITY - Static variable in class org.apache.reef.runtime.yarn.client.YarnClientConfiguration
YARN_QUEUE_NAME - Static variable in class org.apache.reef.runtime.yarn.client.ExtensibleYarnClientConfiguration
YARN_QUEUE_NAME - Static variable in class org.apache.reef.runtime.yarn.client.YarnClientConfiguration
YarnClasspathProvider - Class in org.apache.reef.runtime.yarn: Access to the classpath according to the REEF file system standard.
YarnClientConfiguration - Class in org.apache.reef.runtime.yarn.client: A ConfigurationModule for the YARN resourcemanager.
YarnClientConfiguration() - Constructor for class org.apache.reef.runtime.yarn.client.YarnClientConfiguration
YarnConfigurationConstructor - Class in org.apache.reef.runtime.yarn.util: An external constructor that creates YarnConfiguration instances.
YarnContainerRequestHandler - Interface in org.apache.reef.runtime.yarn.driver: Interface to request containers from YARN using AMRMClient.ContainerRequest requests.
YarnContainerRequestHandlerImpl - Class in org.apache.reef.runtime.yarn.driver: Side-channel to request containers from YARN using AMRMClient.ContainerRequest requests.
YarnDriverConfiguration - Class in org.apache.reef.runtime.yarn.client: Additional YARN-Specific configuration options to be merged with DriverConfiguration.
YarnDriverConfiguration() - Constructor for class org.apache.reef.runtime.yarn.client.YarnDriverConfiguration
YarnDriverConfiguration - Class in org.apache.reef.runtime.yarn.driver: ConfigurationModule to create YARN Driver configurations.
YarnDriverConfiguration() - Constructor for class org.apache.reef.runtime.yarn.driver.YarnDriverConfiguration
YarnDriverRestartConfiguration - Class in org.apache.reef.runtime.yarn.driver: Use this ConfigurationModule to configure YARN-specific Restart options for the driver.
YarnDriverRestartConfiguration() - Constructor for class org.apache.reef.runtime.yarn.driver.YarnDriverRestartConfiguration
YarnDriverRuntimeRestartManager - Class in org.apache.reef.runtime.yarn.driver: The implementation of restart manager for YARN.
YarnEvaluatorPreserver - Class in org.apache.reef.runtime.yarn.driver.parameters: The Evaluator Preserver to use on YARN, defaults to DFS.
YarnHeartbeatPeriod - Class in org.apache.reef.runtime.yarn.driver.parameters: How often we talk to YARN.
YarnHeartbeatPeriod() - Constructor for class org.apache.reef.runtime.yarn.driver.parameters.YarnHeartbeatPeriod
YARNResourceLaunchHandler - Class in org.apache.reef.runtime.yarn.driver: Resource launch handler for YARN.
YARNResourceReleaseHandler - Class in org.apache.reef.runtime.yarn.driver: ResourceReleaseHandler for YARN.
YarnResourceRequestHandler - Class in org.apache.reef.runtime.yarn.driver: Accepts resource requests from the REEF layer, translates them into requests for YARN and hands them to the appropriate handler for those.
YARNRuntimeStartHandler - Class in org.apache.reef.runtime.yarn.driver: Handler of RuntimeStart for the YARN Runtime.
YARNRuntimeStartHandler(YarnContainerManager) - Constructor for class org.apache.reef.runtime.yarn.driver.YARNRuntimeStartHandler
YARNRuntimeStopHandler - Class in org.apache.reef.runtime.yarn.driver: Shuts down the YARN resource manager.
YarnSubmissionHelper - Class in org.apache.reef.runtime.yarn.client: Helper code that wraps the YARN Client API for our purposes.
YarnSubmissionHelper(YarnConfiguration, REEFFileNames, ClasspathProvider, SecurityTokenProvider, List<String>) - Constructor for class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper
YarnSubmissionHelper(YarnConfiguration, REEFFileNames, ClasspathProvider, SecurityTokenProvider) - Constructor for class org.apache.reef.runtime.yarn.client.YarnSubmissionHelper
YarnTypes - Class in org.apache.reef.runtime.yarn.util: Helper class that creates the various records in the YARN API.
YarnUtilities - Class in org.apache.reef.runtime.yarn.util: A helper class for YARN applications.

A C D E G I J M N O Q R S T U W Y