ping_result Class Reference

#include <couchbase/ping_result.hxx>

Public Member Functions
	ping_result ()=default
	ping_result (std::string id, std::uint16_t version, std::string sdk, std::map< service_type, std::vector< endpoint_ping_report > > endpoints)
auto	id () const -> std::string
	Returns the ID of this report.
auto	version () const -> std::uint16_t
	Returns the version of this report (useful when exporting to JSON).
auto	sdk () const -> std::string
	Returns the identifier of this SDK (useful when exporting to JSON).
auto	endpoints () const -> std::map< service_type, std::vector< endpoint_ping_report > >
	Returns the ping reports for each individual endpoint, organised by service type.
auto	as_json () const -> std::string
	Exports the ping report as JSON.

Constructor & Destructor Documentation

ping_result() [1/2]

ping_result ( )

default

Since

1.0.0

Internal

Internal interface

ping_result() [2/2]

ping_result ( std::string id, std::uint16_t version, std::string sdk, std::map< service_type, std::vector< endpoint_ping_report > > endpoints )

inline

Since

1.0.0

Internal

Internal interface

Member Function Documentation

as_json()

auto as_json ( ) const -> std::string

nodiscard

Exports the ping report as JSON.

Returns

the JSON report.

endpoints()

auto endpoints ( ) const -> std::map<service_type, std::vector<endpoint_ping_report>>

inlinenodiscard

Returns the ping reports for each individual endpoint, organised by service type.

Returns

the service type to ping reports map.

Since

1.0.0

Committed

Generally available API and should be preferred in production

id()

auto id ( ) const -> std::string

inlinenodiscard

Returns the ID of this report.

Returns

the report ID.

Since

1.0.0

Committed

Generally available API and should be preferred in production

sdk()

auto sdk ( ) const -> std::string

inlinenodiscard

Returns the identifier of this SDK (useful when exporting to JSON).

Returns

the SDK identifier.

Since

1.0.0

Committed

Generally available API and should be preferred in production

version()

auto version ( ) const -> std::uint16_t

inlinenodiscard

Returns the version of this report (useful when exporting to JSON).

Returns

the report version.

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/ping_result.hxx