senzing::sdk::SzDiagnostic Class Reference

Diagnostic operations against the Senzing repository. More...

#include <SzDiagnostic.hpp>

Inheritance diagram for senzing::sdk::SzDiagnostic:

Public Member Functions
virtual	~SzDiagnostic ()=default
virtual std::string	GetRepositoryInfo ()=0
	Returns JSON describing the repository (datastore) configuration/state.
virtual std::string	CheckRepositoryPerformance (int32_t secondsToRun)=0
	Runs a timed repository performance check for secondsToRun seconds and returns the resulting JSON.
virtual void	PurgeRepository ()=0
	Purges all records from the repository. Irreversible.
virtual std::string	GetFeature (int64_t featureID)=0
	Returns JSON describing the feature identified by featureID.

Detailed Description

Diagnostic operations against the Senzing repository.

Constructor & Destructor Documentation

~SzDiagnostic()

virtual senzing::sdk::SzDiagnostic::~SzDiagnostic ( )

virtualdefault

Member Function Documentation

CheckRepositoryPerformance()

virtual std::string senzing::sdk::SzDiagnostic::CheckRepositoryPerformance ( int32_t  secondsToRun )

pure virtual

Runs a timed repository performance check for secondsToRun seconds and returns the resulting JSON.

Implemented in senzing::sdk::core::SzCoreDiagnostic.

GetFeature()

virtual std::string senzing::sdk::SzDiagnostic::GetFeature ( int64_t  featureID )

pure virtual

Returns JSON describing the feature identified by featureID.

[SzConfigRetryable]

Implemented in senzing::sdk::core::SzCoreDiagnostic.

GetRepositoryInfo()

virtual std::string senzing::sdk::SzDiagnostic::GetRepositoryInfo ( )

pure virtual

Returns JSON describing the repository (datastore) configuration/state.

Implemented in senzing::sdk::core::SzCoreDiagnostic.

PurgeRepository()

virtual void senzing::sdk::SzDiagnostic::PurgeRepository ( )

pure virtual

Purges all records from the repository. Irreversible.

Implemented in senzing::sdk::core::SzCoreDiagnostic.

---

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

• senzing/sdk/SzDiagnostic.hpp