Class GetLinksAnalyticsOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<GetLinksAnalyticsOptions>
-
- com.couchbase.client.java.manager.analytics.GetLinksAnalyticsOptions
-
public class GetLinksAnalyticsOptions extends CommonOptions<GetLinksAnalyticsOptions>
Allows customizing how the analytics links are loaded.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
GetLinksAnalyticsOptions.Built
-
Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions
CommonOptions.BuiltCommonOptions
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GetLinksAnalyticsOptions.Built
build()
GetLinksAnalyticsOptions
dataverseName(String dataverseName)
Limits the loading only to the specified dataverse.static GetLinksAnalyticsOptions
getLinksAnalyticsOptions()
Creates a new instance with default values.GetLinksAnalyticsOptions
linkType(AnalyticsLinkType linkType)
Limits the loading to only the specifiedAnalyticsLinkType
.GetLinksAnalyticsOptions
name(String linkName)
Limits the loading only to the specified name of the link.-
Methods inherited from class com.couchbase.client.java.CommonOptions
clientContext, parentSpan, retryStrategy, self, timeout
-
-
-
-
Method Detail
-
getLinksAnalyticsOptions
public static GetLinksAnalyticsOptions getLinksAnalyticsOptions()
Creates a new instance with default values.- Returns:
- the instantiated default options.
-
dataverseName
public GetLinksAnalyticsOptions dataverseName(String dataverseName)
Limits the loading only to the specified dataverse.- Parameters:
dataverseName
- the name of the dataverse for which the links should be loaded.- Returns:
- this options class for chaining purposes.
-
name
public GetLinksAnalyticsOptions name(String linkName)
Limits the loading only to the specified name of the link.If this option is set, the
dataverseName(String)
must also be set.- Parameters:
linkName
- the name of the link that should be loaded.- Returns:
- this options class for chaining purposes.
-
linkType
public GetLinksAnalyticsOptions linkType(AnalyticsLinkType linkType)
Limits the loading to only the specifiedAnalyticsLinkType
.- Parameters:
linkType
- the type of link that should be loaded.- Returns:
- this options class for chaining purposes.
-
build
@Internal public GetLinksAnalyticsOptions.Built build()
-
-