Org.Apache.REEF.Common.Files.REEFFileNames Class Reference

Contains all file system constants used by REEF. More...

Public Member Functions
	REEFFileNames ()
string	GetReefFolderName ()
	The name of the REEF folder inside of the working directory of an Evaluator or Driver More...
string	GetGlobalFolderName ()
string	GetGlobalFolderPath ()
string	GetLocalFolderName ()
string	GetLocalFolderPath ()
string	GetDriverConfigurationName ()
string	GetClrDriverConfigurationName ()
string	GetDriverConfigurationPath ()
string	GetClrDriverConfigurationPath ()
string	GetEvaluatorConfigurationName ()
string	GetEvaluatorConfigurationPath ()
string	GetClrBridgeConfigurationName ()
string	GetJarFileSuffix ()
string	GetJobFolderPrefix ()
	The prefix used whenever REEF is asked to create a job folder, on (H)DFS or locally. More...
string	GetDriverStderrFileName ()
string	GetDriverStdoutFileName ()
string	GetEvaluatorFolderPrefix ()
string	GetEvaluatorStderrFileName ()
string	GetEvaluatorStdoutFileName ()
string	GetCppBridge ()
string	GetBridgeExePath ()
	The path of the Driver Launcher exe. More...
string	GetBridgeExeConfigPath ()
	The path of the Driver Launcher exe config . More...
string	GetAppSubmissionParametersFile ()
	The Job Submission application parameters file that is used to submit a job through Java, either directly or via a "bootstrap" method. More...
string	GetJobSubmissionParametersFile ()
	The Job Submission job parameters file that is used to submit a job through Java, either directly or via a "bootstrap" method. More...
string	GetYarnDriverLogOutputVariable ()
	Returns the default driver log output variable for YARN. More...
string	GetDefaultYarnDriverStdoutFilePath ()
	The default YARN Driver stdout file path. More...
string	GetDefaultYarnDriverStderrFilePath ()
	The default YARN Driver stderr file path. More...
string	GetDriverLoggingConfigCommand ()
	The command that allows redirecting Driver stdout and stderr logs to appropriate files More...
string	GetSecurityTokenIdentifierFileName ()
	The filename for security token identifier More...
string	GetSecurityTokenPasswordFileName ()
	The filename for security token password More...
string	GetPidFileName ()
	The file name of the PID file created in the current working directory of the process. More...

Properties
string	DriverHttpEndpoint [get]

Detailed Description

Contains all file system constants used by REEF.

Whenever editing this, make sure you also edit org.apache.reef.runtime.common.files.REEFFileNames in the java code base.

Constructor & Destructor Documentation

Org.Apache.REEF.Common.Files.REEFFileNames.REEFFileNames ( )

inline

Member Function Documentation

string Org.Apache.REEF.Common.Files.REEFFileNames.GetAppSubmissionParametersFile ( )

inline

The Job Submission application parameters file that is used to submit a job through Java, either directly or via a "bootstrap" method.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetBridgeExeConfigPath ( )

inline

The path of the Driver Launcher exe config .

Returns

path of the Driver Launcher exe config.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetBridgeExePath ( )

inline

The path of the Driver Launcher exe.

Returns

path of the Driver Launcher EXE.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetClrBridgeConfigurationName ( )

inline

Returns

It returns the clrBridge.config file name

string Org.Apache.REEF.Common.Files.REEFFileNames.GetClrDriverConfigurationName ( )

inline

Returns

The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER

string Org.Apache.REEF.Common.Files.REEFFileNames.GetClrDriverConfigurationPath ( )

inline

Returns

The path to the CLR driver configuration: GLOBAL_FOLDER/LOCAL_FOLDER/CLR_DRIVER_CONFIGURATION_NAME

string Org.Apache.REEF.Common.Files.REEFFileNames.GetCppBridge ( )

inline

Returns

the name of cpp bridge file

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDefaultYarnDriverStderrFilePath ( )

inline

The default YARN Driver stderr file path.

