Index (DeployR Java RBroker Framework)

A B C D E F G I M N O P R S T U V W

A

addBrokerListener(RBrokerListener) - Method in interface com.revo.deployr.client.broker.RBroker: Register an asynchronous listener to receive callbacks on RBroker runtime statistics events or runtime errors.
addTaskListener(RTaskListener) - Method in interface com.revo.deployr.client.broker.RBroker: Register an asynchronous listener to receive callbacks on RTask completion or failure events.
allowSelfSignedSSLCert - Variable in class com.revo.deployr.client.broker.config.RBrokerConfig
author - Variable in class com.revo.deployr.client.broker.options.PoolPreloadOptions: Comma-separated list of authors, one author per filename.
author - Variable in class com.revo.deployr.client.broker.options.TaskPreloadOptions: Comma-separated list of authors, one author per filename.

B

BackgroundBrokerConfig - Class in com.revo.deployr.client.broker.config: Configuration options for a Background Task RBroker.
BackgroundBrokerConfig(String, RAuthentication) - Constructor for class com.revo.deployr.client.broker.config.BackgroundBrokerConfig
backgroundTask(String, String, String, String, String, String, BackgroundTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a BackgroundTask for an analytics Web service based on a repository-managed R script.
backgroundTask(String, String, String, BackgroundTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a BackgroundTask for an analytics Web service based on an arbitrary block of R code.
backgroundTask(String, String, URL, BackgroundTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a BackgroundTask for an analytics Web service based on a URL-addressable R script.
backgroundTaskBroker(BackgroundBrokerConfig) - Static method in class com.revo.deployr.client.factory.RBrokerFactory: Create an instance of an RBroker to manage the execution of BackgroundTask.
BackgroundTaskOptions - Class in com.revo.deployr.client.broker.options: Runtime options for a BackgroundTask.
BackgroundTaskOptions() - Constructor for class com.revo.deployr.client.broker.options.BackgroundTaskOptions

C

cancel(boolean) - Method in interface com.revo.deployr.client.broker.RTaskToken
com.revo.deployr.client.broker - package com.revo.deployr.client.broker: Defines a high-level programming model for DeployR-enabled client applications.
com.revo.deployr.client.broker.app - package com.revo.deployr.client.broker.app: Defines interfaces for RBroker compliant client application simulators.
com.revo.deployr.client.broker.config - package com.revo.deployr.client.broker.config: Defines RBroker configuration options.
com.revo.deployr.client.broker.options - package com.revo.deployr.client.broker.options: Defines RTask configuration options.
com.revo.deployr.client.factory - package com.revo.deployr.client.factory: Defines convenience factory classes for DeployR-enabled client applications.
consoleoff - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [On-execution] When enabled all R console output is suppressed and will not appear in response markup.
csvrinputs - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Pre-execution] Comma-seperated list of primitive R object names and values, to be added to the workspace of the current R session prior to the execution.

D

deployrEndpoint - Variable in class com.revo.deployr.client.broker.config.RBrokerConfig: Specifies the HTTP URL endpoint for a DeployR Server instance.
directory - Variable in class com.revo.deployr.client.broker.options.PoolPreloadOptions: Comma-separated list of directories, one directory per filename.
directory - Variable in class com.revo.deployr.client.broker.options.TaskPreloadOptions: Comma-separated list of directories, one directory per filename.
directory - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Specify a directory into which each of the stored files, objects and/or workspace will be saved in the repository.
DiscreteBrokerConfig - Class in com.revo.deployr.client.broker.config: Configuration options for a Discrete Task RBroker.
DiscreteBrokerConfig(String) - Constructor for class com.revo.deployr.client.broker.config.DiscreteBrokerConfig
DiscreteBrokerConfig(String, RAuthentication) - Constructor for class com.revo.deployr.client.broker.config.DiscreteBrokerConfig
DiscreteBrokerConfig(String, RAuthentication, int) - Constructor for class com.revo.deployr.client.broker.config.DiscreteBrokerConfig
discreteTask(String, String, String, String, DiscreteTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a DiscreteTask for an analytics Web service based on a repository-managed R script.
discreteTask(URL, DiscreteTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a DiscreteTask for an analytics Web service based on a URL-addressable R script.
discreteTaskBroker(DiscreteBrokerConfig) - Static method in class com.revo.deployr.client.factory.RBrokerFactory: Create an instance of an RBroker to manage the execution of DiscreteTask.
DiscreteTaskOptions - Class in com.revo.deployr.client.broker.options: Runtime options for a DiscreteTask.
DiscreteTaskOptions() - Constructor for class com.revo.deployr.client.broker.options.DiscreteTaskOptions

E

echooff - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [On-execution] When enabled R commands are not echoed to the console output and will not appear in response markup or on the event stream.
encodeDataFramePrimitiveAsVector - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Post-execution] Workspace data.frame object encoding preference when retrieving R objects from the current R session following a Task execution.
executingTasks - Variable in class com.revo.deployr.client.broker.RBrokerStatus: Number of RTask currently executing on RBroker.

F

filename - Variable in class com.revo.deployr.client.broker.options.PoolPreloadOptions: Comma-separated list of repository filenames.
filename - Variable in class com.revo.deployr.client.broker.options.TaskPreloadOptions: Comma-separated list of repository filenames.
files - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Comma-separated list of working directory files to be stored in the repository following an execution.
flush() - Method in interface com.revo.deployr.client.broker.RBroker: Flushes all pending RTask from queues maintained by RBroker.

G

getFailure() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task failure indicator.
getFuture() - Method in interface com.revo.deployr.client.broker.RTaskToken
getGeneratedConsole() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task R session generated console output.
getGeneratedFiles() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task R session working directory generated files.
getGeneratedObjects() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task R session workspace generated objects.
getGeneratedPlots() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task R session graphics device generated plots.
getID() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task DeployR identifier.
getResult() - Method in interface com.revo.deployr.client.broker.RTaskToken
getStoredFiles() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task generated files stored to DeployR repository.
getTask() - Method in interface com.revo.deployr.client.broker.RTaskToken
getTimeOnCall() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task time spent on call to server.
getTimeOnCode() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task time spent executing R code on server.
getTimeOnServer() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task time spent being processed on server.
getToken() - Method in interface com.revo.deployr.client.broker.RTask: Return RTask client application token.
getType() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task type.
graphicsDevice - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [On-execution] Set R graphics device to use on execution: "png" or "svg".
graphicsHeight - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [On-execution] Set the height of the R graphics device on execution.
graphicsWidth - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [On-execution] Set the width of the R graphics device on execution.

I

infinity - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Post-execution] Optional custom value to denote INFINITY values in DeployR-encoded objects in the response markup.
isCancelled() - Method in interface com.revo.deployr.client.broker.RTaskToken
isConnected() - Method in interface com.revo.deployr.client.broker.RBroker: Indicates if current RBroker instance is still connected to the DeployR server.
isDone() - Method in interface com.revo.deployr.client.broker.RTaskToken
isIdle - Variable in class com.revo.deployr.client.broker.RBrokerStatus: Flag indicating if RBroker is idle.
isInterrupted() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task interrupted indicator.
isSuccess() - Method in interface com.revo.deployr.client.broker.RTaskResult: Task success indicator.

M

MAX_CONCURRENCY - Static variable in class com.revo.deployr.client.broker.config.RBrokerConfig: Constant value, defines the max permissible concurrency supported by a single instance of an RBroker.
maxConcurrency() - Method in interface com.revo.deployr.client.broker.RBroker: Returns the task execution concurrency levels enforced for this instance of RBroker.
maxConcurrentTaskLimit - Variable in class com.revo.deployr.client.broker.config.RBrokerConfig: Specifies the task execution concurrency levels requested for an instance of an RBroker.

N

nan - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Post-execution] Optional custom value to denote NAN values in DeployR-encoded objects in the response markup.
newversion - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Enable to create new version of files being stored in the repository following an execution.
noproject - Variable in class com.revo.deployr.client.broker.options.BackgroundTaskOptions: Enable noproject option if project persistence following task execution is not required.

O

objects - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Comma-separated list of workspace objects to be stored in the repository following an execution.
onRuntimeError(Throwable) - Method in interface com.revo.deployr.client.broker.RBrokerListener: Asynchronous callback notification when a runtime error occurs within RBroker.
onRuntimeStats(RBrokerRuntimeStats, int) - Method in interface com.revo.deployr.client.broker.RBrokerListener: Asynchronous callback notification RBrokerRuntimeStats.
onTaskCompleted(RTask, RTaskResult) - Method in interface com.revo.deployr.client.broker.RTaskListener
onTaskError(RTask, Throwable) - Method in interface com.revo.deployr.client.broker.RTaskListener
owner() - Method in interface com.revo.deployr.client.broker.RBroker: Returns a token indicating the owner of the current instance of RBroker.

P

pendingTasks - Variable in class com.revo.deployr.client.broker.RBrokerStatus: Number of RTask currently on RBroker queues pending execution.
poolCreationOptions - Variable in class com.revo.deployr.client.broker.config.PooledBrokerConfig: Specifies the set of pre-initialization operations to be performed on each R Session in the pool at creation time.
PoolCreationOptions - Class in com.revo.deployr.client.broker.options: Startup options for a Pooled Task RBroker.
PoolCreationOptions() - Constructor for class com.revo.deployr.client.broker.options.PoolCreationOptions
PooledBrokerConfig - Class in com.revo.deployr.client.broker.config: Configuration options for a Pooled Task RBroker.
PooledBrokerConfig(String, RAuthentication) - Constructor for class com.revo.deployr.client.broker.config.PooledBrokerConfig
PooledBrokerConfig(String, RAuthentication, int) - Constructor for class com.revo.deployr.client.broker.config.PooledBrokerConfig
PooledBrokerConfig(String, RAuthentication, int, PoolCreationOptions) - Constructor for class com.revo.deployr.client.broker.config.PooledBrokerConfig
pooledTask(String, String, String, String, PooledTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a PooledTask for an analytics Web service based on a repository-managed R script.
pooledTask(String, PooledTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a PooledTask for an analytics Web service based on an arbitrary block of R code.
pooledTask(URL, PooledTaskOptions) - Static method in class com.revo.deployr.client.factory.RTaskFactory: Create an instance of a PooledTask for an analytics Web service based on a URL-addressable R script.
pooledTaskBroker(PooledBrokerConfig) - Static method in class com.revo.deployr.client.factory.RBrokerFactory: Create an instance of an RBroker to manage the execution of PooledTask.
PooledTaskOptions - Class in com.revo.deployr.client.broker.options: Runtime options for a PooledTask.
PooledTaskOptions() - Constructor for class com.revo.deployr.client.broker.options.PooledTaskOptions
PoolPreloadOptions - Class in com.revo.deployr.client.broker.options: Pool preload options.
PoolPreloadOptions() - Constructor for class com.revo.deployr.client.broker.options.PoolPreloadOptions
preloadByDirectory - Variable in class com.revo.deployr.client.broker.options.PoolCreationOptions: Preload by directory option allows the loading of all files from one or more repository-managed directories into the working directory into the working directory of each R session in the pool on pool initialization.
preloadByDirectory - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Pre-execution] Preload by directory option allows the loading of all files from one or more repository-managed directories into the working directory of the current R session prior to execution.
preloadDirectory - Variable in class com.revo.deployr.client.broker.options.PoolCreationOptions: Preload working directory options allow the loading of one or more files from the repository into the working directory of each R session in the pool on pool initialization.
preloadDirectory - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Pre-execution] Preload working directory options allow the loading of one or more files from the repository into the working directory of the current R session prior to execution.
preloadWorkspace - Variable in class com.revo.deployr.client.broker.options.PoolCreationOptions: Preload workspace options allow the loading of one or more binary R objects from the repository into the workspace of each R session in the pool on pool initialization.
preloadWorkspace - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Pre-execution] Preload workspace options allow the loading of one or more binary R objects from the repository into the workspace of the current R session prior to execution.
published - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Enable to assign public access on stored files in the repository following an execution.

