lintel::PropertyApi Class Reference

#include <PropertyApi.h>

Public Member Functions
	PropertyApi (const std::shared_ptr< ClientProvider > &clientProvider)
std::vector< PropertyDto >	allOf (const std::string &processName, const std::string &className, const std::string &instanceName)
std::optional< PropertyDto >	of (const std::string &processName, const std::string &className, const std::string &instanceName, const std::string &propertyName)
bool	updateOf (const PropertyDto &propertyDto, const std::string &value)

Detailed Description

API client for property operations via HTTP

Constructor & Destructor Documentation

PropertyApi()

lintel::PropertyApi::PropertyApi ( const std::shared_ptr< ClientProvider > &  clientProvider )

explicit

Member Function Documentation

allOf()

std::vector< PropertyDto > lintel::PropertyApi::allOf	(	const std::string &	processName,
		const std::string &	className,
		const std::string &	instanceName
	)

Parameters

processName	process name filter
className	class name filter
instanceName	instance name filter

Returns

list of matching properties

of()

std::optional< PropertyDto > lintel::PropertyApi::of	(	const std::string &	processName,
		const std::string &	className,
		const std::string &	instanceName,
		const std::string &	propertyName
	)

Returns

single property matching the given criteria

updateOf()

bool lintel::PropertyApi::updateOf	(	const PropertyDto &	propertyDto,
		const std::string &	value
	)

Update a property value

Parameters

propertyDto	the property to update
value	the new value

Returns

true on success

---

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

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