Package com.mongodb.client.model

Class FusionPipeline

java.lang.Object
com.mongodb.client.model.FusionPipeline
public final class FusionPipeline extends Object
A named aggregation pipeline used as an input to a fusion pipeline stage, e.g., $scoreFusion. The name uniquely identifies the pipeline within the stage and may be referred to by other parts of the stage, e.g., as the "$$name" variable in a combination expression. A name must not be empty, must not start with $, and must not contain . or the null character.
Since:
5.10
Since server release
8.2

  • Method Details

    • of

      public static FusionPipeline of(String name, List<? extends Bson> pipeline)
      Creates a new FusionPipeline.
      Parameters:
      name - The pipeline name, unique within the containing stage. It must not be empty, must not start with $, and must not contain . or the null character.
      pipeline - The non-empty pipeline.
      Returns:
      The requested FusionPipeline.

    • of

      public static FusionPipeline of(String name, Bson... pipeline)
      Creates a new FusionPipeline.
      Parameters:
      name - The pipeline name, unique within the containing stage. It must not be empty, must not start with $, and must not contain . or the null character.
      pipeline - The non-empty pipeline.
      Returns:
      The requested FusionPipeline.

    • getName

      public String getName()
      Returns:
      the pipeline name

    • getPipeline

      public List<? extends Bson> getPipeline()
      Returns:
      the pipeline

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object