Package com.mongodb.client.model
Class GraphLookupOptions
-
- com.mongodb.client.model.GraphLookupOptions
-
public final class GraphLookupOptions extends
The options for a graphLookup aggregation pipeline stage- Since:
- 3.4
- MongoDB documentation
- Since server release
-
-
Constructor Summary
Constructors Constructor Description GraphLookupOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GraphLookupOptions
field)
The name of the field in which to store the depth valueboolean
o)
getDepthField()
getMaxDepth()
Bson
getRestrictSearchWithMatch()
int
hashCode()
GraphLookupOptions
max)
Specifies a maximum recursive depth for the $graphLookup.GraphLookupOptions
restrictSearchWithMatch(Bson filter)
A document specifying additional conditions for the recursive searchtoString()
-
-
-
Method Detail
-
depthField
public GraphLookupOptions depthField(@Nullable field)
The name of the field in which to store the depth value- Parameters:
field
- the field name- Returns:
- this
-
getDepthField
@Nullable public getDepthField()
- Returns:
- the field name
-
maxDepth
public GraphLookupOptions maxDepth(@Nullable 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 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( o)
- Overrides:
in class
-
hashCode
public int hashCode()
- Overrides:
in class
-
toString
public toString()
- Overrides:
in class
-
-