Packages

c

org.mongodb.scala

AggregateObservable

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

Observable for aggregate

TResult

The type of the result.

wrapped

the underlying java AggregateObservable

Since

1.0

Linear Supertypes
Serializable, Product, Equals, Observable[TResult], com.mongodb.async.client.Observable[TResult], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregateObservable
  2. Serializable
  3. Product
  4. Equals
  5. Observable
  6. Observable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AggregateObservable(wrapped: AggregateIterable[TResult])

    wrapped

    the underlying java AggregateObservable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def batchSize(batchSize: Int): AggregateObservable[TResult]

    Sets the number of documents to return per batch.

    Sets the number of documents to return per batch.

    batchSize

    the batch size

    returns

    this

    Since

    2.7

  7. 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

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. 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

    A null value represents the server default.

    ,

    Requires MongoDB 3.4 or greater

  10. 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

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. 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

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. 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

  17. 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

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. 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
  23. 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.

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. 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

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. 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

    (Since version 2.2) No replacement for this method

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