com.mongodb

Class AggregationOptions.Builder

java.lang.Object

com.mongodb.AggregationOptions.Builder

Enclosing class:

AggregationOptions

public static class AggregationOptions.Builder
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
AggregationOptions.Builder	allowDiskUse(Boolean allowDiskUse) If true, this enables external sort capabilities otherwise $sort produces an error if the operation consumes 10 percent or more of RAM.
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	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time for the aggregation command.
AggregationOptions.Builder	outputMode(AggregationOptions.OutputMode mode) The mode of output for this configuration.

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.

Returns:

this

Since server release

2.6

allowDiskUse

public AggregationOptions.Builder allowDiskUse(Boolean allowDiskUse)

If true, this enables external sort capabilities otherwise $sort produces an error if the operation consumes 10 percent or more of RAM.

Returns:

this

Since server release

2.6

outputMode

public AggregationOptions.Builder outputMode(AggregationOptions.OutputMode mode)

The mode of output for this configuration.

Returns:

this

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

Since server release

2.6

build

public AggregationOptions build()

Return the options based on this builder.

Returns:

the aggregation options