analytics_warning Class Reference

Represents a single warning returned from the analytics engine. More...

#include <couchbase/analytics_warning.hxx>

Public Member Functions
	analytics_warning ()=default
	analytics_warning (std::uint64_t code, std::string message)
auto	code () const -> std::uint64_t
	Error code.
auto	message () const -> const std::string &
	Error message.

Detailed Description

Represents a single warning returned from the analytics engine.

Note

warnings are not terminal errors but hints from the engine that something was not as expected.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

analytics_warning() [1/2]

analytics_warning ( )

default

Since

1.0.0

Internal

Internal interface

analytics_warning() [2/2]

analytics_warning ( std::uint64_t code, std::string message )

inline

Since

1.0.0

Volatile

Should not be used in production

Member Function Documentation

code()

auto code ( ) const->std::uint64_t

inlinenodiscard

Error code.

Returns

error code

Since

1.0.0

Committed

Generally available API and should be preferred in production

message()

auto message ( ) const->conststd::string &

inlinenodiscard

Error message.

Returns

human readable explanation

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/analytics_warning.hxx