Package org.bsc.langgraph4j

Class RunnableConfig.Builder

java.lang.Object

org.bsc.langgraph4j.HasMetadata.Builder<RunnableConfig.Builder>

org.bsc.langgraph4j.RunnableConfig.Builder

Enclosing class:

RunnableConfig

public static class RunnableConfig.Builder
extends HasMetadata.Builder<RunnableConfig.Builder>

A builder pattern class for constructing RunnableConfig objects. This class provides a fluent interface to set various properties of a RunnableConfig object and then build the final configuration.

Method Summary

Modifier and Type	Method	Description
RunnableConfig.Builder	addParallelNodeExecutor(String nodeId, Executor executor)	Adds a custom Executor for a specific parallel node.
RunnableConfig	build()	Constructs and returns the configured RunnableConfig object.
RunnableConfig.Builder	checkPointId(String checkPointId)	Sets the checkpoint ID for the configuration.
RunnableConfig.Builder	disableCloneState()	Disables state cloning during graph execution.
RunnableConfig.Builder	graphId(String graphId)
RunnableConfig.Builder	nextNode(String nextNode)	Sets the next node in the configuration and returns this builder for method chaining.
RunnableConfig.Builder	recursionLimit(int recursionLimit)	Sets the maximum number of iterations allowed for this invocation.
RunnableConfig.Builder	streamMode(CompiledGraph.StreamMode streamMode)	Sets the stream mode of the configuration.
RunnableConfig.Builder	threadId(String threadId)	Sets the ID of the thread.

Methods inherited from class org.bsc.langgraph4j.HasMetadata.Builder

addMetadata, metadata, putMetadata, putMetadata, putMetadataIfAbsent, removeMetadata, this$

Methods inherited from class java.lang.Object

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

Method Details

graphId

public RunnableConfig.Builder graphId(String graphId)

threadId

public RunnableConfig.Builder threadId(String threadId)

Sets the ID of the thread.

Parameters:

threadId - the ID of the thread to set

Returns:

a reference to this Builder object so that method calls can be chained together

checkPointId

public RunnableConfig.Builder checkPointId(String checkPointId)

Sets the checkpoint ID for the configuration.

Parameters:

checkPointId - - the ID of the checkpoint to be set

Returns:

this - a reference to the current `Builder` instance

nextNode

public RunnableConfig.Builder nextNode(String nextNode)

Sets the next node in the configuration and returns this builder for method chaining.

Parameters:

nextNode - The next node to be set.

Returns:

This builder instance, allowing for method chaining.

streamMode

public RunnableConfig.Builder streamMode(CompiledGraph.StreamMode streamMode)

Sets the stream mode of the configuration.

Parameters:

streamMode - The CompiledGraph.StreamMode to set.

Returns:

A reference to this builder for method chaining.

recursionLimit

public RunnableConfig.Builder recursionLimit(int recursionLimit)

Sets the maximum number of iterations allowed for this invocation.

Parameters:

recursionLimit - the maximum number of iterations, greater than zero

Returns:

this builder

addParallelNodeExecutor

public RunnableConfig.Builder addParallelNodeExecutor(String nodeId,
 Executor executor)

Adds a custom Executor for a specific parallel node.

This allows you to control the execution of branches within a parallel node. When a parallel node is executed, it will look for an executor in the RunnableConfig metadata. If found, it will be used to run the parallel branches concurrently.

Parameters:

nodeId - the ID of the parallel node.

executor - the Executor to use for the parallel node.

Returns:

this Builder instance for method chaining.

disableCloneState

public RunnableConfig.Builder disableCloneState()

Disables state cloning during graph execution.

When state cloning is disabled, state exposed outside the graph boundary is not guaranteed to be immutable and may reflect subsequent mutations.

Returns:

this Builder instance for method chaining

Since:

1.9

build

public RunnableConfig build()

Constructs and returns the configured RunnableConfig object.

Returns:

the configured RunnableConfig object