public class AggregationOptions extends Object
Aggregation.withOptions(AggregationOptions)
,
TypedAggregation.withOptions(AggregationOptions)
Modifier and Type | Class and Description |
---|---|
static class |
AggregationOptions.Builder
A Builder for
AggregationOptions . |
Constructor and Description |
---|
AggregationOptions(boolean allowDiskUse,
boolean explain,
com.mongodb.DBObject cursor)
Creates a new
AggregationOptions . |
Modifier and Type | Method and Description |
---|---|
com.mongodb.DBObject |
getCursor()
Specify a document that contains options that control the creation of the cursor object.
|
boolean |
isAllowDiskUse()
Enables writing to temporary files.
|
boolean |
isExplain()
Specifies to return the information on the processing of the pipeline.
|
com.mongodb.DBObject |
toDbObject()
Returns a
DBObject representation of this AggregationOptions . |
String |
toString() |
public AggregationOptions(boolean allowDiskUse, boolean explain, com.mongodb.DBObject cursor)
AggregationOptions
.allowDiskUse
- whether to off-load intensive sort-operations to disk.explain
- whether to get the execution plan for the aggregation instead of the actual results.cursor
- can be null, used to pass additional options to the aggregation.public boolean isAllowDiskUse()
public boolean isExplain()
public com.mongodb.DBObject getCursor()
public com.mongodb.DBObject toDbObject()
DBObject
representation of this AggregationOptions
.Copyright © 2011-2015–2015 Pivotal Software, Inc.. All rights reserved.