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::CephFsMountSource Struct Referencefinal

Represents a Ceph File System Mount Source. More...

#include <Job.hpp>

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

Public Member Functions

std::vector< std::string > getMonitors () const
 Gets the list of Ceph monitor addresses. More...
 
std::string getPath () const
 Gets the path to mount. More...
 
std::string getUser () const
 Gets the user to mount the path as. More...
 
std::string getSecretFile () const
 Gets the location of the file which contains the Ceph keyring for authentication. More...
 
std::string getSecretRef () const
 Gets the reference to the Ceph authentication secrets which override the Secret File. 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, CephFsMountSource &out_mountSource)
 Constructs a CephFsMountSource 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 Ceph File System Mount Source.

Member Function Documentation

◆ fromJson()

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

Constructs a CephFsMountSource 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 CephFsMountSource; Error otherwise.

◆ getMonitors()

std::vector<std::string> rstudio::launcher_plugins::api::CephFsMountSource::getMonitors ( ) const

Gets the list of Ceph monitor addresses.

Exceptions
std::logic_errorif the 'monitors' field cannot be found.
Returns
The list of Ceph monitor addresses.

◆ getPath()

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

Gets the path to mount.

Returns
The path to mount.

◆ getSecretFile()

std::string rstudio::launcher_plugins::api::CephFsMountSource::getSecretFile ( ) const

Gets the location of the file which contains the Ceph keyring for authentication.

Returns
The location of the file which contains the Ceph keyring for authentication.

◆ getSecretRef()

std::string rstudio::launcher_plugins::api::CephFsMountSource::getSecretRef ( ) const

Gets the reference to the Ceph authentication secrets which override the Secret File.

Returns
The reference to the Ceph authentication secrets which override the Secret File.

◆ getUser()

std::string rstudio::launcher_plugins::api::CephFsMountSource::getUser ( ) const

Gets the user to mount the path as.

Returns
The user to mount the path as.

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