AggregateToCollectionOperation (mongo-java-driver 3.6.0 API)

java.lang.Object
- com.mongodb.operation.AggregateToCollectionOperation

All Implemented Interfaces:

AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.Void>
```
public class AggregateToCollectionOperation
extends java.lang.Object
implements AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.Void>
```
An operation that executes an aggregation that writes its results to a collection (which is what makes this a write operation rather than a read operation).

Since:

3.0

MongoDB documentation

Aggregation

Since server release

2.6

Constructor Summary

Constructors
Constructor and Description
`AggregateToCollectionOperation(MongoNamespace namespace, java.util.List<BsonDocument> pipeline)` Deprecated. Prefer `AggregateToCollectionOperation(MongoNamespace, List, WriteConcern)`
`AggregateToCollectionOperation(MongoNamespace namespace, java.util.List<BsonDocument> pipeline, WriteConcern writeConcern)` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AggregateToCollectionOperation`	`allowDiskUse(java.lang.Boolean allowDiskUse)` Enables writing to temporary files.
`ReadOperation<BsonDocument>`	`asExplainableOperation(ExplainVerbosity explainVerbosity)` Gets an operation whose execution explains this operation.
`AggregateToCollectionOperation`	`bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)` Sets the bypass document level validation flag.
`AggregateToCollectionOperation`	`collation(Collation collation)` Sets the collation options
`AggregateToCollectionOperation`	`comment(java.lang.String comment)` Sets the comment to the aggregation.
`java.lang.Void`	`execute(WriteBinding binding)` General execute which can return anything of type T
`void`	`executeAsync(AsyncWriteBinding binding, SingleResultCallback<java.lang.Void> callback)` General execute which can return anything of type T
`java.lang.Boolean`	`getAllowDiskUse()` Whether writing to temporary files is enabled.
`java.lang.Boolean`	`getBypassDocumentValidation()` Gets the bypass document level validation flag
`Collation`	`getCollation()` Returns the collation options
`java.lang.String`	`getComment()` Returns the comment to send with the aggregate.
`BsonDocument`	`getHint()` Returns the hint for which index to use.
`long`	`getMaxTime(java.util.concurrent.TimeUnit timeUnit)` Gets the maximum execution time on the server for this operation.
`java.util.List<BsonDocument>`	`getPipeline()` Gets the aggregation pipeline.
`WriteConcern`	`getWriteConcern()` Gets the write concern.
`AggregateToCollectionOperation`	`hint(BsonDocument hint)` Sets the hint for which index to use.
`AggregateToCollectionOperation`	`maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AggregateToCollectionOperation
```
@Deprecated
public AggregateToCollectionOperation(MongoNamespace namespace,
                                      java.util.List<BsonDocument> pipeline)
```
    Deprecated. Prefer AggregateToCollectionOperation(MongoNamespace, List, WriteConcern)
    
    Construct a new instance.
    
    Parameters:
    
    namespace - the database and collection namespace for the operation.
    
    pipeline - the aggregation pipeline.
  - AggregateToCollectionOperation
```
public AggregateToCollectionOperation(MongoNamespace namespace,
                                      java.util.List<BsonDocument> pipeline,
                                      WriteConcern writeConcern)
```
    Construct a new instance.
    
    Parameters:
    
    namespace - the database and collection namespace for the operation.
    
    pipeline - the aggregation pipeline.
    
    writeConcern - the write concern to apply
    
    Since:
    
    3.4
- Method Detail
  - getPipeline
```
public java.util.List<BsonDocument> getPipeline()
```
    Gets the aggregation pipeline.
    
    Returns:
    
    the pipeline
    
    MongoDB documentation
    
    Aggregation Pipeline
  - getWriteConcern
```
public WriteConcern getWriteConcern()
```
    Gets the write concern.
    
    Returns:
    
    the write concern, which may be null
    
    Since:
    
    3.4
  - getAllowDiskUse
