记录record io.agentscope.spring.boot.admin.command 2.x

AdminCommand

public record AdminCommand( String id, String title, String category, CommandPlane plane, String httpMethod, String httpPath, List<String> aliases, boolean writes, boolean idempotent, String description)

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

承载管理台命令数据的记录类型。位于 io.agentscope.spring.boot.admin.command 包。核心成员包括 id、title、category、plane、httpMethod、httpPath。

Self-describing record of an admin operation exposed by this starter.

The unified registry powers three views with the same metadata: REST routes, Actuator endpoints, and a machine-readable /actuator/agentscope-commands catalog used by CLI / Studio / Kubernetes operator clients.

记录组件摘要Record Component Summary

组件Component	类型Type	说明Description
`id`	String	执行标识相关操作。 stable internal id, e.g. `session.compact`
`title`	String	执行 `title` 方法。 human-friendly label, e.g. "Compact session"
`category`	String	执行类别相关操作。 coarse grouping, e.g. `AgentStateStore`, `Agent`, `System`
`plane`	CommandPlane	执行 `plane` 方法。 DATA = per-session REST; CONTROL = Actuator
`httpMethod`	String	执行HTTP 方法相关操作。 HTTP verb the command is reached with, e.g. `GET`, `POST`
`httpPath`	String	执行HTTP 路径相关操作。 full route from the application root, e.g. `/v1/admin/sessions/{sessionId}:compact`
`aliases`	List<String>	执行 `aliases` 方法。 extra display aliases (CLI-style, e.g. `summarize`)
`writes`	boolean	执行 `writes` 方法。 whether the command mutates state — disabled unless `agentscope.admin.write-enabled=true`
`idempotent`	boolean	执行 `idempotent` 方法。 whether repeated invocation is safe
`description`	String	执行 `description` 方法。 short one-liner shown in the catalog

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `AdminCommand(String id, String title, String category, CommandPlane plane, String httpMethod, String httpPath, List<String> aliases, boolean writes, boolean idempotent, String description)`	初始化 `AdminCommand` 实例。 Creates a new instance.

记录组件详情Record Component Detail

id

String id

执行标识相关操作。

stable internal id, e.g. session.compact

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

title

String title

执行 title 方法。

human-friendly label, e.g. "Compact session"

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

plane

CommandPlane plane

执行 plane 方法。

DATA = per-session REST; CONTROL = Actuator

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

httpMethod

String httpMethod

执行HTTP 方法相关操作。

HTTP verb the command is reached with, e.g. GET, POST

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

httpPath

String httpPath

执行HTTP 路径相关操作。

full route from the application root, e.g. /v1/admin/sessions/{sessionId}:compact

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

aliases

List<String> aliases

执行 aliases 方法。

extra display aliases (CLI-style, e.g. summarize)

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

writes

boolean writes

执行 writes 方法。

whether the command mutates state — disabled unless agentscope.admin.write-enabled=true

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

idempotent

boolean idempotent

执行 idempotent 方法。

whether repeated invocation is safe

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

description

String description

执行 description 方法。

short one-liner shown in the catalog

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:40–72

构造器详情Constructor Detail

AdminCommand

public AdminCommand(String id, String title, String category, CommandPlane plane, String httpMethod, String httpPath, List<String> aliases, boolean writes, boolean idempotent, String description)

初始化 AdminCommand 实例。

Creates a new instance.

参数Parameters

名称Name	类型Type	说明Description
`id`	String	标识（类型 `String`）。The id.
`title`	String	title（类型 `String`）。The title.
`category`	String	类别（类型 `String`）。The category.
`plane`	CommandPlane	plane（类型 `CommandPlane`）。The plane.
`httpMethod`	String	HTTP 方法（类型 `String`）。The http method.
`httpPath`	String	HTTP 路径（类型 `String`）。The http path.
`aliases`	List<String>	aliases（类型 `List`）。The aliases.
`writes`	boolean	writes（类型 `boolean`）。The writes.
`idempotent`	boolean	idempotent（类型 `boolean`）。The idempotent.
`description`	String	描述（类型 `String`）。The description.

源码Source io/agentscope/spring/boot/admin/command/AdminCommand.java:52–71