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

Class AnalyticsIndex

java.lang.Object

com.couchbase.client.java.manager.analytics.AnalyticsIndex

public class AnalyticsIndex
extends Object

Represents an index in analytics.

Constructor Summary

Constructors

Constructor	Description
AnalyticsIndex(JsonObject raw)	Creates a new dataset from a raw JSON object.

Method Summary

Modifier and Type	Method	Description
String	datasetName()	Returns the name of the Dataset (collection) this index is part of.
String	dataverseName()	Returns the name of the dataverse.
String	name()	Returns the name of the analytics index.
boolean	primary()	Returns true if this index is a primary index.
JsonObject	raw()	Returns the "raw" JSON returned from the analytics service.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AnalyticsIndex

@Internal
public AnalyticsIndex(JsonObject raw)

Creates a new dataset from a raw JSON object.

Parameters:

raw - the decoded JSON object.

Method Details

name

public String name()

Returns the name of the analytics index.

Returns:

the name of the analytics index.

primary

public boolean primary()

Returns true if this index is a primary index.

Returns:

true if this index is a primary index.

datasetName

public String datasetName()

Returns the name of the Dataset (collection) this index is part of.

Returns:

the name of the Dataset (collection) this index is part of.

dataverseName

public String dataverseName()

Returns the name of the dataverse.

Returns:

the name of the dataverse.

raw

public JsonObject raw()

Returns the "raw" JSON returned from the analytics service.

Returns:

the "raw" JSON returned from the analytics service.

toString

public String toString()

Overrides:

toString in class Object