Represents an Azure File Mount Source. More...

#include <Job.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::AzureFileMountSource:

Public Member Functions
std::string	getSecretName () const
	Gets the name of the Azure Secret used to connect to the Azure File Mount Source. More...

std::string	getShareName () const
	Gets the name of the share in Azure to be mounted. More...

Public Member Functions inherited from rstudio::launcher_plugins::api::MountSource
virtual	~MountSource ()=default
	Virtual destructor for inheritance.

AzureFileMountSource &	asAzureFileMountSource ()
	Gets this MountSource as an AzureFileMountSource. More...

const AzureFileMountSource &	asAzureFileMountSource () const
	Gets this MountSource as an AzureFileMountSource. More...

CephFsMountSource &	asCephFsMountSource ()
	Gets this MountSource as an CephFsMountSource. More...

const CephFsMountSource &	asCephFsMountSource () const
	Gets this MountSource as an CephFsMountSource. More...

GlusterFsMountSource &	asGlusterFsMountSource ()
	Gets this MountSource as an GlusterFsMountSource. More...

const GlusterFsMountSource &	asGlusterFsMountSource () const
	Gets this MountSource as an GlusterFsMountSource. More...

HostMountSource &	asHostMountSource ()
	Gets this MountSource as an HostMountSource. More...

const HostMountSource &	asHostMountSource () const
	Gets this MountSource as an HostMountSource. More...

NfsMountSource &	asNfsMountSource ()
	Gets this MountSource as an NfsMountSource. More...

const NfsMountSource &	asNfsMountSource () 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, AzureFileMountSource &out_mountSource)
	Constructs an AzureMountSource 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 an Azure File Mount Source.

Member Function Documentation

◆ fromJson()

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

static

Constructs an AzureMountSource from a JSON object which represents the mount source.

Parameters

in_json	The JSON object which represents the mount source.
out_mountSource	The populated mount source value. Not valid if an error is returned.

Returns: Success if in_json could be parsed as an AzureMountSource; Error otherwise.

◆ getSecretName()

std::string rstudio::launcher_plugins::api::AzureFileMountSource::getSecretName ( ) const

Gets the name of the Azure Secret used to connect to the Azure File Mount Source.

Exceptions

std::logic_error if the 'secretName' field cannot be found.

Returns: The name of the Azure Secret used to connect to the Azure File Mount Source.

◆ getShareName()

std::string rstudio::launcher_plugins::api::AzureFileMountSource::getShareName ( ) const

Gets the name of the share in Azure to be mounted.

Exceptions

std::logic_error if the 'shareName' field cannot be found.

Returns: The name of the share in Azure to be mounted.

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

/var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/sdk/include/api/Job.hpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ fromJson()

◆ getSecretName()

◆ getShareName()