CouchbaseRemoteAnalyticsLink
extends AnalyticsLink
in package
Table of Contents
- $dataverseName : string
- $encryption : CouchbaseAnalyticsEncryptionSettings|null
- $hostname : string
- $name : string
- $password : string|null
- $username : string|null
- __construct() : mixed
- build() : CouchbaseRemoteAnalyticsLink
- Static helper to keep code more readable
- dataverseName() : string
- Gets the name of the dataverse to which this link belongs to.
- linkType() : string
- Gets the link type. One of "couchbase", "s3" or "azureblob"
- name() : string
- Gets the name of the link
- setEncryption() : CouchbaseRemoteAnalyticsLink
- Sets settings for connection encryption
- setPassword() : CouchbaseRemoteAnalyticsLink
- Sets the password to use for authentication with the remote cluster.
- setUsername() : CouchbaseRemoteAnalyticsLink
- Sets the username to use for authentication with the remote cluster.
Properties
$dataverseName
private
string
$dataverseName
$encryption
private
CouchbaseAnalyticsEncryptionSettings|null
$encryption
= null
$hostname
private
string
$hostname
$name
private
string
$name
$password
private
string|null
$password
= null
$username
private
string|null
$username
= null
Methods
__construct()
public
__construct(string $name, string $dataverseName, string $hostname) : mixed
Parameters
- $name : string
- $dataverseName : string
- $hostname : string
Return values
mixed —build()
Static helper to keep code more readable
public
static build(string $name, string $dataverseName, string $hostname) : CouchbaseRemoteAnalyticsLink
Parameters
- $name : string
- $dataverseName : string
- $hostname : string
Tags
Return values
CouchbaseRemoteAnalyticsLink —dataverseName()
Gets the name of the dataverse to which this link belongs to.
public
dataverseName() : string
Tags
Return values
string —linkType()
Gets the link type. One of "couchbase", "s3" or "azureblob"
public
linkType() : string
Tags
Return values
string —name()
Gets the name of the link
public
name() : string
Tags
Return values
string —setEncryption()
Sets settings for connection encryption
public
setEncryption(CouchbaseAnalyticsEncryptionSettings $settings) : CouchbaseRemoteAnalyticsLink
Parameters
- $settings : CouchbaseAnalyticsEncryptionSettings
Tags
Return values
CouchbaseRemoteAnalyticsLink —setPassword()
Sets the password to use for authentication with the remote cluster.
public
setPassword(string $password) : CouchbaseRemoteAnalyticsLink
Optional if client-certificate authentication is being used.
Parameters
- $password : string
Tags
Return values
CouchbaseRemoteAnalyticsLink —setUsername()
Sets the username to use for authentication with the remote cluster.
public
setUsername(string $username) : CouchbaseRemoteAnalyticsLink
Optional if client-certificate authentication is being used.
Parameters
- $username : string