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

Class ConnectLinkAnalyticsOptions

java.lang.Object

com.couchbase.client.java.CommonOptions<ConnectLinkAnalyticsOptions>

com.couchbase.client.java.manager.analytics.ConnectLinkAnalyticsOptions

public class ConnectLinkAnalyticsOptions
extends CommonOptions<ConnectLinkAnalyticsOptions>

Customizes how a analytics link is connected.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ConnectLinkAnalyticsOptions.Built

Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method	Description
ConnectLinkAnalyticsOptions.Built	build()
static ConnectLinkAnalyticsOptions	connectLinkAnalyticsOptions()	Creates a new instance with default values.
ConnectLinkAnalyticsOptions	dataverseName(String dataverseName)	Sets the name of the dataverse in which the link should be connected.
ConnectLinkAnalyticsOptions	force(boolean force)	Customizes if connect link should be forced or not.
ConnectLinkAnalyticsOptions	linkName(String linkName)	Sets the name of the link which should be connected.

Methods inherited from class com.couchbase.client.java.CommonOptions

clientContext, parentSpan, retryStrategy, self, timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

connectLinkAnalyticsOptions

public static ConnectLinkAnalyticsOptions connectLinkAnalyticsOptions()

Creates a new instance with default values.

Returns:

the instantiated default options.

dataverseName

public ConnectLinkAnalyticsOptions dataverseName(String dataverseName)

Sets the name of the dataverse in which the link should be connected.

Parameters:

dataverseName - the name of the dataverse.

Returns:

this ConnectLinkAnalyticsOptions for chaining purposes.

linkName

public ConnectLinkAnalyticsOptions linkName(String linkName)

Sets the name of the link which should be connected.

Parameters:

linkName - the name of the link.

Returns:

this ConnectLinkAnalyticsOptions for chaining purposes.

force

public ConnectLinkAnalyticsOptions force(boolean force)

Customizes if connect link should be forced or not.

Determines the behavior of CONNECT LINK if there has been a change in the bucket’s UUID, i.e. the bucket has been deleted and recreated with the same name.

• If force is false, then CONNECT LINK fails. This is the default behavior.
• If force is true, CONNECT LINK proceeds: Analytics deletes all existing data in the dataset and ingests all data from the bucket again.

build

@Internal
public ConnectLinkAnalyticsOptions.Built build()