AS AgentScopeAPI 手册 / API Reference

SandboxState

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type") public abstract class SandboxState
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:34–85

沙箱状态,承载智能体的部署、调度与服务化运行。位于 io.agentscope.harness.agent.sandbox 包。核心成员包括 getSessionId、setSessionId、getWorkspaceSpec、setWorkspaceSpec、getSnapshot、setSnapshot。

Serializable state of a sandbox, persisted by SessionSandboxStateStore so a sandbox can be resumed across calls.

The #workspaceRootReady flag drives the 4-branch start logic: it records whether the workspace was fully initialized at the last stop.

Concrete subtypes are registered for Jackson via io.agentscope.harness.agent.sandbox.json.HarnessSandboxJacksonModule (and optional com.fasterxml.jackson.databind.ObjectMapper#registerSubtypes for extension types), not via @JsonSubTypes on this class.

方法摘要Method Summary

方法Method说明Description
public String getSessionId()
获取会话标识。
Returns the session id.
public void setSessionId(String sessionId)
设置会话标识。
Sets the session id.
public WorkspaceSpec getWorkspaceSpec()
获取工作区规格。
Returns the workspace spec.
public void setWorkspaceSpec(WorkspaceSpec workspaceSpec)
设置工作区规格。
Sets the workspace spec.
public SandboxSnapshot getSnapshot()
获取快照。
Returns the snapshot.
public void setSnapshot(SandboxSnapshot snapshot)
设置快照。
Sets the snapshot.
public String getWorkspaceProjectionHash()
获取 `getWorkspaceProjectionHash`。
Returns the workspace projection hash.
public void setWorkspaceProjectionHash(String workspaceProjectionHash)
设置 `setWorkspaceProjectionHash`。
Sets the workspace projection hash.
public boolean isWorkspaceRootReady()
判断是否工作区根就绪。
Returns whether the workspace root ready.
public void setWorkspaceRootReady(boolean workspaceRootReady)
设置工作区根就绪。
Sets the workspace root ready.

方法详情Method Detail

getSessionId

public String getSessionId()

获取会话标识。

Returns the session id.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:46–48

setSessionId

public void setSessionId(String sessionId)

设置会话标识。

Sets the session id.

参数Parameters
名称Name类型Type说明Description
sessionIdString会话标识(类型 `String`)。The session id.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:50–52

getWorkspaceSpec

public WorkspaceSpec getWorkspaceSpec()

获取工作区规格。

Returns the workspace spec.

返回Returns WorkspaceSpec
返回WorkspaceSpec。Returns workspace spec.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:54–56

setWorkspaceSpec

public void setWorkspaceSpec(WorkspaceSpec workspaceSpec)

设置工作区规格。

Sets the workspace spec.

参数Parameters
名称Name类型Type说明Description
workspaceSpecWorkspaceSpec工作区规格(类型 `WorkspaceSpec`)。The workspace spec.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:58–60

getSnapshot

public SandboxSnapshot getSnapshot()

获取快照。

Returns the snapshot.

返回Returns SandboxSnapshot
返回SandboxSnapshot。Returns sandbox snapshot.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:62–64

setSnapshot

public void setSnapshot(SandboxSnapshot snapshot)

设置快照。

Sets the snapshot.

参数Parameters
名称Name类型Type说明Description
snapshotSandboxSnapshot快照(类型 `SandboxSnapshot`)。The snapshot.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:66–68

getWorkspaceProjectionHash

public String getWorkspaceProjectionHash()

获取 getWorkspaceProjectionHash。

Returns the workspace projection hash.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:70–72

setWorkspaceProjectionHash

public void setWorkspaceProjectionHash(String workspaceProjectionHash)

设置 setWorkspaceProjectionHash。

Sets the workspace projection hash.

参数Parameters
名称Name类型Type说明Description
workspaceProjectionHashString工作区 Projection Hash(类型 `String`)。The workspace projection hash.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:74–76

isWorkspaceRootReady

public boolean isWorkspaceRootReady()

判断是否工作区根就绪。

Returns whether the workspace root ready.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:78–80

setWorkspaceRootReady

public void setWorkspaceRootReady(boolean workspaceRootReady)

设置工作区根就绪。

Sets the workspace root ready.

参数Parameters
名称Name类型Type说明Description
workspaceRootReadyboolean工作区根就绪(类型 `boolean`)。The workspace root ready.
源码Source io/agentscope/harness/agent/sandbox/SandboxState.java:82–84
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.