Class AnalyticsLink
- java.lang.Object
-
- com.couchbase.client.java.manager.analytics.link.AnalyticsLink
-
- Direct Known Subclasses:
CouchbaseRemoteAnalyticsLink,RawExternalAnalyticsLink,S3ExternalAnalyticsLink
public abstract class AnalyticsLink extends Object
Represents a Link to an external datasource that is connected with the Analytics service.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAnalyticsLink(String name, String dataverse)Creates a newAnalyticsLink.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static CouchbaseRemoteAnalyticsLinkcouchbaseRemote(String linkName, String dataverseName)Static factory method to create a remote Couchbase link.Stringdataverse()Returns the name of the dataverse in which this link is stored.Stringname()Returns the name of the analytics link.static S3ExternalAnalyticsLinks3(String linkName, String dataverseName)Static factory method to create an S3 link.Map<String,String>toMap()Returns an (internal) representation of this link as a map.abstract AnalyticsLinkTypetype()Returns the type of the link.
-
-
-
Constructor Detail
-
AnalyticsLink
protected AnalyticsLink(String name, String dataverse)
Creates a newAnalyticsLink.- Parameters:
name- the name of the link.dataverse- the dataverse in which this link is stored.
-
-
Method Detail
-
s3
@SinceCouchbase("7.0") public static S3ExternalAnalyticsLink s3(String linkName, String dataverseName)
Static factory method to create an S3 link.Please note that additional parameters are required and must be set on
S3ExternalAnalyticsLinkin order for a S3 link to work properly.- Parameters:
linkName- the name of the link.dataverseName- the dataverse name inside which the link exists.- Returns:
- the created link instance.
-
couchbaseRemote
public static CouchbaseRemoteAnalyticsLink couchbaseRemote(String linkName, String dataverseName)
Static factory method to create a remote Couchbase link.- Parameters:
linkName- the name of the link.dataverseName- the dataverse name inside which the link exists.- Returns:
- the created link instance.
-
type
public abstract AnalyticsLinkType type()
Returns the type of the link.- Returns:
- the type of the link.
-
name
public String name()
Returns the name of the analytics link.- Returns:
- the name of the link.
-
dataverse
public String dataverse()
Returns the name of the dataverse in which this link is stored.- Returns:
- the name of the dataverse.
-
-