Class CouchbaseRemoteAnalyticsLink
- java.lang.Object
-
- com.couchbase.client.java.manager.analytics.link.AnalyticsLink
-
- com.couchbase.client.java.manager.analytics.link.CouchbaseRemoteAnalyticsLink
-
public class CouchbaseRemoteAnalyticsLink extends AnalyticsLink
An analytics link to a remote couchbase cluster.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCouchbaseRemoteAnalyticsLink.EncryptionLevelSecurity options for remote Couchbase links.
-
Constructor Summary
Constructors Constructor Description CouchbaseRemoteAnalyticsLink(String name, String dataverse)Creates a new Analytics Link to a remote Couchbase cluster.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringcertificate()Returns the certificate when encryption is used.CouchbaseRemoteAnalyticsLinkcertificate(String certificate)Sets the certificate when encryption is used.StringclientCertificate()Returns the client certificate when encryption is used.CouchbaseRemoteAnalyticsLinkclientCertificate(String clientCertificate)Sets the client certificate when encryption is used.StringclientKey()Returns the client key.CouchbaseRemoteAnalyticsLinkclientKey(String clientKey)Sets the client key.CouchbaseRemoteAnalyticsLink.EncryptionLevelencryption()Returns the encryption level for the link to the remote cluster.CouchbaseRemoteAnalyticsLinkencryption(CouchbaseRemoteAnalyticsLink.EncryptionLevel encryption)Sets the encryption level for the link to the remote cluster (required).Stringhostname()Returns the hostname of the remote cluster.CouchbaseRemoteAnalyticsLinkhostname(String hostname)Sets the hostname of the remote cluster (required).Stringpassword()Sets the password when connecting to the remote cluster.CouchbaseRemoteAnalyticsLinkpassword(String password)Sets the password when connecting to the remote cluster (required).StringtoString()AnalyticsLinkTypetype()Returns the type of the link.Stringusername()Returns the username when connecting to the remote cluster.CouchbaseRemoteAnalyticsLinkusername(String username)Sets the username when connecting to the remote cluster (required).-
Methods inherited from class com.couchbase.client.java.manager.analytics.link.AnalyticsLink
couchbaseRemote, dataverse, name, s3, toMap
-
-
-
-
Constructor Detail
-
CouchbaseRemoteAnalyticsLink
public CouchbaseRemoteAnalyticsLink(String name, String dataverse)
Creates a new Analytics Link to a remote Couchbase cluster.As an alternative to this constructor,
AnalyticsLink.couchbaseRemote(String, String)can be used as well.Please note that additional parameters are required and must be set on
CouchbaseRemoteAnalyticsLinkin order for the link to work properly.
-
-
Method Detail
-
type
public AnalyticsLinkType type()
Description copied from class:AnalyticsLinkReturns the type of the link.- Specified by:
typein classAnalyticsLink- Returns:
- the type of the link.
-
hostname
public String hostname()
Returns the hostname of the remote cluster.- Returns:
- the hostname of the remote cluster.
-
hostname
public CouchbaseRemoteAnalyticsLink hostname(String hostname)
Sets the hostname of the remote cluster (required).- Parameters:
hostname- the hostname of the remote cluster.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
encryption
public CouchbaseRemoteAnalyticsLink.EncryptionLevel encryption()
Returns the encryption level for the link to the remote cluster.- Returns:
- the encryption level for the link to the remote cluster.
-
encryption
public CouchbaseRemoteAnalyticsLink encryption(CouchbaseRemoteAnalyticsLink.EncryptionLevel encryption)
Sets the encryption level for the link to the remote cluster (required).- Parameters:
encryption- the encryption level for the link to the remote cluster.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
username
public String username()
Returns the username when connecting to the remote cluster.- Returns:
- the username when connecting to the remote cluster.
-
username
public CouchbaseRemoteAnalyticsLink username(String username)
Sets the username when connecting to the remote cluster (required).- Parameters:
username- the username when connecting to the remote cluster.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
password
public String password()
Sets the password when connecting to the remote cluster.- Returns:
- the password when connecting to the remote cluster.
-
password
public CouchbaseRemoteAnalyticsLink password(String password)
Sets the password when connecting to the remote cluster (required).- Parameters:
password- the password when connecting to the remote cluster.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
certificate
public String certificate()
Returns the certificate when encryption is used.- Returns:
- the certificate when encryption is used.
-
certificate
public CouchbaseRemoteAnalyticsLink certificate(String certificate)
Sets the certificate when encryption is used.- Parameters:
certificate- the certificate when encryption is used.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
clientCertificate
public String clientCertificate()
Returns the client certificate when encryption is used.- Returns:
- the client certificate when encryption is used.
-
clientCertificate
public CouchbaseRemoteAnalyticsLink clientCertificate(String clientCertificate)
Sets the client certificate when encryption is used.- Parameters:
clientCertificate- the client certificate when encryption is used.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
clientKey
public String clientKey()
Returns the client key.- Returns:
- the client key.
-
clientKey
public CouchbaseRemoteAnalyticsLink clientKey(String clientKey)
Sets the client key.- Parameters:
clientKey- the client key.- Returns:
- this
CouchbaseRemoteAnalyticsLinkfor chaining purposes.
-
-