Package com.mongodb.reactivestreams.client

Interface ListSearchIndexesPublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Publisher<TResult>

@Evolving
public interface ListSearchIndexesPublisher<TResult>
extends Publisher<TResult>

A specific Publisher interface for listing Atlas Search indexes.

Since:

4.11

Since server release

6.0

Method Summary

Modifier and Type	Method	Description
ListSearchIndexesPublisher<TResult>	allowDiskUse(Boolean allowDiskUse)	Enables writing to temporary files.
ListSearchIndexesPublisher<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
ListSearchIndexesPublisher<TResult>	collation(Collation collation)	Sets the collation options
ListSearchIndexesPublisher<TResult>	comment(String comment)	Sets the comment for this operation.
ListSearchIndexesPublisher<TResult>	comment(BsonValue comment)	Sets the comment for this operation.
Publisher<Document>	explain()	Explain the execution plan for this operation with the server's default verbosity level
Publisher<Document>	explain(ExplainVerbosity verbosity)	Explain the execution plan for this operation with the given verbosity level
<E> Publisher<E>	explain(Class<E> explainResultClass)	Explain the execution plan for this operation with the server's default verbosity level
<E> Publisher<E>	explain(Class<E> explainResultClass, ExplainVerbosity verbosity)	Explain the execution plan for this operation with the given verbosity level
Publisher<TResult>	first()	Helper to return a publisher limited to the first result.
ListSearchIndexesPublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
ListSearchIndexesPublisher<TResult>	name(String indexName)	Sets the index name for this operation.
ListSearchIndexesPublisher<TResult>	timeoutMode(TimeoutMode timeoutMode)	Sets the timeoutMode for the cursor.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Details

name

ListSearchIndexesPublisher<TResult> name(String indexName)

Sets the index name for this operation.

Parameters:

indexName - the index name.

Returns:

this

allowDiskUse

ListSearchIndexesPublisher<TResult> allowDiskUse(@Nullable
 Boolean allowDiskUse)

Enables writing to temporary files. A null value indicates that it's unspecified.

Parameters:

allowDiskUse - true if writing to temporary files is enabled

Returns:

this

MongoDB documentation

Aggregation

batchSize

ListSearchIndexesPublisher<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

maxTime

ListSearchIndexesPublisher<TResult> maxTime(long maxTime,
 TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

collation

ListSearchIndexesPublisher<TResult> collation(@Nullable
 Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

comment

ListSearchIndexesPublisher<TResult> comment(@Nullable
 String comment)

Sets the comment for this operation. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

comment

ListSearchIndexesPublisher<TResult> comment(@Nullable
 BsonValue comment)

Sets the comment for this operation. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

timeoutMode

@Alpha(CLIENT)
ListSearchIndexesPublisher<TResult> timeoutMode(TimeoutMode timeoutMode)

Sets the timeoutMode for the cursor.

Requires the timeout to be set, either in the MongoClientSettings, via MongoDatabase or via MongoCollection

Parameters:

timeoutMode - the timeout mode

Returns:

this

Since:

5.2

first

Publisher<TResult> first()

Helper to return a publisher limited to the first result.

Returns:

a Publisher which will contain a single item.

explain

Publisher<Document> explain()

Explain the execution plan for this operation with the server's default verbosity level

Returns:

the execution plan

MongoDB documentation

reference/command/explain/

explain

Publisher<Document> explain(ExplainVerbosity verbosity)

Explain the execution plan for this operation with the given verbosity level

Parameters:

verbosity - the verbosity of the explanation

Returns:

the execution plan

MongoDB documentation

reference/command/explain/

explain

<E> Publisher<E> explain(Class<E> explainResultClass)

Explain the execution plan for this operation with the server's default verbosity level

Type Parameters:

E - the type of the document class

Parameters:

explainResultClass - the document class to decode into

Returns:

the execution plan

MongoDB documentation

reference/command/explain/

explain

<E> Publisher<E> explain(Class<E> explainResultClass,
 ExplainVerbosity verbosity)

Explain the execution plan for this operation with the given verbosity level

Type Parameters:

E - the type of the document class

Parameters:

explainResultClass - the document class to decode into

verbosity - the verbosity of the explanation

Returns:

the execution plan

MongoDB documentation

reference/command/explain/