R

RBroker - Interface in com.revo.deployr.client.broker: Represents a high-level programming model for building DeployR-enabled client applications.
RBrokerConfig - Class in com.revo.deployr.client.broker.config: Base class for all RBroker configuration options.
RBrokerConfig(String) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerConfig(String, boolean) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerConfig(String, RAuthentication) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerConfig(String, RAuthentication, boolean) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerConfig(String, RAuthentication, int) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerConfig(String, RAuthentication, int, boolean) - Constructor for class com.revo.deployr.client.broker.config.RBrokerConfig
RBrokerException - Exception in com.revo.deployr.client.broker: Represents an RBroker exception.
RBrokerException(String) - Constructor for exception com.revo.deployr.client.broker.RBrokerException
RBrokerException(String, Throwable) - Constructor for exception com.revo.deployr.client.broker.RBrokerException
RBrokerFactory - Class in com.revo.deployr.client.factory: Factory to simplify the creation of Discrete, Pooled and Background RBroker instances.
RBrokerListener - Interface in com.revo.deployr.client.broker: Asynchronous callback interface for RBroker runtime statistics and error event listeners.
RBrokerRuntimeStats - Class in com.revo.deployr.client.broker: Summary RTask statistics for live RBroker.
RBrokerRuntimeStats() - Constructor for class com.revo.deployr.client.broker.RBrokerRuntimeStats
RBrokerStatus - Class in com.revo.deployr.client.broker: RBroker status indicating number of currently queued and executing RTask.
RBrokerStatus(int, int) - Constructor for class com.revo.deployr.client.broker.RBrokerStatus
refresh(RBrokerConfig) - Method in interface com.revo.deployr.client.broker.RBroker: Refresh configuration for RBroker.
releaseGridResources - Variable in class com.revo.deployr.client.broker.options.PoolCreationOptions: ReleaseGridResources when enabled causes all live grid resources held by the user to be released before the new pool is created.
repeatCount - Variable in class com.revo.deployr.client.broker.options.BackgroundTaskOptions: Background task schedule repeat count.
repeatInterval - Variable in class com.revo.deployr.client.broker.options.BackgroundTaskOptions: Background task schedule repeat interval.
rinputs - Variable in class com.revo.deployr.client.broker.options.PoolCreationOptions: Rinputs allow the loading of one or more DeployR-encoded R objects to be added to the workspace of each R session in the pool on pool initialization.
rinputs - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Pre-execution] List of DeployR-encoded R objects to be added to the workspace of the current R session prior to the execution.
routputs - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Post-execution] List of workspace objects to be retrieved from the workspace of the current R session following the execution and returned as DeployR-encoded R objects.
RTask - Interface in com.revo.deployr.client.broker: Represents any R Analytics task for execution on an RBroker.
RTaskAppSimulator - Interface in com.revo.deployr.client.broker.app: Interface for RTaskAppSimulator compliant client application simulators.
RTaskFactory - Class in com.revo.deployr.client.factory: Factory to simplify the creation of Discrete, Pooled and Background RTask instances.
RTaskListener - Interface in com.revo.deployr.client.broker: Asynchronous callback interface for RTask completion and error event listeners.
RTaskResult - Interface in com.revo.deployr.client.broker: Represents a handle to the result generated by an RTask.
RTaskToken - Interface in com.revo.deployr.client.broker: Represents a handle to an RTask live on an RBroker.
RTaskType - Enum in com.revo.deployr.client.broker: Defines the currently supported set of RTask.

