lintel::ProcessApi Class Reference

#include <ProcessApi.h>

Public Member Functions
	ProcessApi (const std::shared_ptr< ClientProvider > &clientProvicer)
std::vector< ProcessInfoDto >	allOf (const std::string &processName)
std::vector< ProcessGroupDto >	allGroupsOf (const std::string &groupName)
void	startOf (const std::shared_ptr< Process > &process)
void	stopOf (const std::string &id)
void	terminateOf (const std::string &id)
void	restartOf (const std::string &id)
void	resetOf (const std::string &id)
std::optional< ProcessInfoDto >	healthOf (const std::string &id)

Detailed Description

API client for process management via HTTP

Constructor & Destructor Documentation

ProcessApi()

lintel::ProcessApi::ProcessApi ( const std::shared_ptr< ClientProvider > &  clientProvicer )

explicit

Member Function Documentation

allGroupsOf()

std::vector< ProcessGroupDto > lintel::ProcessApi::allGroupsOf

(

const std::string &

groupName

)

Parameters

groupName

name filter; return all matching process groups

allOf()

std::vector< ProcessInfoDto > lintel::ProcessApi::allOf

(

const std::string &

processName

)

Parameters

processName

name filter; return all matching processes

healthOf()

std::optional< ProcessInfoDto > lintel::ProcessApi::healthOf

(

const std::string &

id

)

Query the resource/health snapshot of a process by ID

Parameters

id	the process ID

Returns

the process info DTO (with resource data), or nullopt if unavailable

resetOf()

void lintel::ProcessApi::resetOf

(

const std::string &

id

)

Reset the restart counter and failure state of a process by ID

restartOf()

void lintel::ProcessApi::restartOf

(

const std::string &

id

)

Restart a process by ID

startOf()

void lintel::ProcessApi::startOf

(

const std::shared_ptr< Process > &

process

)

Start a process

stopOf()

void lintel::ProcessApi::stopOf

(

const std::string &

id

)

Stop a process by ID

terminateOf()

void lintel::ProcessApi::terminateOf

(

const std::string &

id

)

Terminate a process by ID

---

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

• src/include/lintel/features/http/controllers/ProcessApi.h