Package com.mongodb.client.model

Class SearchIndexModel

java.lang.Object

com.mongodb.client.model.SearchIndexModel

public final class SearchIndexModel
extends Object

A model describing the creation of a single Atlas Search index.

Since:

4.11

Since server release

6.0

Constructor Summary

Constructors

Constructor	Description
SearchIndexModel(String name, org.bson.conversions.Bson definition)	Construct an instance with the given Atlas Search name and index definition.
SearchIndexModel(String name, org.bson.conversions.Bson definition, SearchIndexType type)	Construct an instance with the given Atlas Search name, index definition, and type.
SearchIndexModel(org.bson.conversions.Bson definition)	Construct an instance with the given Atlas Search index mapping definition.

Method Summary

Modifier and Type	Method	Description
org.bson.conversions.Bson	getDefinition()	Get the Atlas Search index mapping definition.
String	getName()	Get the Atlas Search index name.
SearchIndexType	getType()	Get the Atlas Search index type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SearchIndexModel

public SearchIndexModel(org.bson.conversions.Bson definition)

Construct an instance with the given Atlas Search index mapping definition.

After calling this constructor, the name field will be null. In that case, when passing this SearchIndexModel to the createSearchIndexes method, the default search index name 'default' will be used to create the search index.

Parameters:

definition - the search index mapping definition.

SearchIndexModel

public SearchIndexModel(String name,
 org.bson.conversions.Bson definition)

Construct an instance with the given Atlas Search name and index definition.

Parameters:

name - the search index name.

definition - the search index mapping definition.

SearchIndexModel

public SearchIndexModel(@Nullable
 String name,
 org.bson.conversions.Bson definition,
 @Nullable
 SearchIndexType type)

Construct an instance with the given Atlas Search name, index definition, and type.

Parameters:

name - the search index name.

definition - the search index mapping definition.

type - the search index type.

Since:

5.2

Method Details

getDefinition

public org.bson.conversions.Bson getDefinition()

Get the Atlas Search index mapping definition.

Returns:

the index definition.

getName

@Nullable
public String getName()

Get the Atlas Search index name.

Returns:

the search index name.

getType

@Nullable
public SearchIndexType getType()

Get the Atlas Search index type.

Returns:

the search index type.

Since:

5.2

toString

public String toString()

Overrides:

toString in class Object