AS AgentScopeAPI 手册 / API Reference

DockerSandboxClient

public class DockerSandboxClient implements SandboxClient<DockerSandboxClientOptions>
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:39–160

Docker 沙箱客户端,封装与远端服务的连接和调用。位于 io.agentscope.harness.agent.sandbox.impl.docker 包,实现 SandboxClient<DockerSandboxClientOptions>。核心成员包括 create、resume、delete、serializeState、deserializeState、DockerSandboxClient。

SandboxClient implementation for the Docker sandbox store.

Creates and manages Docker containers via the docker CLI. The Docker daemon must be accessible from the host's PATH.

构造器摘要Constructor Summary

构造器Constructor说明Description
public DockerSandboxClient()
初始化 `DockerSandboxClient` 实例。
Creates a new instance.
public DockerSandboxClient(ObjectMapper objectMapper)
初始化 `DockerSandboxClient` 实例。
Uses the given mapper as-is.

方法摘要Method Summary

方法Method说明Description
public Sandbox create(WorkspaceSpec workspaceSpec, SandboxSnapshotSpec snapshotSpec, DockerSandboxClientOptions options)
创建并返回实例。
Creates and returns an instance.
public Sandbox resume(SandboxState state)
设置恢复。
Performs the resume operation.
public void delete(Sandbox sandbox)
删除数据。
Performs the delete operation.
public String serializeState(SandboxState state)
执行状态。
Performs the serialize state operation.
public SandboxState deserializeState(String json)
执行状态。
Performs the deserialize state operation.
public SandboxState deserializeState(String json, SandboxSnapshotSpec snapshotSpec)
执行状态。
Performs the deserialize state operation.

构造器详情Constructor Detail

DockerSandboxClient

public DockerSandboxClient()

初始化 DockerSandboxClient 实例。

Creates a new instance.

源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:45–50

DockerSandboxClient

public DockerSandboxClient(ObjectMapper objectMapper)

初始化 DockerSandboxClient 实例。

Uses the given mapper as-is.

参数Parameters
名称Name类型Type说明Description
objectMapperObjectMapper对象 Mapper(类型 `ObjectMapper`)。The object mapper.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:57–59

方法详情Method Detail

create

public Sandbox create(WorkspaceSpec workspaceSpec, SandboxSnapshotSpec snapshotSpec, DockerSandboxClientOptions options)

创建并返回实例。

Creates and returns an instance.

参数Parameters
名称Name类型Type说明Description
workspaceSpecWorkspaceSpec工作区规格(类型 `WorkspaceSpec`)。The workspace spec.
snapshotSpecSandboxSnapshotSpec快照规格(类型 `SandboxSnapshotSpec`)。The snapshot spec.
optionsDockerSandboxClientOptions选项(类型 `DockerSandboxClientOptions`)。The options.
返回Returns Sandbox
返回沙箱。Returns sandbox.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:61–97

resume

public Sandbox resume(SandboxState state)

设置恢复。

Performs the resume operation.

参数Parameters
名称Name类型Type说明Description
stateSandboxState状态对象(类型 `SandboxState`)。The state.
返回Returns Sandbox
返回沙箱。Returns sandbox.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:99–110

delete

public void delete(Sandbox sandbox)

删除数据。

Performs the delete operation.

参数Parameters
名称Name类型Type说明Description
sandboxSandbox沙箱(类型 `Sandbox`)。The sandbox.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:112–115

serializeState

public String serializeState(SandboxState state)

执行状态。

Performs the serialize state operation.

参数Parameters
名称Name类型Type说明Description
stateSandboxState状态对象(类型 `SandboxState`)。The state.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:117–125

deserializeState

public SandboxState deserializeState(String json)

执行状态。

Performs the deserialize state operation.

参数Parameters
名称Name类型Type说明Description
jsonStringJSON(类型 `String`)。The json.
返回Returns SandboxState
返回SandboxState。Returns sandbox state.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:127–135

deserializeState

public SandboxState deserializeState(String json, SandboxSnapshotSpec snapshotSpec)

执行状态。

Performs the deserialize state operation.

参数Parameters
名称Name类型Type说明Description
jsonStringJSON(类型 `String`)。The json.
snapshotSpecSandboxSnapshotSpec快照规格(类型 `SandboxSnapshotSpec`)。The snapshot spec.
返回Returns SandboxState
返回SandboxState。Returns sandbox state.
源码Source io/agentscope/harness/agent/sandbox/impl/docker/DockerSandboxClient.java:137–147
基于官方固定版本源码静态生成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.