Package com.couchbase.client.java.manager.analytics.link

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 Details

    • AnalyticsLink

      protected AnalyticsLink(String name, String dataverse)
      Creates a new AnalyticsLink.
      Parameters:
      name - the name of the link.
      dataverse - the dataverse in which this link is stored.

  • Method Details

    • 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 S3ExternalAnalyticsLink in 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.

    • toMap

      @Internal public Map<String,String> toMap()
      Returns an (internal) representation of this link as a map.
      Returns:
      a map representation of this link.