couchbase_remote_analytics_link Struct Reference

#include <couchbase/management/analytics_link.hxx>

Inheritance diagram for couchbase_remote_analytics_link:

Public Member Functions
auto	link_type () const -> analytics_link_type override
	Returns the type of this analytics link.
	couchbase_remote_analytics_link ()=default
	Constructs an empty remote Couchbase analytics link.
	couchbase_remote_analytics_link (std::string name, std::string dataverse_name, std::string hostname, couchbase_analytics_encryption_settings encryption={}, std::optional< std::string > username={}, std::optional< std::string > password={})
	Constructs and initializes a remote Couchbase analytics link with the given parameters.
Public Member Functions inherited from analytics_link
virtual	~analytics_link ()=default
	analytics_link ()=default
	analytics_link (std::string name, std::string dataverse_name)

Public Attributes
std::string	hostname
couchbase_analytics_encryption_settings	encryption {}
std::optional< std::string >	username {}
std::optional< std::string >	password {}
Public Attributes inherited from analytics_link
std::string	name
std::string	dataverse_name

Constructor & Destructor Documentation

couchbase_remote_analytics_link() [1/2]

couchbase_remote_analytics_link ( )

default

Constructs an empty remote Couchbase analytics link.

Since

1.0.0

Committed

Generally available API and should be preferred in production

couchbase_remote_analytics_link() [2/2]

couchbase_remote_analytics_link	(	std::string	name,
		std::string	dataverse_name,
		std::string	hostname,
		couchbase_analytics_encryption_settings	encryption = {},
		std::optional< std::string >	username = {},
		std::optional< std::string >	password = {} )

Constructs and initializes a remote Couchbase analytics link with the given parameters.

A remote analytics link uses a Couchbase data service that is not part of the same cluster as the Analytics service.

Parameters

name	the name of the link
dataverse_name	the dataverse that the link belongs to. Its format can be one part dataversename or two parts bucket_name/scope_name
hostname	the hostname of the target Couchbase cluster
encryption	the encryption settings for the link
username	the username to use for authentication with the remote cluster. Optional if client certificate authentication is being used
password	the password to use for authentication with the remote cluster. Optional if client-certificate authentication is being used

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

link_type()

auto link_type ( ) const -> analytics_link_type

inlinenodiscardoverridevirtual

Returns the type of this analytics link.

Returns

the link type

Implements analytics_link.

Member Data Documentation

encryption

couchbase_analytics_encryption_settings encryption {}

hostname

std::string hostname

password

std::optional<std::string> password {}

username

std::optional<std::string> username {}

---

The documentation for this struct was generated from the following file:

• couchbase/management/analytics_link.hxx