Represents a single warning returned from the query engine.
More...
#include <couchbase/query_warning.hxx>
|
| query_warning ()=default |
|
| query_warning (std::uint64_t code, std::string message, std::optional< std::uint64_t > reason, std::optional< bool > retry) |
|
auto | code () const -> std::uint64_t |
| Error code.
|
|
auto | message () const -> const std::string & |
| Error message.
|
|
auto | reason () const -> const std::optional< std::uint64_t > & |
| Optional reason code that clarifies the error code.
|
|
auto | retry () const -> const std::optional< bool > & |
| Optional flag that indicates whether the request should be retried.
|
|
Represents a single warning returned from the query 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
◆ query_warning() [1/2]
◆ query_warning() [2/2]
query_warning |
( |
std::uint64_t | code, |
|
|
std::string | message, |
|
|
std::optional< std::uint64_t > | reason, |
|
|
std::optional< bool > | retry ) |
|
inline |
- Since
- 1.0.0
- Volatile
- Should not be used in production
◆ 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 -> const std::string&
|
|
inlinenodiscard |
Error message.
- Returns
- human readable explanation
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ reason()
auto reason |
( |
| ) |
const -> const std::optional<std::uint64_t>&
|
|
inlinenodiscard |
Optional reason code that clarifies the error code.
- Returns
- clarification of the error code
- Since
- 1.0.0
- Internal
- Internal interface
◆ retry()
auto retry |
( |
| ) |
const -> const std::optional<bool>&
|
|
inlinenodiscard |
Optional flag that indicates whether the request should be retried.
- Returns
- non empty optional with
true
if the server requested retry.
- Since
- 1.0.0
- Internal
- Internal interface
The documentation for this class was generated from the following file: