com.revo.deployr.client.broker.options

Class TaskOptions

java.lang.Object

com.revo.deployr.client.broker.options.TaskOptions

Direct Known Subclasses:

BackgroundTaskOptions, DiscreteTaskOptions, PooledTaskOptions

public class TaskOptions
extends java.lang.Object

Task options allow the customization of pre-execution. on-execution and post-execution behaviors for a given Task.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	consoleoff [On-execution] When enabled all R console output is suppressed and will not appear in response markup.
java.lang.String	csvrinputs [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.
boolean	echooff [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.
boolean	encodeDataFramePrimitiveAsVector [Post-execution] Workspace data.frame object encoding preference when retrieving R objects from the current R session following a Task execution.
java.lang.String	graphicsDevice [On-execution] Set R graphics device to use on execution: "png" or "svg".
int	graphicsHeight [On-execution] Set the height of the R graphics device on execution.
int	graphicsWidth [On-execution] Set the width of the R graphics device on execution.
java.lang.String	infinity [Post-execution] Optional custom value to denote INFINITY values in DeployR-encoded objects in the response markup.
java.lang.String	nan [Post-execution] Optional custom value to denote NAN values in DeployR-encoded objects in the response markup.
java.lang.String	preloadByDirectory [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.
TaskPreloadOptions	preloadDirectory [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.
TaskPreloadOptions	preloadWorkspace [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.
java.util.List<com.revo.deployr.client.data.RData>	rinputs [Pre-execution] List of DeployR-encoded R objects to be added to the workspace of the current R session prior to the execution.
java.util.List<java.lang.String>	routputs [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.
TaskStorageOptions	storageOptions [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.

Constructor Summary

Constructors

Constructor and Description
TaskOptions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rinputs

public java.util.List<com.revo.deployr.client.data.RData> rinputs

[Pre-execution] List of DeployR-encoded R objects to be added to the workspace of the current R session prior to the execution.

csvrinputs

public java.lang.String csvrinputs

[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.

eg. csvrinputs=name,George,age,45

preloadWorkspace

public TaskPreloadOptions preloadWorkspace

[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.

preloadDirectory

public TaskPreloadOptions preloadDirectory

[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.

preloadByDirectory

public java.lang.String preloadByDirectory

[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.

When loading the contents of more than one directory, use a comma-separated list of directory names.

graphicsDevice

public java.lang.String graphicsDevice

[On-execution] Set R graphics device to use on execution: "png" or "svg". The default R graphics device is "png".

graphicsWidth

public int graphicsWidth

[On-execution] Set the width of the R graphics device on execution.

graphicsHeight

public int graphicsHeight

[On-execution] Set the height of the R graphics device on execution.

echooff

public boolean echooff

[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.

consoleoff

public boolean consoleoff

[On-execution] When enabled all R console output is suppressed and will not appear in response markup. This control has no impact on console output on the event stream.

routputs

public java.util.List<java.lang.String> routputs

[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.

encodeDataFramePrimitiveAsVector

public boolean encodeDataFramePrimitiveAsVector

[Post-execution] Workspace data.frame object encoding preference when retrieving R objects from the current R session following a Task execution.

This option works in conjunction with the robjects property on this class. The default DeployR-encoding is to encode primatives inside data.frame objects as primitives, not as vectors.

nan

public java.lang.String nan

[Post-execution] Optional custom value to denote NAN values in DeployR-encoded objects in the response markup. Default is null.

infinity

public java.lang.String infinity

[Post-execution] Optional custom value to denote INFINITY values in DeployR-encoded objects in the response markup. Default is 0x7ff0000000000000L.

storageOptions

public TaskStorageOptions storageOptions

[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.

Storage options are only available to Tasks executing on behalf of AUTHENTICATED users. Tasks executing on behalf of ANONYMOUS users can not store data to the repository.

Constructor Detail

TaskOptions

public TaskOptions()