Returns

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDefaultYarnDriverStdoutFilePath ( )

inline

The default YARN Driver stdout file path.

Returns

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDriverConfigurationName ( )

inline

Returns

The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDriverConfigurationPath ( )

inline

Returns

The path to the driver configuration: GLOBAL_FOLDER/LOCAL_FOLDER/DRIVER_CONFIGURATION_NAME

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDriverLoggingConfigCommand ( )

inline

The command that allows redirecting Driver stdout and stderr logs to appropriate files

Returns

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDriverStderrFileName ( )

inline

Returns

The name used within the current working directory of the driver to redirect standard error to.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetDriverStdoutFileName ( )

inline

Returns

The name used within the current working directory of the driver to redirect standard out to.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetEvaluatorConfigurationName ( )

inline

Returns

REEF_BASE_FOLDER/LOCAL_FOLDER

string Org.Apache.REEF.Common.Files.REEFFileNames.GetEvaluatorConfigurationPath ( )

inline

Returns

the path to the evaluator configuration.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetEvaluatorFolderPrefix ( )

inline

Returns

The prefix used whenever REEF is asked to create an Evaluator folder, e.g. for staging.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetEvaluatorStderrFileName ( )

inline

Returns

The name used within the current working directory of the driver to redirect standard error to.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetEvaluatorStdoutFileName ( )

inline

Returns

The name used within the current working directory of the driver to redirect standard out to.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetGlobalFolderName ( )

inline

Returns

the name of the folder inside of REEF_BASE_FOLDER that houses the global files.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetGlobalFolderPath ( )

inline

Returns

the path to the global folder: REEF_BASE_FOLDER/GLOBAL_FOLDER

string Org.Apache.REEF.Common.Files.REEFFileNames.GetJarFileSuffix ( )

inline

Returns

The suffix used for JAR files, including the "."

string Org.Apache.REEF.Common.Files.REEFFileNames.GetJobFolderPrefix ( )

inline

The prefix used whenever REEF is asked to create a job folder, on (H)DFS or locally.

This prefix is also used with JAR files created to represent a job.

Returns

string Org.Apache.REEF.Common.Files.REEFFileNames.GetJobSubmissionParametersFile ( )

inline

The Job Submission job parameters file that is used to submit a job through Java, either directly or via a "bootstrap" method.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetLocalFolderName ( )

inline

Returns

the name of the folder inside of REEF_BASE_FOLDER that houses the local files.

string Org.Apache.REEF.Common.Files.REEFFileNames.GetLocalFolderPath ( )

inline

Returns

the path to the local folder: REEF_BASE_FOLDER/LOCAL_FOLDER

string Org.Apache.REEF.Common.Files.REEFFileNames.GetPidFileName ( )

inline

The file name of the PID file created in the current working directory of the process.

This is similar to the file name in the PIDStoreHandler.java

string Org.Apache.REEF.Common.Files.REEFFileNames.GetReefFolderName ( )

inline

The name of the REEF folder inside of the working directory of an Evaluator or Driver

Returns

string Org.Apache.REEF.Common.Files.REEFFileNames.GetSecurityTokenIdentifierFileName ( )

inline

The filename for security token identifier

Returns

filename which contains raw bytes of security token identifier

string Org.Apache.REEF.Common.Files.REEFFileNames.GetSecurityTokenPasswordFileName ( )

inline

The filename for security token password

Returns

filename which contains raw bytes of security token password

string Org.Apache.REEF.Common.Files.REEFFileNames.GetYarnDriverLogOutputVariable ( )

inline

Returns the default driver log output variable for YARN.

Expands into the constant "<LOG_DIR>".

Returns

"<LOG_DIR>"

Property Documentation

string Org.Apache.REEF.Common.Files.REEFFileNames.DriverHttpEndpoint

get

Returns

File name that contains the dfs path for the DriverHttpEndpoint

---

The documentation for this class was generated from the following file:

• lang/cs/Org.Apache.REEF.Common/Files/REEFFileNames.cs