Adds a single accumulator to those already configured.

This method can be called multiple times to add several accumulators.

Gets checkpoint interval.

Gets storage level for intermediate datasets that require multiple passes.

Gets whether local checkpoints are being used instead of regular checkpoints.

Executes the configured neighbor aggregation and returns the result DataFrame.

The result contains one row per (starting vertex, target vertex) pair that satisfied either the stopping condition or the target condition. Columns are:

• id: the vertex ID of the target (or stopping) vertex
• hop: the number of hops taken to reach it
• one column for each accumulator, holding its final value

Defines multiple accumulators used to compute values along each path.

Each accumulator has a name, an initial value expression, and an update expression. The update expression is evaluated at each hop and can refer to:

• the accumulator's previous value (using the accumulator's column name)
• source vertex attributes via srcAttr("attrName")
• destination vertex attributes via dstAttr("attrName")
• edge attributes via edgeAttr("attrName")

Sets checkpoint interval in terms of number of iterations (default: 2). Checkpointing regularly helps recover from failures, clean shuffle files, shorten the lineage of the computation graph, and reduce the complexity of plan optimization. As of Spark 2.0, the complexity of plan optimization would grow exponentially without checkpointing. Hence, disabling or setting longer-than-default checkpoint intervals are not recommended. Checkpoint data is saved under org.apache.spark.SparkContext.getCheckpointDir with prefix of the algorithm name. If the checkpoint directory is not set, this throws a java.io.IOException. Set a nonpositive value to disable checkpointing. This parameter is only used when the algorithm is set to "graphframes". Its default value might change in the future.

Filters which edges can be traversed during the aggregation.

Only edges satisfying the given column expression are considered. The default is true (all edges are traversable).

Sets storage level for intermediate datasets that require multiple passes (default: MEMORY_AND_DISK).

Sets the maximum number of hops to explore from the starting vertices.

The algorithm will stop after this many iterations even if the stopping condition hasn't been reached for all paths. The default is 3. Be aware that high value of max hops on a dense graph will lead to a huge memory load and potential OOM errors.

Controls whether self‑loops (edges where src == dst) are excluded.

Specifies which edge attributes should be carried through the traversal.

By default, all edge columns are carried. Specifying a subset can improve performance by reducing the amount of data shuffled.

Specifies which vertex attributes should be carried through the traversal.

By default, all vertex columns are carried. Specifying a subset can improve performance by reducing the amount of data shuffled.

Specifies which vertices to start the aggregation from.

Only vertices satisfying the given column expression will be used as seeds for the traversal. The default is true (all vertices are seeds).

Sets a condition that, when true for a vertex, stops further exploration along that path.

The column expression can refer to:

• accumulator columns
• source vertex attributes via srcAttr("attrName")
• destination vertex attributes via dstAttr("attrName")
• edge attributes via edgeAttr("attrName")

Either setStoppingCondition or setTargetCondition must be called. When both are provided only accumulators that reach targetCondition are saved to results.

Sets a condition that, when true for a vertex, marks it as a target and saves the accumulator values.

Either setStoppingCondition or setTargetCondition must be called. When both are provided only accumulators that reach targetCondition are saved to results.

Sets whether to use local checkpoints instead of regular checkpoints (default: false). Local checkpoints are faster but less reliable as they don't survive node failures.