Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
query_warning.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2020-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
20#include <cstdint>
21#include <optional>
22#include <string>
23
24namespace couchbase
25{
26
37{
38public:
43 query_warning() = default;
44
49 query_warning(std::uint64_t code,
50 std::string message,
51 std::optional<std::uint64_t> reason,
52 std::optional<bool> retry)
53 : code_{ code }
54 , message_{ std::move(message) }
55 , reason_{ std::move(reason) }
56 , retry_{ std::move(retry) }
57 {
58 }
59
68 [[nodiscard]] auto code() const -> std::uint64_t
69 {
70 return code_;
71 }
72
81 [[nodiscard]] auto message() const -> const std::string&
82 {
83 return message_;
84 }
85
94 [[nodiscard]] auto reason() const -> const std::optional<std::uint64_t>&
95 {
96 return reason_;
97 }
98
107 [[nodiscard]] auto retry() const -> const std::optional<bool>&
108 {
109 return retry_;
110 }
111
112private:
113 std::uint64_t code_{};
114 std::string message_{};
115 std::optional<std::uint64_t> reason_{};
116 std::optional<bool> retry_{};
117};
118
119} // namespace couchbase
Represents a single warning returned from the query engine.
Definition query_warning.hxx:37
auto code() const -> std::uint64_t
Error code.
Definition query_warning.hxx:68
auto retry() const -> const std::optional< bool > &
Optional flag that indicates whether the request should be retried.
Definition query_warning.hxx:107
auto reason() const -> const std::optional< std::uint64_t > &
Optional reason code that clarifies the error code.
Definition query_warning.hxx:94
auto message() const -> const std::string &
Error message.
Definition query_warning.hxx:81
query_warning(std::uint64_t code, std::string message, std::optional< std::uint64_t > reason, std::optional< bool > retry)
Definition query_warning.hxx:49
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28