Package com.couchbase.client.java.manager.search

Class SearchIndex

java.lang.Object

com.couchbase.client.java.manager.search.SearchIndex

public class SearchIndex
extends Object

A full text search index definition.

Constructor Summary

Constructors

Constructor	Description
SearchIndex(String name, String sourceName)
SearchIndex(String uuid, String name, String type, Map<String,Object> params, String sourceUuid, String sourceName, Map<String,Object> sourceParams, String sourceType, Map<String,Object> planParams)

Method Summary

Modifier and Type	Method	Description
static SearchIndex	fromJson(String input)	Takes a encoded index definition and turns it into a SearchIndex which can be used.
String	name()
Map<String,Object>	params()
SearchIndex	params(Map<String,Object> params)
Map<String,Object>	planParams()
SearchIndex	planParams(Map<String,Object> planParams)
String	sourceName()
Map<String,Object>	sourceParams()
SearchIndex	sourceParams(Map<String,Object> sourceParams)
String	sourceType()
SearchIndex	sourceType(String sourceType)
String	sourceUuid()
SearchIndex	sourceUuid(String sourceUuid)
String	toJson()
String	toString()
String	type()
SearchIndex	unsetUuid()	Allows to unset the UUID from an index definition.
String	uuid()
SearchIndex	uuid(String uuid)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchIndex

public SearchIndex(String name,
                   String sourceName)

SearchIndex

public SearchIndex(String uuid,
                   String name,
                   String type,
                   Map<String,Object> params,
                   String sourceUuid,
                   String sourceName,
                   Map<String,Object> sourceParams,
                   String sourceType,
                   Map<String,Object> planParams)

Method Detail

fromJson

public static SearchIndex fromJson(String input)

Takes a encoded index definition and turns it into a SearchIndex which can be used.

Parameters:

input - the encoded JSON index definition.

Returns:

the instantiated index.

name

public String name()

uuid

public String uuid()

uuid

public SearchIndex uuid(String uuid)

unsetUuid

public SearchIndex unsetUuid()

Allows to unset the UUID from an index definition. This method is especially useful if you are creating an index definition from a index JSON blob and you want to create the index rather than modify it. If the index is not created and you leave the UUID in, the request will fail with an IndexNotFoundException.

sourceName

public String sourceName()

type

public String type()

params

public Map<String,Object> params()

params

public SearchIndex params(Map<String,Object> params)

sourceUuid

public String sourceUuid()

sourceUuid

public SearchIndex sourceUuid(String sourceUuid)

sourceParams

public Map<String,Object> sourceParams()

sourceParams

public SearchIndex sourceParams(Map<String,Object> sourceParams)

sourceType

public String sourceType()

sourceType

public SearchIndex sourceType(String sourceType)

planParams

public Map<String,Object> planParams()

planParams

public SearchIndex planParams(Map<String,Object> planParams)

toJson

public String toJson()

toString

public String toString()

Overrides:

toString in class Object