com.couchbase.client.java.query.dsl.path.index

Class DefaultIndexNamesPath

java.lang.Object

com.couchbase.client.java.query.dsl.path.AbstractPath

com.couchbase.client.java.query.dsl.path.index.DefaultIndexNamesPath

All Implemented Interfaces:

IndexNamesPath, Path

@InterfaceStability.Experimental
 @InterfaceAudience.Private
public class DefaultIndexNamesPath
extends AbstractPath
implements IndexNamesPath

See IndexNamesPath.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultIndexNamesPath(AbstractPath parent)

Method Summary

Modifier and Type	Method and Description
UsingPath	indexes(List<String> indexNames) Specify the indexes in a pending state that needs building, as a non-empty list.
UsingPath	indexes(String indexName, String... indexNames) Specify the index or indexes in a pending state that needs building.
UsingPath	primary() Build the primary index (using a name of Index.PRIMARY_NAME, must be in a pending state).

Methods inherited from class com.couchbase.client.java.query.dsl.path.AbstractPath

element, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexNamesPath

protected DefaultIndexNamesPath(AbstractPath parent)

Method Detail

indexes

public UsingPath indexes(String indexName,
                         String... indexNames)

Description copied from interface: IndexNamesPath

Specify the index or indexes in a pending state that needs building.

Specified by:

indexes in interface IndexNamesPath

Parameters:

indexName - minimum index to build (name will be escaped).

indexNames - 0-n additional indexes to also build (names will be escaped).

indexes

public UsingPath indexes(List<String> indexNames)

Description copied from interface: IndexNamesPath

Specify the indexes in a pending state that needs building, as a non-empty list.

Specified by:

indexes in interface IndexNamesPath

Parameters:

indexNames - the List of indexes to build (names will be escaped).

primary

public UsingPath primary()

Description copied from interface: IndexNamesPath

Build the primary index (using a name of Index.PRIMARY_NAME, must be in a pending state).

Specified by:

primary in interface IndexNamesPath