Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Class SearchIndexInfo

java.lang.Object

org.springframework.data.mongodb.core.index.SearchIndexInfo

public class SearchIndexInfo
extends Object

Index information for a MongoDB Search Index.

Since:

4.5

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
Object	getId()	The id of the index.
SearchIndexDefinition	getIndexDefinition()
SearchIndexStatus	getStatus()
static SearchIndexInfo	of(org.bson.Document indexDocument)	Create an index from its BSON Document representation into a SearchIndexInfo.
static SearchIndexInfo	parse(String source)	Parse a BSON document describing an index into a SearchIndexInfo.

Methods inherited from class java.lang.Object

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

Method Details

parse

public static SearchIndexInfo parse(String source)

Parse a BSON document describing an index into a SearchIndexInfo.

Parameters:

source - BSON document describing the index.

Returns:

a new SearchIndexInfo instance.

of

public static SearchIndexInfo of(org.bson.Document indexDocument)

Create an index from its BSON Document representation into a SearchIndexInfo.

Parameters:

indexDocument - BSON document describing the index.

Returns:

a new SearchIndexInfo instance.

getId

@Nullable
public Object getId()

The id of the index. Can be null, eg. for an index not yet created.

Returns:

can be null.

getStatus

public SearchIndexStatus getStatus()

Returns:

the current status of the index.

getIndexDefinition

public SearchIndexDefinition getIndexDefinition()

Returns:

the current index definition.