Request from the launcher to begin or end a Job Output Stream. More...
#include <Request.hpp>
Inheritance diagram for rstudio::launcher_plugins::api::OutputStreamRequest:
Public Member Functions | |
| OutputType | getStreamType () const |
| Gets the type of Output that should be streamed. More... | |
| bool | isCancelRequest () const |
| Gets whether the Job Output Stream should be started (false) or ended (true). 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. | |
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::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
Member Function Documentation
◆ getStreamType()
| OutputType rstudio::launcher_plugins::api::OutputStreamRequest::getStreamType | ( | ) | const |
Gets the type of Output that should be streamed.
- Returns
- The type of Output that should be streamed.
◆ isCancelRequest()
| bool rstudio::launcher_plugins::api::OutputStreamRequest::isCancelRequest | ( | ) | const |
Gets whether the Job Output Stream should be started (false) or ended (true).
- Returns
- True if the stream should be canceled; false if it should be started.
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
