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

Represents a bootstrap request received from the Launcher. More...

#include <Request.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::BootstrapRequest:
rstudio::launcher_plugins::api::Request rstudio::launcher_plugins::Noncopyable

Public Member Functions

int getMajorVersion () const
 Gets the major version of the RStudio Launcher that sent this bootstrap request. More...
 
int getMinorVersion () const
 Gets the minor version of the RStudio Launcher that sent this bootstrap request. More...
 
int getPatchNumber () const
 Gets the patch number of the RStudio Launcher that sent this bootstrap request. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::api::Request
virtual ~Request ()=default
 Virtual destructor for inheritance.
 
uint64_t getId () const
 Gets the ID of this request. More...
 
Type getType () const
 Gets the request type. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable
 Noncopyable ()=default
 Default constructor.
 
 Noncopyable (const Noncopyable &)=delete
 Deleted copy constructor.
 
Noncopyableoperator= (const Noncopyable &)=delete
 Deleted assignment operator.
 

Friends

class Request
 

Additional Inherited Members

- Public Types inherited from rstudio::launcher_plugins::api::Request
enum  Type {
  Type::HEARTBEAT = 0, Type::BOOTSTRAP = 1, Type::SUBMIT_JOB = 2, Type::GET_JOB = 3,
  Type::GET_JOB_STATUS = 4, Type::CONTROL_JOB = 5, Type::GET_JOB_OUTPUT = 6, Type::GET_JOB_RESOURCE_UTIL = 7,
  Type::GET_JOB_NETWORK = 8, Type::GET_CLUSTER_INFO = 9, Type::INVALID
}
 
- Static Public Member Functions inherited from rstudio::launcher_plugins::api::Request
static Error fromJson (const json::Object &in_requestJson, std::shared_ptr< Request > &out_request)
 Converts a Json::Object into the appropriate Request object. More...
 
- Protected Member Functions inherited from rstudio::launcher_plugins::api::Request
 Request (Type in_requestType, const json::Object &in_requestJson)
 Constructor. More...
 
 PRIVATE_IMPL (m_baseImpl)
 

Detailed Description

Represents a bootstrap request received from the Launcher.

Member Function Documentation

◆ getMajorVersion()

int rstudio::launcher_plugins::api::BootstrapRequest::getMajorVersion ( ) const

Gets the major version of the RStudio Launcher that sent this bootstrap request.

Returns
The major version of the RStudio Launcher.

◆ getMinorVersion()

int rstudio::launcher_plugins::api::BootstrapRequest::getMinorVersion ( ) const

Gets the minor version of the RStudio Launcher that sent this bootstrap request.

Returns
The minor version of the RStudio Launcher.

◆ getPatchNumber()

int rstudio::launcher_plugins::api::BootstrapRequest::getPatchNumber ( ) const

Gets the patch number of the RStudio Launcher that sent this bootstrap request.

Returns
The patch number of the RStudio Launcher.

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