```
public java.lang.Boolean getAllowDiskUse()
```
    Whether writing to temporary files is enabled. A null value indicates that it's unspecified.
    
    Returns:
    
    true if writing to temporary files is enabled
    
    MongoDB documentation
    
    Aggregation
    
    Since server release
    
    2.6
  - allowDiskUse
```
public AggregateToCollectionOperation allowDiskUse(java.lang.Boolean allowDiskUse)
```
    Enables writing to temporary files. A null value indicates that it's unspecified.
    
    Parameters:
    
    allowDiskUse - true if writing to temporary files is enabled
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Aggregation
    
    Since server release
    
    2.6
  - getMaxTime
```
public long getMaxTime(java.util.concurrent.TimeUnit timeUnit)
```
    Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
    
    Parameters:
    
    timeUnit - the time unit to return the result in
    
    Returns:
    
    the maximum execution time in the given time unit
    
    MongoDB documentation
    
    Max Time
  - maxTime
```
public AggregateToCollectionOperation maxTime(long maxTime,
                                              java.util.concurrent.TimeUnit timeUnit)
```
    Sets the maximum execution time on the server for this operation.
    
    Parameters:
    
    maxTime - the max time
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Max Time
  - getBypassDocumentValidation
```
public java.lang.Boolean getBypassDocumentValidation()
```
    Gets the bypass document level validation flag
    
    Returns:
    
    the bypass document level validation flag
    
    Since:
    
    3.2
  - bypassDocumentValidation
```
public AggregateToCollectionOperation bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)
```
    Sets the bypass document level validation flag.
    Note: This only applies when an $out stage is specified
    .
    
    Parameters:
    
    bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    Since server release
    
    3.2
  - getCollation
```
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    Since:
    
    3.4
    
    Since server release
    
    3.4
  - collation
```
public AggregateToCollectionOperation collation(Collation collation)
```
    Sets the collation options
    A null value represents the server default.
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
    
    Since:
    
    3.4
    
    Since server release
    
    3.4
  - getComment
```
public java.lang.String getComment()
```
    Returns the comment to send with the aggregate. The default is not to include a comment with the aggregation.
    
    Returns:
    
    the comment
    
    Since:
    
    3.6
    
    Since server release
    
    3.6
  - comment
```
public AggregateToCollectionOperation comment(java.lang.String comment)
```
    Sets the comment to the aggregation. A null value means no comment is set.
    
    Parameters:
    
    comment - the comment
    
    Returns:
    
    this
    
    Since:
    
    3.6
    
    Since server release
    
    3.6
  - getHint
```
public BsonDocument getHint()
```
    Returns the hint for which index to use. The default is not to set a hint.
    
    Returns:
    
    the hint
    
    Since:
    
    3.6
    
    Since server release
    
    3.6
  - hint
```
public AggregateToCollectionOperation hint(BsonDocument hint)
```
    Sets the hint for which index to use. A null value means no hint is set.
    
    Parameters:
    
    hint - the hint
    
    Returns:
    
    this
    
    Since:
    
    3.6
    
    Since server release
    
    3.6
  - asExplainableOperation
```
public ReadOperation<BsonDocument> asExplainableOperation(ExplainVerbosity explainVerbosity)
```
    Gets an operation whose execution explains this operation.
    
    Parameters:
    
    explainVerbosity - the explain verbosity
    
    Returns:
    
    a read operation that when executed will explain this operation
  - execute
```
public java.lang.Void execute(WriteBinding binding)
```
    Description copied from interface: WriteOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    execute in interface WriteOperation<java.lang.Void>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    Returns:
    
    T, the result of the execution
  - executeAsync
```
public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<java.lang.Void> callback)
```
    Description copied from interface: AsyncWriteOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    executeAsync in interface AsyncWriteOperation<java.lang.Void>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    callback - the callback to be called when the operation has been executed

Class AggregateToCollectionOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregateToCollectionOperation

AggregateToCollectionOperation

Method Detail

getPipeline

getWriteConcern

getAllowDiskUse

allowDiskUse

getMaxTime

maxTime

getBypassDocumentValidation

bypassDocumentValidation

getCollation

collation

getComment

comment

getHint

hint

asExplainableOperation

execute

executeAsync