Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
drop_dataset_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
20
#include <
couchbase/common_options.hxx
>
21
#include <
couchbase/error_codes.hxx
>
22
23
#include <functional>
24
#include <optional>
25
#include <string>
26
27
namespace
couchbase
28
{
29
class
drop_dataset_analytics_options
:
public
common_options
<drop_dataset_analytics_options>
30
{
31
public
:
43
auto
ignore_if_not_exists
(
bool
ignore_if_not_exists
) ->
drop_dataset_analytics_options
&
44
{
45
ignore_if_not_exists_ =
ignore_if_not_exists
;
46
return
self
();
47
}
48
58
auto
dataverse_name
(std::string
dataverse_name
) ->
drop_dataset_analytics_options
&
59
{
60
dataverse_name_ = std::move(
dataverse_name
);
61
return
self
();
62
}
63
70
struct
built
:
public
common_options
<drop_dataset_analytics_options>
::built
{
71
bool
ignore_if_not_exists
{};
72
std::optional<std::string>
dataverse_name
{};
73
};
74
86
[[nodiscard]]
auto
build
() const ->
built
87
{
88
return
{
build_common_options
(), ignore_if_not_exists_, dataverse_name_ };
89
}
90
91
private
:
92
bool
ignore_if_not_exists_{
false
};
93
std::optional<std::string> dataverse_name_{};
94
};
95
102
using
drop_dataset_analytics_handler
= std::function<void(
error
)>;
103
}
// namespace couchbase
couchbase::common_options
Common options that used by most operations.
Definition
common_options.hxx:38
couchbase::common_options< drop_dataset_analytics_options >::self
auto self() -> drop_dataset_analytics_options &
Definition
common_options.hxx:116
couchbase::common_options< drop_dataset_analytics_options >::build_common_options
auto build_common_options() const -> built
Definition
common_options.hxx:103
couchbase::drop_dataset_analytics_options
Definition
drop_dataset_analytics_options.hxx:30
couchbase::drop_dataset_analytics_options::dataverse_name
auto dataverse_name(std::string dataverse_name) -> drop_dataset_analytics_options &
The name of the dataverse the dataset should be dropped from.
Definition
drop_dataset_analytics_options.hxx:58
couchbase::drop_dataset_analytics_options::ignore_if_not_exists
auto ignore_if_not_exists(bool ignore_if_not_exists) -> drop_dataset_analytics_options &
Ignore error if the dataset does not exist.
Definition
drop_dataset_analytics_options.hxx:43
couchbase::drop_dataset_analytics_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
drop_dataset_analytics_options.hxx:86
couchbase::error
Definition
error.hxx:31
common_options.hxx
error_codes.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::drop_dataset_analytics_handler
std::function< void(error)> drop_dataset_analytics_handler
The signature for the handler of the drop_dataset() operation.
Definition
drop_dataset_analytics_options.hxx:102
couchbase::drop_dataset_analytics_options::built
Immutable value object representing consistent options.
Definition
drop_dataset_analytics_options.hxx:70
couchbase::drop_dataset_analytics_options::built::dataverse_name
std::optional< std::string > dataverse_name
Definition
drop_dataset_analytics_options.hxx:72
couchbase::drop_dataset_analytics_options::built::ignore_if_not_exists
bool ignore_if_not_exists
Definition
drop_dataset_analytics_options.hxx:71
couchbase
drop_dataset_analytics_options.hxx
Generated by
1.17.0