Defines a process that can be run. More...

#include <Process.hpp>

Public Member Functions
	ProcessOptions ()
	Constructor.

Public Attributes
std::vector< std::string >	Arguments
	The arguments of the process. Each argument will be escaped using single quotations so that the values are always interpreted literally. No expansion of environment variables or backslashes will be performed.

bool	CloseStdIn
	Whether to close write end of the standard input stream after the specified StandardInput is written. Default: true. More...

api::EnvironmentList	Environment
	The environment variables which should available to the process. If PATH is not set, it will be added to the environment with the same value as the PATH of this process.

std::string	Executable
	The executable or shell command to run. This value should either be an absolute path, or it should be located in one of the locations in the PATH environment variable.

bool	IsShellCommand
	True if the executable is a shell command; False otherwise. Default: false.

api::MountList	Mounts
	The set of mounts to be applied for the child process. Only mounts with a HostMountSource type will be applied. All other mounts will be ignored. More...

std::string	PamProfile
	The PAM profile to load, if any. More...

std::string	Password
	The password of the user running the job, if any. More...

User	RunAsUser
	The user who the job should be run as. More...

std::string	StandardInput
	The standard input that should be sent to the process.

FilePath	StandardOutputFile
	The file to which to write standard output. If not set, standard output will not be redirected.

FilePath	StandardErrorFile
	The file to which to write standard error. If not set, standard error will not be redirected.

bool	UseSandbox
	Whether to use the rsandbox executable to launch the child in sandbox environment or launch the child process directly. More...

FilePath	WorkingDirectory
	The directory from which to run the process. Must exist and be accessible by the RunAsUser.

Detailed Description

Defines a process that can be run.

Member Data Documentation

◆ CloseStdIn

bool rstudio::launcher_plugins::system::process::ProcessOptions::CloseStdIn

Whether to close write end of the standard input stream after the specified StandardInput is written. Default: true.

If UseSandbox is true, this value will be ignored and treated as true.

◆ Mounts

api::MountList rstudio::launcher_plugins::system::process::ProcessOptions::Mounts

The set of mounts to be applied for the child process. Only mounts with a HostMountSource type will be applied. All other mounts will be ignored.

Mounts will be ignored if UseSandbox is false.

◆ PamProfile

std::string rstudio::launcher_plugins::system::process::ProcessOptions::PamProfile

The PAM profile to load, if any.

PamProfile will be ignored if UseSandbox is false.

◆ Password

std::string rstudio::launcher_plugins::system::process::ProcessOptions::Password

The password of the user running the job, if any.

Password will be ignored if UseSandbox is false.

◆ RunAsUser

User rstudio::launcher_plugins::system::process::ProcessOptions::RunAsUser

The user who the job should be run as.

The job may fail to run if the RunAsUser is empty.

◆ UseSandbox

bool rstudio::launcher_plugins::system::process::ProcessOptions::UseSandbox

Whether to use the rsandbox executable to launch the child in sandbox environment or launch the child process directly.

If this value is true, CloseStdIn will be ignored and treated as true.

The following values will be ignored if UseSandbox is false:

Mounts
PamProfile
Password

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

/var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/sdk/include/system/Process.hpp

Public Member Functions

Public Attributes