Package com.mongodb
Class AggregationOptions.Builder
-
- com.mongodb.AggregationOptions.Builder
-
- Enclosing class:
- AggregationOptions
@NotThreadSafe public static class AggregationOptions.Builder extends
Builder for creatingAggregationOptions
.- MongoDB documentation
- Since server release
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AggregationOptions.Builder
allowDiskUse)
Set whether to enable external sort capabilities.AggregationOptions.Builder
size)
Sets the size of batches to use when iterating over results.AggregationOptions
build()
Return the options based on this builder.AggregationOptions.Builder
bypassDocumentValidation)
Sets whether to bypass document validation.AggregationOptions.Builder
collation(Collation collation)
Sets the collationAggregationOptions.Builder
maxTime(long maxTime, timeUnit)
Sets the maximum execution time for the aggregation command.AggregationOptions.Builder
outputMode(AggregationOptions.OutputMode mode)
Deprecated.There is no replacement for this.
-
-
-
Method Detail
-
batchSize
public 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- Since server release
-
allowDiskUse
public 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- Since server release
-
outputMode
public AggregationOptions.Builder outputMode(AggregationOptions.OutputMode mode)
Deprecated.There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.The mode of output for this configuration.- Parameters:
mode
- anOutputMode
that defines how to output the results of the aggregation.- Returns:
this
so calls can be chained- See Also:
AggregationOptions.OutputMode
-
maxTime
public AggregationOptions.Builder maxTime(long maxTime, timeUnit)
Sets the maximum execution time for the aggregation command.- Parameters:
maxTime
- the max timetimeUnit
- the time unit- Returns:
this
so calls can be chained- Since server release
-
bypassDocumentValidation
public 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
-
collation
public AggregationOptions.Builder collation(Collation collation)
Sets the collation- Parameters:
collation
- the collation- Returns:
- this
- Since:
- 3.4
- Since server release
-
build
public AggregationOptions build()
Return the options based on this builder.- Returns:
- the aggregation options
-
-