Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
connect_link_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.hxx
>
22
#include <
couchbase/error_codes.hxx
>
23
24
#include <functional>
25
#include <optional>
26
#include <string>
27
28
namespace
couchbase
29
{
30
class
connect_link_analytics_options
:
public
common_options
<connect_link_analytics_options>
31
{
32
public
:
44
auto
dataverse_name
(std::string
dataverse_name
) ->
connect_link_analytics_options
&
45
{
46
dataverse_name_ = std::move(
dataverse_name
);
47
return
self
();
48
}
49
61
auto
link_name
(std::string
link_name
) ->
connect_link_analytics_options
&
62
{
63
link_name_ = std::move(
link_name
);
64
return
self
();
65
}
66
71
auto
force
(
bool
force
) ->
connect_link_analytics_options
&
72
{
73
force_ =
force
;
74
return
self
();
75
}
76
83
struct
built
:
public
common_options
<connect_link_analytics_options>
::built
{
84
std::optional<std::string>
dataverse_name
{};
85
std::optional<std::string>
link_name
{};
86
bool
force
{
false
};
87
};
88
100
[[nodiscard]]
auto
build
() const ->
built
101
{
102
return
{
build_common_options
(), dataverse_name_, link_name_, force_ };
103
}
104
105
private
:
106
bool
force_{
false
};
107
std::optional<std::string> dataverse_name_{};
108
std::optional<std::string> link_name_{};
109
};
110
117
using
connect_link_analytics_handler
= std::function<void(
error
)>;
118
}
// namespace couchbase
couchbase::common_options
Common options that used by most operations.
Definition
common_options.hxx:38
couchbase::common_options< connect_link_analytics_options >::self
auto self() -> connect_link_analytics_options &
Definition
common_options.hxx:116
couchbase::common_options< connect_link_analytics_options >::build_common_options
auto build_common_options() const -> built
Definition
common_options.hxx:103
couchbase::connect_link_analytics_options
Definition
connect_link_analytics_options.hxx:31
couchbase::connect_link_analytics_options::force
auto force(bool force) -> connect_link_analytics_options &
Whether to force link creation even if the bucket UUID changed, for example, due to the bucket being ...
Definition
connect_link_analytics_options.hxx:71
couchbase::connect_link_analytics_options::dataverse_name
auto dataverse_name(std::string dataverse_name) -> connect_link_analytics_options &
The name of the dataverse in which the link should be disconnected.
Definition
connect_link_analytics_options.hxx:44
couchbase::connect_link_analytics_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
connect_link_analytics_options.hxx:100
couchbase::connect_link_analytics_options::link_name
auto link_name(std::string link_name) -> connect_link_analytics_options &
The name of the link.
Definition
connect_link_analytics_options.hxx:61
couchbase::error
Definition
error.hxx:31
common_options.hxx
error.hxx
error_codes.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::connect_link_analytics_handler
std::function< void(error)> connect_link_analytics_handler
The signature for the handler of the connect_link() operation.
Definition
connect_link_analytics_options.hxx:117
couchbase::connect_link_analytics_options::built
Immutable value object representing consistent options.
Definition
connect_link_analytics_options.hxx:83
couchbase::connect_link_analytics_options::built::force
bool force
Definition
connect_link_analytics_options.hxx:86
couchbase::connect_link_analytics_options::built::dataverse_name
std::optional< std::string > dataverse_name
Definition
connect_link_analytics_options.hxx:84
couchbase::connect_link_analytics_options::built::link_name
std::optional< std::string > link_name
Definition
connect_link_analytics_options.hxx:85
couchbase
connect_link_analytics_options.hxx
Generated by
1.17.0