Packages

case class Filter(input: P.Value, as: String, cond: P.Document) extends PipelineOperator with Product with Serializable

The $filter aggregation stage.

input

the expression that resolves to an array

as

The variable name for the element in the input array. The as expression accesses each element in the input array by this variable.

cond

the expression that determines whether to include the element in the resulting array

Annotations
@deprecated
Deprecated

(Since version 0.19.4) Not a pipeline operator (stage)

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Filter
  2. Serializable
  3. Product
  4. Equals
  5. PipelineOperator
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Filter(input: P.Value, as: String, cond: P.Document)

    input

    the expression that resolves to an array

    as

    The variable name for the element in the input array. The as expression accesses each element in the input array by this variable.

    cond

    the expression that determines whether to include the element in the resulting array

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Filter toany2stringadd[Filter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Filter, B)
    Implicit
    This member is added by an implicit conversion from Filter toArrowAssoc[Filter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val as: String
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val cond: P.Document
  10. def ensuring(cond: (Filter) => Boolean, msg: => Any): Filter
    Implicit
    This member is added by an implicit conversion from Filter toEnsuring[Filter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Filter) => Boolean): Filter
    Implicit
    This member is added by an implicit conversion from Filter toEnsuring[Filter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Filter
    Implicit
    This member is added by an implicit conversion from Filter toEnsuring[Filter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Filter
    Implicit
    This member is added by an implicit conversion from Filter toEnsuring[Filter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Filter toStringFormat[Filter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val input: P.Value
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val makePipe: P.Document
    Definition Classes
    Filter → PipelineOperator
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (Filter, B)
    Implicit
    This member is added by an implicit conversion from Filter toArrowAssoc[Filter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFilter to any2stringadd[Filter]

Inherited by implicit conversion StringFormat fromFilter to StringFormat[Filter]

Inherited by implicit conversion Ensuring fromFilter to Ensuring[Filter]

Inherited by implicit conversion ArrowAssoc fromFilter to ArrowAssoc[Filter]

Ungrouped