Package com.mongodb

Class AggregationOptions.Builder

java.lang.Object
com.mongodb.AggregationOptions.Builder
Enclosing class:
AggregationOptions
@NotThreadSafe public static class AggregationOptions.Builder extends Object
Builder for creating AggregationOptions.
MongoDB documentation
aggregate
Since server release
2.2

  • Method Details

    • batchSize

      public AggregationOptions.Builder batchSize(@Nullable Integer size)
      Sets the size of batches to use when iterating over results. Can be null.
      Parameters:
      size - the batch size to apply to the cursor
      Returns:
      this so calls can be chained

    • allowDiskUse

      public AggregationOptions.Builder allowDiskUse(@Nullable Boolean allowDiskUse)
      Set whether to enable external sort capabilities. If set to false, $sort produces an error if the operation consumes 10 percent or more RAM.
      Parameters:
      allowDiskUse - whether or not aggregation stages can write data to temporary files
      Returns:
      this so calls can be chained

    • maxTime

      public AggregationOptions.Builder maxTime(long maxTime, TimeUnit timeUnit)
      Sets the maximum execution time for the aggregation command.
      Parameters:
      maxTime - the max time
      timeUnit - the time unit
      Returns:
      this so calls can be chained

    • bypassDocumentValidation

      public AggregationOptions.Builder bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation)
      Sets whether to bypass document validation.
      Parameters:
      bypassDocumentValidation - whether to bypass document validation, or null if unspecified
      Returns:
      this
      Since:
      2.14
      Since server release
      3.2

    • collation

      public AggregationOptions.Builder collation(@Nullable Collation collation)
      Sets the collation
      Parameters:
      collation - the collation
      Returns:
      this
      Since:
      3.4
      Since server release
      3.4

    • build

      public AggregationOptions build()
      Return the options based on this builder.
      Returns:
      the aggregation options