Package com.mongodb.client.model

Class Facet

java.lang.Object

com.mongodb.client.model.Facet

public class Facet
extends java.lang.Object

Defines a Facet for use in $facet pipeline stages.

Since:

3.4

MongoDB documentation

$facet

Since server release

3.4

Constructor Summary

Constructors

Constructor and Description
Facet(java.lang.String name, Bson... pipeline)
Facet(java.lang.String name, java.util.List<? extends Bson> pipeline)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
java.util.List<? extends Bson>	getPipeline()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Facet

public Facet(java.lang.String name,
             java.util.List<? extends Bson> pipeline)

Parameters:

name - the name of this facet

pipeline - the facet definition pipeline

Facet

public Facet(java.lang.String name,
             Bson... pipeline)

Parameters:

name - the name of this facet

pipeline - the facet definition pipeline

Method Detail

getName

public java.lang.String getName()

Returns:

the facet name

getPipeline

public java.util.List<? extends Bson> getPipeline()

Returns:

the pipeline definition