Package com.mongodb.client

Interface ListSearchIndexesIterable<TResult>

Type Parameters:
TResult - The type of the result.
All Superinterfaces:
Iterable<TResult>, MongoIterable<TResult>
@Evolving public interface ListSearchIndexesIterable<TResult> extends MongoIterable<TResult>
Iterable for listing Atlas Search indexes. This interface contains aggregate options and that of applied to $listSearchIndexes operation.
Since:
4.11
MongoDB documentation
ListSearchIndexes
Since server release
6.0

  • Method Details

    • name

      ListSearchIndexesIterable<TResult> name(String indexName)
      Sets the index name for this operation.
      Parameters:
      indexName - the index name.
      Returns:
      this.

    • allowDiskUse

      ListSearchIndexesIterable<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

      ListSearchIndexesIterable<TResult> batchSize(int batchSize)
      Sets the number of documents to return per batch.
      Specified by:
      batchSize in interface MongoIterable<TResult>
      Parameters:
      batchSize - the batch size.
      Returns:
      this.
      MongoDB documentation
      Batch Size

    • maxTime

      ListSearchIndexesIterable<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

      ListSearchIndexesIterable<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

      ListSearchIndexesIterable<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

      ListSearchIndexesIterable<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) ListSearchIndexesIterable<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

    • explain

      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

      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> 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> 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/