gws-vault

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

vault (v1)

vault (v1)

PREREQUISITE: Read
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run
gws generate-skills
to create it.
bash
gws vault <resource> <method> [flags]
前置要求: 阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果缺少该文件,请运行
gws generate-skills
命令创建它。
bash
gws vault <resource> <method> [flags]

API Resources

API资源

matters

matters

  • addPermissions
    — Adds an account as a matter collaborator.
    • close
      — Closes the specified matter. Returns the matter with updated state.
    • count
      — Counts the accounts processed by the specified query.
    • create
      — Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
    • delete
      — Deletes the specified matter. Returns the matter with updated state.
    • get
      — Gets the specified matter.
    • list
      — Lists matters the requestor has access to.
    • removePermissions
      — Removes an account as a matter collaborator.
    • reopen
      — Reopens the specified matter. Returns the matter with updated state.
    • undelete
      — Undeletes the specified matter. Returns the matter with updated state.
    • update
      — Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
    • exports
      — Operations on the 'exports' resource
    • holds
      — Operations on the 'holds' resource
    • savedQueries
      — Operations on the 'savedQueries' resource
  • addPermissions
    — 添加一个账号作为事务协作者。
    • close
      — 关闭指定的事务。返回状态已更新的事务。
    • count
      — 统计指定查询处理的账号数量。
    • create
      — 使用给定的名称和描述创建事务。初始状态为开启,所有者为调用该方法的用户。返回默认视图的已创建事务。
    • delete
      — 删除指定的事务。返回状态已更新的事务。
    • get
      — 获取指定的事务。
    • list
      — 列出请求者有权访问的事务。
    • removePermissions
      — 移除账号的事务协作者权限。
    • reopen
      — 重新开启指定的事务。返回状态已更新的事务。
    • undelete
      — 恢复已删除的指定事务。返回状态已更新的事务。
    • update
      — 更新指定的事务。仅更新事务的名称和描述(通过事务ID识别)。对其他字段的更改将被忽略。返回事务的默认视图。
    • exports
      — 对'exports'资源的操作
    • holds
      — 对'holds'资源的操作
    • savedQueries
      — 对'savedQueries'资源的操作

operations

operations

  • cancel
    — Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns
    google.rpc.Code.UNIMPLEMENTED
    . Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
    • delete
      — Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns
      google.rpc.Code.UNIMPLEMENTED
      .
    • get
      — Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
    • list
      — Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns
      UNIMPLEMENTED
      .
  • cancel
    — 启动对长期运行操作的异步取消。服务器会尽力取消操作,但不保证成功。如果服务器不支持此方法,将返回
    google.rpc.Code.UNIMPLEMENTED
    。客户端可以使用Operations.GetOperation或其他方法检查取消是否成功,或者操作是否已完成。
    • delete
      — 删除长期运行的操作。此方法表示客户端不再关注操作结果,但不会取消操作。如果服务器不支持此方法,将返回
      google.rpc.Code.UNIMPLEMENTED
    • get
      — 获取长期运行操作的最新状态。客户端可以按照API服务推荐的时间间隔,使用此方法轮询操作结果。
    • list
      — 列出与请求中指定筛选条件匹配的操作。如果服务器不支持此方法,将返回
      UNIMPLEMENTED

Discovering Commands

命令探索

Before calling any API method, inspect it:
bash
undefined
在调用任何API方法之前,请先查看其详情:
bash
undefined

Browse resources and methods

浏览资源和方法

gws vault --help
gws vault --help

Inspect a method's required params, types, and defaults

查看方法的必填参数、类型和默认值

gws schema vault.<resource>.<method>

Use `gws schema` output to build your `--params` and `--json` flags.
gws schema vault.<resource>.<method>

使用`gws schema`的输出来构建你的`--params`和`--json`标志。