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

Class which represents a job state response which can be sent to the Launcher in response to a get or submit job request. More...

#include <Response.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::JobStateResponse:
rstudio::launcher_plugins::api::Response rstudio::launcher_plugins::Noncopyable

Public Member Functions

 JobStateResponse (uint64_t in_requestId, JobList in_jobs, Optional< std::set< std::string > > in_jobFields=Optional< std::set< std::string > >())
 Constructor. More...
 
json::Object toJson () const override
 Converts this job state response to a JSON object. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::api::Response
virtual ~Response ()=default
 Virtual destructor to allow for inheritance.
 
- 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.
 

Additional Inherited Members

- Protected Types inherited from rstudio::launcher_plugins::api::Response
enum  Type {
  Type::ERROR = -1, Type::HEARTBEAT = 0, Type::BOOTSTRAP = 1, Type::JOB_STATE = 2,
  Type::JOB_STATUS = 3, Type::CONTROL_JOB = 4, Type::JOB_OUTPUT = 5, Type::JOB_RESOURCE_UTIL = 6,
  Type::JOB_NETWORK = 7, Type::CLUSTER_INFO = 8
}
 
- Protected Member Functions inherited from rstudio::launcher_plugins::api::Response
 Response (Type in_responseType, uint64_t in_requestId)
 Constructor. More...
 

Detailed Description

Class which represents a job state response which can be sent to the Launcher in response to a get or submit job request.

Constructor & Destructor Documentation

◆ JobStateResponse()

rstudio::launcher_plugins::api::JobStateResponse::JobStateResponse ( uint64_t  in_requestId,
JobList  in_jobs,
Optional< std::set< std::string > >  in_jobFields = Optional< std::set< std::string > >() 
)

Constructor.

Parameters
in_requestIdThe ID of the request for which this job state response is being sent.
in_jobsThe jobs to be returned to the Launcher.
in_jobFieldsThe optional set of job fields to include for each job. If this is not set, all fields will be returned.

Member Function Documentation

◆ toJson()

json::Object rstudio::launcher_plugins::api::JobStateResponse::toJson ( ) const
overridevirtual

Converts this job state response to a JSON object.

Returns
The JSON object which represents this job state response.

Reimplemented from rstudio::launcher_plugins::api::Response.


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