S

setToken(Object) - Method in interface com.revo.deployr.client.broker.RTask: Set an RTask client application token.
shutdown() - Method in interface com.revo.deployr.client.broker.RBroker: Release all client-side and server-side resources maintained by or on behalf of an instance of RBroker.
simulateApp(RBroker) - Method in interface com.revo.deployr.client.broker.app.RTaskAppSimulator
simulateApp(RTaskAppSimulator) - Method in interface com.revo.deployr.client.broker.RBroker: Launch an RTaskAppSimulator simulation.
startTime - Variable in class com.revo.deployr.client.broker.options.BackgroundTaskOptions: Background task schedule start time in UTC.
status() - Method in interface com.revo.deployr.client.broker.RBroker: Returns status indicating current RTask activity on RBroker.
storageOptions - Variable in class com.revo.deployr.client.broker.options.TaskOptions: [Post-execution] Repository storage options allow the storage of one-or-more workspace objects, the entire workspace and/or one-or-more working directory files from the current R session into the repository following the execution.
submit(RTask) - Method in interface com.revo.deployr.client.broker.RBroker: Submit an RTask for execution under the control of RBroker.
submit(RTask, boolean) - Method in interface com.revo.deployr.client.broker.RBroker: Submit a priority RTask for execution under the control of RBroker.

