rstudio::launcher_plugins::api::Container Struct Reference

Struct which represents the container to use when launching a containerized job. More...

#include <Job.hpp>

Public Member Functions
json::Object	toJson () const
	Converts this Container to a JSON object which represents it. More...

Static Public Member Functions
static Error	fromJson (const json::Object &in_json, Container &out_container)
	Constructs a Container from a JSON object which represents the container. More...

Public Attributes
std::string	Image
Optional< int >	RunAsUserId
Optional< int >	RunAsGroupId
std::vector< int >	SupplementalGroupIds

Detailed Description

Struct which represents the container to use when launching a containerized job.

Member Function Documentation

fromJson()

static Error rstudio::launcher_plugins::api::Container::fromJson ( const json::Object &  in_json, Container &  out_container  )

static

Constructs a Container from a JSON object which represents the container.

Parameters

in_json	The JSON object which represents the container.
out_container	The populated container value. Not valid if an error is returned.

Returns

Success if in_json could be parsed as a Container; Error otherwise.

toJson()

json::Object rstudio::launcher_plugins::api::Container::toJson

(

)

const

Converts this Container to a JSON object which represents it.

Returns

The JSON object which represents this Container.

Member Data Documentation

Image

std::string rstudio::launcher_plugins::api::Container::Image

The name of the image to use.

RunAsGroupId

Optional<int> rstudio::launcher_plugins::api::Container::RunAsGroupId

The optional group ID to run the container as.

RunAsUserId

Optional<int> rstudio::launcher_plugins::api::Container::RunAsUserId

The optional user ID to run the container as.

SupplementalGroupIds

std::vector<int> rstudio::launcher_plugins::api::Container::SupplementalGroupIds

The optional set of supplemental group IDs for the run-as user, to pass to the container on launch.

---

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

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