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 Summary

Modifier and Type	Method	Description
AggregationOptions.Builder	allowDiskUse(Boolean allowDiskUse)	Set whether to enable external sort capabilities.
AggregationOptions.Builder	batchSize(Integer size)	Sets the size of batches to use when iterating over results.
AggregationOptions	build()	Return the options based on this builder.
AggregationOptions.Builder	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets whether to bypass document validation.
AggregationOptions.Builder	collation(Collation collation)	Sets the collation
AggregationOptions.Builder	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time for the aggregation command.
AggregationOptions.Builder	outputMode(AggregationOptions.OutputMode mode)	Deprecated. There is no replacement for this.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

batchSize

public AggregationOptions.Builder batchSize(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

Since server release

2.6

allowDiskUse

public AggregationOptions.Builder allowDiskUse(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

Since server release

2.6

outputMode

@Deprecated
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 - an OutputMode 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 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

Since server release

2.6

bypassDocumentValidation

public AggregationOptions.Builder bypassDocumentValidation(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(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