com.couchbase.client.java.manager.analytics

Class CreateDatasetAnalyticsOptions

java.lang.Object

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

com.couchbase.client.java.manager.analytics.CreateDatasetAnalyticsOptions

public class CreateDatasetAnalyticsOptions
extends CommonOptions<CreateDatasetAnalyticsOptions>

Allows customizing how datasets are created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CreateDatasetAnalyticsOptions.Built

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

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method and Description
CreateDatasetAnalyticsOptions.Built	build()
CreateDatasetAnalyticsOptions	condition(String condition) Customizes the "WHERE" clause of the index creation statement.
static CreateDatasetAnalyticsOptions	createDatasetAnalyticsOptions() Creates a new instance with default values.
CreateDatasetAnalyticsOptions	dataverseName(String dataverseName) Customizes the dataverse from which this dataset should be created.
CreateDatasetAnalyticsOptions	ignoreIfExists(boolean ignore) Customizes if an already existing dataset should throw an exception or not (false by default, so it will throw).

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 Detail

createDatasetAnalyticsOptions

public static CreateDatasetAnalyticsOptions createDatasetAnalyticsOptions()

Creates a new instance with default values.

Returns:

the instantiated default options.

ignoreIfExists

public CreateDatasetAnalyticsOptions ignoreIfExists(boolean ignore)

Customizes if an already existing dataset should throw an exception or not (false by default, so it will throw).

Parameters:

ignore - true if no exception should be raised if the dataset already exists.

Returns:

this options class for chaining purposes.

dataverseName

public CreateDatasetAnalyticsOptions dataverseName(String dataverseName)

Customizes the dataverse from which this dataset should be created.

Parameters:

dataverseName - the name of the dataverse.

Returns:

this options class for chaining purposes.

condition

public CreateDatasetAnalyticsOptions condition(String condition)

Customizes the "WHERE" clause of the index creation statement.

Parameters:

condition - the condition that should be appended to the where clause.

Returns:

this options class for chaining purposes.

build

@Stability.Internal
public CreateDatasetAnalyticsOptions.Built build()