CouchbaseAnalyticsEncryptionSettings
in package
Table of Contents
- $certificate : string|null
- $clientCertificate : string|null
- $clientKey : string|null
- $encryptionLevel : string
- __construct() : mixed
- build() : CouchbaseAnalyticsEncryptionSettings
- Static helper to keep code more readable
- certificate() : string|null
- Gets the certificate to use for connecting when encryption level is set to full.
- clientCertificate() : string|null
- Gets the client certificate to use for connecting when encryption level is set to full.
- clientKey() : string|null
- Gets the client key to use for connecting when encryption level is set to full
- encryptionLevel() : string
- Gets the encryption level
- setCertificate() : CouchbaseAnalyticsEncryptionSettings
- Provides a certificate to use for connecting when encryption level is set to full. Required when encryption level is set to @see AnalyticsEncryptionLevel::FULL
- setClientCertificate() : CouchbaseAnalyticsEncryptionSettings
- Provides a client certificate to use for connecting when encryption level is set to full. Cannot be set if a username/password are used.
- setClientKey() : CouchbaseAnalyticsEncryptionSettings
- Provides a client key to use for connecting when encryption level is set to full. Cannot be set if a username/password are used.
Properties
$certificate
private
string|null
$certificate
= null
$clientCertificate
private
string|null
$clientCertificate
= null
$clientKey
private
string|null
$clientKey
= null
$encryptionLevel
private
string
$encryptionLevel
Methods
__construct()
public
__construct(string $level) : mixed
Parameters
- $level : string
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build(string $level) : CouchbaseAnalyticsEncryptionSettings
Parameters
- $level : string
-
Accepted values are 'none', 'half', 'full'.
Tags
Return values
CouchbaseAnalyticsEncryptionSettings —certificate()
Gets the certificate to use for connecting when encryption level is set to full.
public
certificate() : string|null
Tags
Return values
string|null —clientCertificate()
Gets the client certificate to use for connecting when encryption level is set to full.
public
clientCertificate() : string|null
Tags
Return values
string|null —clientKey()
Gets the client key to use for connecting when encryption level is set to full
public
clientKey() : string|null
Tags
Return values
string|null —encryptionLevel()
Gets the encryption level
public
encryptionLevel() : string
Tags
Return values
string —setCertificate()
Provides a certificate to use for connecting when encryption level is set to full. Required when encryption level is set to @see AnalyticsEncryptionLevel::FULL
public
setCertificate(string $certificate) : CouchbaseAnalyticsEncryptionSettings
Parameters
- $certificate : string
Tags
Return values
CouchbaseAnalyticsEncryptionSettings —setClientCertificate()
Provides a client certificate to use for connecting when encryption level is set to full. Cannot be set if a username/password are used.
public
setClientCertificate(string $clientCertificate) : CouchbaseAnalyticsEncryptionSettings
Parameters
- $clientCertificate : string
Tags
Return values
CouchbaseAnalyticsEncryptionSettings —setClientKey()
Provides a client key to use for connecting when encryption level is set to full. Cannot be set if a username/password are used.
public
setClientKey(string $key) : CouchbaseAnalyticsEncryptionSettings
Parameters
- $key : string