rstudio::launcher_plugins::api::ExposedPort Struct Reference

Struct which represents an exposed port on a containerized job. More...

#include <Job.hpp>

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

Static Public Member Functions
static Error	fromJson (const json::Object &in_json, ExposedPort &out_exposedPort)
	Constructs an ExposedPort from a JSON object which represents the exposed port. More...

Public Attributes
Optional< int >	PublishedPort
std::string	Protocol
int	TargetPort

Detailed Description

Struct which represents an exposed port on a containerized job.

Member Function Documentation

fromJson()

static Error rstudio::launcher_plugins::api::ExposedPort::fromJson ( const json::Object &  in_json, ExposedPort &  out_exposedPort  )

static

Constructs an ExposedPort from a JSON object which represents the exposed port.

Parameters

in_json	The JSON object which represents the exposed port.
out_exposedPort	The populated exposed port value. Not valid if an error is returned.

Returns

Success if in_json could be parsed as an ExposedPort; Error otherwise.

toJson()

json::Object rstudio::launcher_plugins::api::ExposedPort::toJson

(

)

const

Converts this ExposedPort to a JSON object which represents it.

Returns

The JSON object which represents this ExposedPort.

Member Data Documentation

Protocol

std::string rstudio::launcher_plugins::api::ExposedPort::Protocol

The protocol of the port.

PublishedPort

Optional<int> rstudio::launcher_plugins::api::ExposedPort::PublishedPort

The published port.

TargetPort

int rstudio::launcher_plugins::api::ExposedPort::TargetPort

The target port.

---

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