rstudio::launcher_plugins::api::ControlJobResponse Class Reference

Class which represents the result of a control job operation. More...

#include <Response.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::ControlJobResponse:

Public Member Functions
	ControlJobResponse (uint64_t in_requestId, std::string in_statusMessage, bool in_isComplete)
	Constructor. More...
json::Object	toJson () const override
	Converts this control job 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.
Noncopyable &	operator= (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 the result of a control job operation.

Constructor & Destructor Documentation

ControlJobResponse()

rstudio::launcher_plugins::api::ControlJobResponse::ControlJobResponse	(	uint64_t	in_requestId,
		std::string	in_statusMessage,
		bool	in_isComplete
	)

Constructor.

Parameters

in_requestId	The ID of the request for which this response is being sent.
in_statusMessage	A message describing the status of the control job operation that was requested.
in_isComplete	Whether the request control job operation has completed (true) or not (false).

Member Function Documentation

toJson()

json::Object rstudio::launcher_plugins::api::ControlJobResponse::toJson ( ) const

overridevirtual

Converts this control job response to a JSON object.

Returns

The JSON object which represents this control job response.

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

---

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

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