T

TaskOptions - Class in com.revo.deployr.client.broker.options: Task options allow the customization of pre-execution.
TaskOptions() - Constructor for class com.revo.deployr.client.broker.options.TaskOptions
TaskPreloadOptions - Class in com.revo.deployr.client.broker.options: Task preload options.
TaskPreloadOptions() - Constructor for class com.revo.deployr.client.broker.options.TaskPreloadOptions
TaskStorageOptions - Class in com.revo.deployr.client.broker.options: Task storage options.
TaskStorageOptions() - Constructor for class com.revo.deployr.client.broker.options.TaskStorageOptions
toString() - Method in class com.revo.deployr.client.broker.RBrokerRuntimeStats
toString() - Method in class com.revo.deployr.client.broker.RBrokerStatus
totalTasksRun - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats
totalTasksRunToFailure - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats
totalTasksRunToSuccess - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats
totalTimeTasksOnCall - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats
totalTimeTasksOnCode - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats
totalTimeTasksOnServer - Variable in class com.revo.deployr.client.broker.RBrokerRuntimeStats

U

userCredentials - Variable in class com.revo.deployr.client.broker.config.RBrokerConfig: Specifies the basic authentication user credentials for an authenticated instance of an RBroker.

V

valueOf(String) - Static method in enum com.revo.deployr.client.broker.RTaskType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.revo.deployr.client.broker.RTaskType: Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class com.revo.deployr.client.broker.options.PoolPreloadOptions: Optional, comma-separated list of versions, one version per filename.
version - Variable in class com.revo.deployr.client.broker.options.TaskPreloadOptions: Optional, comma-separated list of versions, one version per filename.

W

workspace - Variable in class com.revo.deployr.client.broker.options.TaskStorageOptions: Specify a filename and the contents of the entire workspace will be saved as filename.rData in the repository.

A B C D E F G I M N O P R S T U V W