Package com.mongodb.client.model

Class EstimatedDocumentCountOptions

java.lang.Object
com.mongodb.client.model.EstimatedDocumentCountOptions
public class EstimatedDocumentCountOptions extends Object
The options an estimated count operation.
Since:
3.8
MongoDB documentation
Count

  • Constructor Details

    • EstimatedDocumentCountOptions

      public EstimatedDocumentCountOptions()

  • Method Details

    • getMaxTime

      public long getMaxTime(TimeUnit timeUnit)
      Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
      Parameters:
      timeUnit - the time unit to return the result in
      Returns:
      the maximum execution time in the given time unit

    • maxTime

      public EstimatedDocumentCountOptions 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

    • getComment

      @Nullable public BsonValue getComment()
      Returns:
      the comment for this operation. A null value means no comment is set.
      Since:
      4.7
      Since server release
      4.4

    • comment

      public EstimatedDocumentCountOptions comment(@Nullable String comment)
      Sets the comment for this operation. A null value means no comment is set.
      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.7
      Since server release
      4.4

    • comment

      public EstimatedDocumentCountOptions comment(@Nullable BsonValue comment)
      Sets the comment for this operation. A null value means no comment is set.
      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.7
      Since server release
      4.4

    • toString

      public String toString()
      Overrides:
      toString in class Object