RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Static Public Member Functions | Friends | List of all members
rstudio::launcher_plugins::api::HostMountSource Struct Referencefinal

Represents a path to mount on the same host as the Job. More...

#include <Job.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::HostMountSource:
rstudio::launcher_plugins::api::MountSource

Public Member Functions

std::string getPath () const
 Gets the path on the current host to be mounted. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::api::MountSource
virtual ~MountSource ()=default
 Virtual destructor for inheritance.
 
AzureFileMountSourceasAzureFileMountSource ()
 Gets this MountSource as an AzureFileMountSource. More...
 
const AzureFileMountSourceasAzureFileMountSource () const
 Gets this MountSource as an AzureFileMountSource. More...
 
CephFsMountSourceasCephFsMountSource ()
 Gets this MountSource as an CephFsMountSource. More...
 
const CephFsMountSourceasCephFsMountSource () const
 Gets this MountSource as an CephFsMountSource. More...
 
GlusterFsMountSourceasGlusterFsMountSource ()
 Gets this MountSource as an GlusterFsMountSource. More...
 
const GlusterFsMountSourceasGlusterFsMountSource () const
 Gets this MountSource as an GlusterFsMountSource. More...
 
HostMountSourceasHostMountSource ()
 Gets this MountSource as an HostMountSource. More...
 
const HostMountSourceasHostMountSource () const
 Gets this MountSource as an HostMountSource. More...
 
NfsMountSourceasNfsMountSource ()
 Gets this MountSource as an NfsMountSource. More...
 
const NfsMountSourceasNfsMountSource () const
 Gets this MountSource as an NfsMountSource. More...
 
bool isAzureFileMountSource () const
 Checks whether this MountSource is an AzureFileMountSource. More...
 
bool isCephFsMountSource () const
 Checks whether this MountSource is an CephFsMountSource. More...
 
bool isGlusterFsMountSource () const
 Checks whether this MountSource is an GlusterFsMountSource. More...
 
bool isHostMountSource () const
 Checks whether this MountSource is an HostMountSource. More...
 
bool isNfsMountSource () const
 Checks whether this MountSource is an NfsMountSource. More...
 
bool isPassthroughMountSource () const
 Checks whether this MountSource is an PassthroughMountSource. More...
 
json::Object toJson () const
 Converts this NfsMountSource to a JSON object which represents it. More...
 

Static Public Member Functions

static Error fromJson (const json::Object &in_json, HostMountSource &out_mountSource)
 Constructs a HostMountSource from a JSON object which represents the mount source. More...
 
- Static Public Member Functions inherited from rstudio::launcher_plugins::api::MountSource
static Error fromJson (const json::Object &in_json, MountSource &out_mountSource)
 Constructs a MountSource from a JSON object which represents the mount source. More...
 

Friends

class MountSource
 

Additional Inherited Members

- Public Types inherited from rstudio::launcher_plugins::api::MountSource
enum  Type {
  Type::AZURE_FILE, Type::CEPH_FS, Type::GLUSTER_FS, Type::HOST,
  Type::NFS, Type::PASSTHROUGH
}
 Constants representing the support types of MountSource. More...
 
- Public Attributes inherited from rstudio::launcher_plugins::api::MountSource
std::string CustomType
 
json::Object SourceObject
 
Type SourceType
 

Detailed Description

Represents a path to mount on the same host as the Job.

Member Function Documentation

◆ fromJson()

static Error rstudio::launcher_plugins::api::HostMountSource::fromJson ( const json::Object in_json,
HostMountSource out_mountSource 
)
static

Constructs a HostMountSource from a JSON object which represents the mount source.

Parameters
in_jsonThe JSON object which represents the mount source.
out_mountSourceThe populated mount source value. Not valid if an error is returned.
Returns
Success if in_json could be parsed as a HostMountSource; Error otherwise.

◆ getPath()

std::string rstudio::launcher_plugins::api::HostMountSource::getPath ( ) const

Gets the path on the current host to be mounted.

Exceptions
std::logic_errorif the 'path' field cannot be found.
Returns
The path on the current host to be mounted.

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