Package org.bsc.langgraph4j

Class RunnableConfig

java.lang.Object

org.bsc.langgraph4j.RunnableConfig

All Implemented Interfaces:

HasMetadata

public final class RunnableConfig
extends Object
implements HasMetadata

A final class representing configuration for a runnable task. This class holds various parameters such as thread ID, checkpoint ID, next node, and stream mode, providing methods to modify these parameters safely without permanently altering the original configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RunnableConfig.Builder	A builder pattern class for constructing RunnableConfig objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_DISPATCHER
static final String	DISABLE_CLONE_STATE	Metadata key used to disable state cloning during graph execution.
static final String	GRAPH_ID
static final String	GRAPH_NODE_PATH
static final String	GRAPH_PATH
static final String	NODE_ID
static final String	STUDIO_METADATA_KEY	key that contains boolean value to inform that graph is executing in studio environment Warning: it is a RESERVED METADATA KEY don't use it
static final String	SUBGRAPH_RESUME_UPDATE_DATA

Method Summary

Modifier and Type	Method	Description
static RunnableConfig.Builder	builder()	Creates a new instance of the RunnableConfig.Builder class.
static RunnableConfig.Builder	builder(RunnableConfig config)	Creates a new Builder instance with the specified RunnableConfig.
Optional<String>	checkPointId()	Returns the current checkPointId wrapped in an Optional.
<State extends AgentState, Output extends NodeOutput<State>> GraphDefinition.Dispatcher<State,Output>	customDispatcher()
static RunnableConfig	empty()
Optional<String>	graphId()
GraphPath	graphPath()	Deprecated.
boolean	isCloneStateDisabled()	Returns whether state cloning is disabled for this runnable configuration.
boolean	isResumeSubgraph()
boolean	isRunningInStudio()	Checks if the graph is running within a studio environment.
Optional<Object>	metadata(String key)	return metadata value for key
Set<String>	metadataKeys()	return metadata keys
Optional<String>	nextNode()	Returns an Optional describing the next node in the sequence, or an empty Optional if there is no such node.
String	nodeId()
GraphPath	nodePath()	Returns the path of the currently executing node within the graph hierarchy.
Optional<Integer>	recursionLimit()	Returns the maximum number of iterations allowed for this invocation.
RunnableConfig	removeMetadata(String... keys)
CompiledGraph.StreamMode	streamMode()	Returns the stream mode of the compiled graph.
Optional<String>	threadId()	Returns the thread ID as an Optional.
String	toString()
RunnableConfig	updateMetadata(Map<String,Object> newMetadata)	Updates the metadata of the configuration with the provided new metadata.
RunnableConfig	withCheckPointId(String checkPointId)	Updates the checkpoint ID of the configuration.
RunnableConfig	withStreamMode(CompiledGraph.StreamMode streamMode)	Create a new RunnableConfig with the same attributes as this one but with a different CompiledGraph.StreamMode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bsc.langgraph4j.HasMetadata

metadata

Field Details

STUDIO_METADATA_KEY

public static final String STUDIO_METADATA_KEY

key that contains boolean value to inform that graph is executing in studio environment Warning: it is a RESERVED METADATA KEY don't use it

See Also:

• Constant Field Values

NODE_ID

public static final String NODE_ID

See Also:

• Constant Field Values

GRAPH_PATH

public static final String GRAPH_PATH

See Also:

• Constant Field Values

GRAPH_NODE_PATH

public static final String GRAPH_NODE_PATH

See Also:

• Constant Field Values

GRAPH_ID

public static final String GRAPH_ID

See Also:

• Constant Field Values

SUBGRAPH_RESUME_UPDATE_DATA

public static final String SUBGRAPH_RESUME_UPDATE_DATA

See Also:

• Constant Field Values

CUSTOM_DISPATCHER

public static final String CUSTOM_DISPATCHER

See Also:

• Constant Field Values

