Couchbase C++ SDK 1.0.1 (rev. 58d46d7)
Loading...
Searching...
No Matches
create_index_analytics_options.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 2023-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
22
23#include <functional>
24#include <optional>
25#include <string>
26
27namespace couchbase
28{
29class create_index_analytics_options : public common_options<create_index_analytics_options>
30{
31public:
44 {
45 ignore_if_exists_ = ignore_if_exists;
46 return self();
47 }
48
59 {
60 dataverse_name_ = std::move(dataverse_name);
61 return self();
62 }
63
70 struct built : public common_options<create_index_analytics_options>::built {
72 std::optional<std::string> dataverse_name{};
73 };
74
86 [[nodiscard]] auto build() const -> built
87 {
88 return { build_common_options(), ignore_if_exists_, dataverse_name_ };
89 }
90
91private:
92 bool ignore_if_exists_{ false };
93 std::optional<std::string> dataverse_name_{};
94};
95
102using create_index_analytics_handler = std::function<void(error)>;
103} // namespace couchbase
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> create_index_analytics_options &
Allows to return the right options builder instance for child implementations.
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Definition create_index_analytics_options.hxx:30
auto dataverse_name(std::string dataverse_name) -> create_index_analytics_options &
The name of the dataverse the index should be created into.
Definition create_index_analytics_options.hxx:58
auto build() const -> built
Validates options and returns them as an immutable value.
Definition create_index_analytics_options.hxx:86
auto ignore_if_exists(bool ignore_if_exists) -> create_index_analytics_options &
Ignore error if the index already exists.
Definition create_index_analytics_options.hxx:43
Definition error.hxx:30
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error)> create_index_analytics_handler
The signature for the handler of the analytics_index_manager::create_index() operation.
Definition create_index_analytics_options.hxx:102
Immutable value object representing consistent options.
Definition create_index_analytics_options.hxx:70
std::optional< std::string > dataverse_name
Definition create_index_analytics_options.hxx:72
bool ignore_if_exists
Definition create_index_analytics_options.hxx:71