azure_blob_external_analytics_link Struct Reference

#include <couchbase/management/analytics_link.hxx>

Inheritance diagram for azure_blob_external_analytics_link:

Public Member Functions
auto	link_type () const -> analytics_link_type override
	Returns the type of this analytics link.
	azure_blob_external_analytics_link ()=default
	Constructs an empty external Azure blob analytics link.
	azure_blob_external_analytics_link (std::string name, std::string dataverse_name, std::optional< std::string > connection_string={}, std::optional< std::string > account_name={}, std::optional< std::string > account_key={}, std::optional< std::string > shared_access_signature={}, std::optional< std::string > blob_endpoint={}, std::optional< std::string > endpoint_suffix={})
	Constructs and initializes an external Azure blob analytics link.
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::optional< std::string >	connection_string {}
std::optional< std::string >	account_name {}
std::optional< std::string >	account_key {}
std::optional< std::string >	shared_access_signature {}
std::optional< std::string >	blob_endpoint {}
std::optional< std::string >	endpoint_suffix {}
Public Attributes inherited from analytics_link
std::string	name
std::string	dataverse_name

Constructor & Destructor Documentation

azure_blob_external_analytics_link() [1/2]

azure_blob_external_analytics_link ( )

default

Constructs an empty external Azure blob analytics link.

Committed

Generally available API and should be preferred in production

Since

1.0.0

azure_blob_external_analytics_link() [2/2]

azure_blob_external_analytics_link	(	std::string	name,
		std::string	dataverse_name,
		std::optional< std::string >	connection_string = {},
		std::optional< std::string >	account_name = {},
		std::optional< std::string >	account_key = {},
		std::optional< std::string >	shared_access_signature = {},
		std::optional< std::string >	blob_endpoint = {},
		std::optional< std::string >	endpoint_suffix = {} )

Constructs and initializes an external Azure blob analytics link.

Parameters

name	the name of the link
dataverse_name	the name of the dataverse the link belongs to
connection_string	the connection string that can be used as an authentication method. It contains other authentication methods embedded inside the string. Only a single authentication method can be used (e.g. "AccountName=myAccountName;AccountKey=myAccountKey").
account_name	the Azure blob storage account name
account_key	the Azure blob storage account key
shared_access_signature	token that can be used for authentication
blob_endpoint	the Azure blob storage endpoint
endpoint_suffix	the Azure blob endpoint suffix

Committed

Generally available API and should be preferred in production

Since

1.0.0

Member Function Documentation

link_type()

auto link_type ( ) const -> analytics_link_type

inlineoverridevirtual

Returns the type of this analytics link.

Returns

the link type

Implements analytics_link.

Member Data Documentation

account_key

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

account_name

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

blob_endpoint

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

connection_string

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

endpoint_suffix

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

shared_access_signature

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

---

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

• couchbase/management/analytics_link.hxx