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 Summary

Constructors

Constructor	Description
GraphLookupOptions()

Method Summary

Modifier and Type	Method	Description
GraphLookupOptions	depthField(String field)	The name of the field in which to store the depth value
String	getDepthField()
Integer	getMaxDepth()
Bson	getRestrictSearchWithMatch()
GraphLookupOptions	maxDepth(Integer max)	Specifies a maximum recursive depth for the $graphLookup.
GraphLookupOptions	restrictSearchWithMatch(Bson filter)	A document specifying additional conditions for the recursive search
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphLookupOptions

public GraphLookupOptions()

Method Detail

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

toString

public String toString()

Overrides:

toString in class Object