Request from the launcher to control the state of a Job. More...

#include <Request.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::ControlJobRequest:

Public Types
enum	Operation { Operation::FIRST = 0, SUSPEND = 0, Operation::RESUME = 1, Operation::STOP = 2, Operation::KILL = 3, Operation::CANCEL = 4, Operation::INVALID }

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 }

Public Member Functions
Operation	getOperation () const
	Gets the control job action which should be taken. More...

Public Member Functions inherited from rstudio::launcher_plugins::api::JobIdRequest
const std::string &	getJobId () const
	Gets the ID of the job for which this request was made. More...

const std::string &	getEncodedJobId () const
	Gets the ID of the job for which this request was made. More...

Public Member Functions inherited from rstudio::launcher_plugins::api::UserRequest
const system::User &	getUser () const
	Gets the user who initiated this request. More...

const std::string &	getRequestUsername () const
	Gets the actual username that was used when the request was submitted. 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.

Noncopyable &	operator= (const Noncopyable &)=delete
	Deleted assignment operator.

Additional Inherited Members
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::JobIdRequest
	JobIdRequest (Request::Type in_type, const json::Object &in_requestJson)
	Constructor. More...

Protected Member Functions inherited from rstudio::launcher_plugins::api::UserRequest
	UserRequest (Request::Type in_type, const json::Object &in_requestJson)
	Constructor. 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

Request from the launcher to control the state of a Job.

Member Enumeration Documentation

strong

Enumerator
FIRST	Indicates that the job should be suspended. This operation should be equivalent to sending SIGSTOP.
RESUME	Indicates that the job should be resumed. This operation should be equivalent to sending SIGCONT.
STOP	Indicates that the job should be stopped. This operation should be equivalent to sending SIGTERM.
KILL	Indicates that the job should be killed. This operation should be equivalent to sending SIGKILL.
CANCEL	Indicates that a pending job should be canceled, if possible.
INVALID	This value must always be last for input validation purposes.

Operation rstudio::launcher_plugins::api::ControlJobRequest::getOperation ( ) const

Gets the control job action which should be taken.

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

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