Package com.mongodb.client.model

Class GraphLookupOptions

java.lang.Object
com.mongodb.client.model.GraphLookupOptions
public final class GraphLookupOptions extends Object
The options for a graphLookup aggregation pipeline stage
Since:
3.4
MongoDB documentation
graphLookup
Since server release
3.4

  • Constructor Details

    • GraphLookupOptions

      public GraphLookupOptions()

  • Method Details

    • depthField

      public GraphLookupOptions depthField(@Nullable String field)
      The name of the field in which to store the depth value
      Parameters:
      field - the field name
      Returns:
      this

    • getDepthField

      @Nullable public String getDepthField()
      Returns:
      the field name

    • maxDepth

      public GraphLookupOptions maxDepth(@Nullable Integer max)
      Specifies a maximum recursive depth for the $graphLookup. This number must be non-negative.
      Parameters:
      max - the maximum depth
      Returns:
      this

    • getMaxDepth

      @Nullable public Integer getMaxDepth()
      Returns:
      the maximum depth

    • restrictSearchWithMatch

      public GraphLookupOptions restrictSearchWithMatch(@Nullable Bson filter)
      A document specifying additional conditions for the recursive search
      Parameters:
      filter - the filter expression
      Returns:
      this
      Since:
      3.6

    • getRestrictSearchWithMatch

      @Nullable public Bson getRestrictSearchWithMatch()
      Returns:
      the filter expression
      Since:
      3.6

    • 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