Package com.ibm.cloud.cloudant.v1.model

Class SearchIndexDefinition

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.SearchIndexDefinition

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SearchIndexDefinition
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Schema for a search index definition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchIndexDefinition.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
AnalyzerConfiguration	analyzer()	Gets the analyzer.
String	index()	Gets the index.
SearchIndexDefinition.Builder	newBuilder()	New builder.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SearchIndexDefinition.Builder newBuilder()

New builder.

Returns:

a SearchIndexDefinition builder

analyzer

public AnalyzerConfiguration analyzer()

Gets the analyzer. Schema for a search analyzer configuration.

Returns:

the analyzer

index

public String index()

Gets the index. String form of a JavaScript function that is called for each document in the database. The function takes the document as a parameter, extracts some data from it, and then calls the `index` function to index that data. The index function takes 2, or optionally 3, parameters. * The first parameter is the name of the field you intend to use when querying the index. If the special value `"default"` is used when you define the name, you do not have to specify a field name at query time. * The second parameter is the data to be indexed. This data must be only a string, number, or boolean. Other types will cause an error to be thrown by the index function call. * The optional third parameter is a JavaScript object with these properties: * `facet` - boolean, default `false` - Creates a faceted index. * `index` - boolean, default `true` - If set to `false`, the data cannot be used for searches, but can still be retrieved from the index if `store` is set to `true`. * `store` - boolean, default `true` - If true, the value is returned in the search result; otherwise, the value is not returned.

Returns:

the index