AggregateObservable

Instance Constructors

new AggregateObservable(wrapped: AggregateIterable[TResult])

wrapped
the underlying java AggregateObservable

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def allowDiskUse(allowDiskUse: Boolean): AggregateObservable[TResult]

Enables writing to temporary files.
Enables writing to temporary files. A null value indicates that it's unspecified.
Aggregation
allowDiskUse
true if writing to temporary files is enabled
returns
this
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bypassDocumentValidation(bypassDocumentValidation: Boolean): AggregateObservable[TResult]

Sets the bypass document level validation flag.
Sets the bypass document level validation flag.
Note:: This only applies when an $out stage is specified.
Aggregation
bypassDocumentValidation
If true, allows the write to opt-out of document level validation.
returns
this

Since
1.1
Note
Requires MongoDB 3.2 or greater
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collation(collation: Collation): AggregateObservable[TResult]

Sets the collation options
Sets the collation options
collation
the collation options to use
returns
this

Since
1.2
Note
Requires MongoDB 3.4 or greater
,
A null value represents the server default.
def comment(comment: String): AggregateObservable[TResult]

Sets the comment to the aggregation.
Sets the comment to the aggregation. A null value means no comment is set.
comment
the comment
returns
this

Since
2.2
Note
Requires MongoDB 3.6 or greater
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hint(hint: Bson): AggregateObservable[TResult]

Sets the hint for which index to use.
Sets the hint for which index to use. A null value means no hint is set.
hint
the hint
returns
this

Since
2.2
Note
Requires MongoDB 3.6 or greater
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def maxAwaitTime(duration: Duration): AggregateObservable[TResult]

Sets the maximum await execution time on the server for this operation.
Sets the maximum await execution time on the server for this operation.
Max Time
duration
the duration
returns
this

Since
2.2
Note
Requires MongoDB 3.6 or greater
def maxTime(duration: Duration): AggregateObservable[TResult]

Sets the maximum execution time on the server for this operation.
Sets the maximum execution time on the server for this operation.
Max Time
duration
the duration
returns
this
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def subscribe(observer: Observer[_ >: TResult]): Unit

Request Observable to start streaming data.
Request Observable to start streaming data.
This is a "factory method" and can be called multiple times, each time starting a new Subscription. Each Subscription will work for only a single Observer.
If the Observable rejects the subscription attempt or otherwise fails it will signal the error via Observer.onError.
observer
the Observer that will consume signals from this Observable

Definition Classes
AggregateObservable → Observable
def subscribe(observer: com.mongodb.async.client.Observer[_ >: TResult]): Unit

Handles the automatic boxing of a Java Observable so it conforms to the interface.
Handles the automatic boxing of a Java Observable so it conforms to the interface.
observer
the Observer that will consume signals from this Observable

Definition Classes
Observable → Observable
Note
Users should not have to implement this method but rather use the Scala Observable.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toCollection(): Observable[Completed]

Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
Aggregation
returns
a Observable with a single element indicating when the operation has completed
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def useCursor(useCursor: Boolean): AggregateObservable[TResult]

Sets whether the server should use a cursor to return results.
Sets whether the server should use a cursor to return results.
Aggregation
useCursor
whether the server should use a cursor to return results
returns
this

Annotations
@Deprecated
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.

Related Doc: package scala

case class AggregateObservable[TResult](wrapped: AggregateIterable[TResult]) extends Observable[TResult] with Product with Serializable

Instance Constructors

new AggregateObservable(wrapped: AggregateIterable[TResult])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def allowDiskUse(allowDiskUse: Boolean): AggregateObservable[TResult]

final def asInstanceOf[T0]: T0

def bypassDocumentValidation(bypassDocumentValidation: Boolean): AggregateObservable[TResult]

def clone(): AnyRef

def collation(collation: Collation): AggregateObservable[TResult]

def comment(comment: String): AggregateObservable[TResult]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hint(hint: Bson): AggregateObservable[TResult]

final def isInstanceOf[T0]: Boolean

def maxAwaitTime(duration: Duration): AggregateObservable[TResult]

def maxTime(duration: Duration): AggregateObservable[TResult]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def subscribe(observer: Observer[_ >: TResult]): Unit

def subscribe(observer: com.mongodb.async.client.Observer[_ >: TResult]): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toCollection(): Observable[Completed]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def useCursor(useCursor: Boolean): AggregateObservable[TResult]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Observable[TResult]

Inherited from com.mongodb.async.client.Observable[TResult]

Inherited from AnyRef

Inherited from Any

Ungrouped