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

Class CreateIndexAnalyticsOptions

java.lang.Object

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

com.couchbase.client.java.manager.analytics.CreateIndexAnalyticsOptions

public class CreateIndexAnalyticsOptions
extends CommonOptions<CreateIndexAnalyticsOptions>

Customizes how an index is created.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CreateIndexAnalyticsOptions.Built

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

CommonOptions.BuiltCommonOptions

Method Summary

Modifier and Type	Method	Description
CreateIndexAnalyticsOptions.Built	build()
static CreateIndexAnalyticsOptions	createIndexAnalyticsOptions()	Creates a new instance with default values.
CreateIndexAnalyticsOptions	dataverseName(String dataverseName)	The name of the dataverse in which the index exists.
CreateIndexAnalyticsOptions	ignoreIfExists(boolean ignore)	Ignore the create operation if the index exists.

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

createIndexAnalyticsOptions

public static CreateIndexAnalyticsOptions createIndexAnalyticsOptions()

Creates a new instance with default values.

Returns:

the instantiated default options.

ignoreIfExists

public CreateIndexAnalyticsOptions ignoreIfExists(boolean ignore)

Ignore the create operation if the index exists.

Parameters:

ignore - if true no exception will be thrown if the index already exists.

Returns:

this CreateIndexAnalyticsOptions for chaining purposes.

dataverseName

public CreateIndexAnalyticsOptions dataverseName(String dataverseName)

The name of the dataverse in which the index exists.

Parameters:

dataverseName - the name of the dataverse.

Returns:

this CreateIndexAnalyticsOptions for chaining purposes.

build

@Internal
public CreateIndexAnalyticsOptions.Built build()