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 and Description
GraphLookupOptions()

Method Summary

Modifier and Type	Method and Description
GraphLookupOptions	depthField(String field) The name of the field in which to store the depth value
String	getDepthField()
Integer	getMaxDepth()
GraphLookupOptions	maxDepth(Integer max) Specifies a maximum recursive depth for the $graphLookup.
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(String field)

The name of the field in which to store the depth value

Parameters:

field - the field name

Returns:

this

getDepthField

public String getDepthField()

Returns:

the field name

maxDepth

public GraphLookupOptions maxDepth(Integer max)

Specifies a maximum recursive depth for the $graphLookup. This number must be non-negative.

Parameters:

max - the maximum depth

Returns:

this

getMaxDepth

public Integer getMaxDepth()

Returns:

the maximum depth

toString

public String toString()

Overrides:

toString in class Object