DISABLE_CLONE_STATE

public static final String DISABLE_CLONE_STATE

Metadata key used to disable state cloning during graph execution.

Since:

1.9

See Also:

• Constant Field Values

Method Details

builder

public static RunnableConfig.Builder builder()

Creates a new instance of the RunnableConfig.Builder class.

Returns:

A new Builder object.

builder

public static RunnableConfig.Builder builder(RunnableConfig config)

Creates a new Builder instance with the specified RunnableConfig.

Parameters:

config - The configuration for the Builder.

Returns:

A new Builder instance.

empty

public static RunnableConfig empty()

streamMode

public CompiledGraph.StreamMode streamMode()

Returns the stream mode of the compiled graph.

Returns:

StreamMode representing the current stream mode.

recursionLimit

public Optional<Integer> recursionLimit()

Returns the maximum number of iterations allowed for this invocation.

Returns:

an optional recursion limit, or empty when the graph default should be used

threadId

public Optional<String> threadId()

Returns the thread ID as an Optional.

Returns:

the thread ID wrapped in an Optional, or an empty Optional if no thread ID is set.

checkPointId

public Optional<String> checkPointId()

Returns the current checkPointId wrapped in an Optional.

Returns:

an Optional containing the checkPointId, or Optional.empty() if it is null.

nextNode

public Optional<String> nextNode()

Returns an Optional describing the next node in the sequence, or an empty Optional if there is no such node.

Returns:

an Optional describing the next node, or an empty Optional

withStreamMode

public RunnableConfig withStreamMode(CompiledGraph.StreamMode streamMode)

Create a new RunnableConfig with the same attributes as this one but with a different CompiledGraph.StreamMode.

Parameters:

streamMode - the new stream mode

Returns:

a new RunnableConfig with the updated stream mode

withCheckPointId

public RunnableConfig withCheckPointId(String checkPointId)

Updates the checkpoint ID of the configuration.

Parameters:

checkPointId - The new checkpoint ID to set.

Returns:

A new instance of RunnableConfig with the updated checkpoint ID, or the current instance if no change is needed.

updateMetadata

public RunnableConfig updateMetadata(Map<String,Object> newMetadata)

Updates the metadata of the configuration with the provided new metadata.

Parameters:

newMetadata - The map containing the new metadata to be merged.

Returns:

A new RunnableConfig instance with updated metadata, or the current instance if no changes are needed.

removeMetadata

public RunnableConfig removeMetadata(String... keys)

metadataKeys

public Set<String> metadataKeys()

Description copied from interface: HasMetadata

return metadata keys

Specified by:

metadataKeys in interface HasMetadata

Returns:

metadata keys if any or empty set

metadata

public Optional<Object> metadata(String key)

return metadata value for key

Specified by:

metadata in interface HasMetadata

Parameters:

key - given metadata key

Returns:

metadata value for key if any

isRunningInStudio

public boolean isRunningInStudio()

Checks if the graph is running within a studio environment.

Returns:

true if the STUDIO_METADATA_KEY metadata key is present and its value is true, false otherwise.

nodeId

public String nodeId()

graphId

public Optional<String> graphId()

graphPath

@Deprecated(since="1.9")
public GraphPath graphPath()

Deprecated.

nodePath

public GraphPath nodePath()

Returns the path of the currently executing node within the graph hierarchy.

Returns:

the current node path, or an empty GraphPath when no node path is set

Since:

1.9

isCloneStateDisabled

public boolean isCloneStateDisabled()

Returns whether state cloning is disabled for this runnable configuration.

Returns:

true if state cloning is disabled, false otherwise

Since:

1.9

isResumeSubgraph

public boolean isResumeSubgraph()

customDispatcher

public <State extends AgentState,
Output extends NodeOutput<State>>
GraphDefinition.Dispatcher<State,Output> customDispatcher()

toString

public String toString()

Overrides:

toString in class Object