Back to Details

gws-events

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

events (v1)

events (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 events <resource> <method> [flags]

前提条件： 请阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果该文件缺失，请运行
gws generate-skills
命令生成它。

bash

gws events <resource> <method> [flags]

Helper Commands

辅助命令

Command	Description
`+subscribe`	Subscribe to Workspace events and stream them as NDJSON
`+renew`	Renew/reactivate Workspace Events subscriptions

命令	描述
`+subscribe`	订阅Workspace事件并以NDJSON格式流式传输
`+renew`	续订/重新激活Workspace Events订阅

API Resources

API资源

message

message

```
stream
```
— SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.

```
stream
```
— SendStreamingMessage是一个流式调用，会返回任务更新事件流，直到任务处于中断或终止状态。

operations

operations

```
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.

```
get
```
— 获取长时间运行操作的最新状态。客户端可按照API服务的建议，定期调用此方法轮询操作结果。

subscriptions

subscriptions

```
create
```
— Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.
- ```
delete
```
  — Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.
- ```
get
```
  — Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.
- ```
list
```
  — Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.
- ```
patch
```
  — Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.
- ```
reactivate
```
  — Reactivates a suspended Google Workspace subscription. This method resets your subscription's
```
State
```
  field to
```
ACTIVE
```
  . Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see Reactivate a Google Workspace subscription.

```
create
```
— 创建Google Workspace订阅。如需了解使用方法，请查看创建Google Workspace订阅。
- ```
delete
```
  — 删除Google Workspace订阅。如需了解使用方法，请查看删除Google Workspace订阅。
- ```
get
```
  — 获取Google Workspace订阅的详细信息。如需了解使用方法，请查看获取Google Workspace订阅详情。
- ```
list
```
  — 列出Google Workspace订阅。如需了解使用方法，请查看列出Google Workspace订阅。
- ```
patch
```
  — 更新或续订Google Workspace订阅。如需了解使用方法，请查看更新或续订Google Workspace订阅。
- ```
reactivate
```
  — 重新激活已暂停的Google Workspace订阅。此方法会将订阅的
```
State
```
  字段重置为
```
ACTIVE
```
  。使用此方法前，你必须修复导致订阅暂停的错误。此方法会忽略或拒绝任何当前未处于暂停状态的订阅。如需了解使用方法，请查看重新激活Google Workspace订阅。

tasks

tasks

```
cancel
```
— Cancel a task from the agent. If supported one should expect no more task updates for the task.
- ```
get
```
  — Get the current state of a task from the agent.
- ```
subscribe
```
  — TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.
- ```
pushNotificationConfigs
```
  — Operations on the 'pushNotificationConfigs' resource

```
cancel
```
— 从agent中取消任务。如果支持此操作，该任务将不再有更新。
- ```
get
```
  — 从agent中获取任务的当前状态。
- ```
subscribe
```
  — TaskSubscription是一个流式调用，会返回任务更新事件流。此操作会将流附加到现有进行中的任务。如果任务已完成，流会返回已完成的任务（类似GetTask）并关闭。
- ```
pushNotificationConfigs
```
  — 对'pushNotificationConfigs'资源的操作

Discovering Commands

命令探索

Before calling any API method, inspect it:

bash

undefined

调用任何API方法前，请先查看其详情：

bash

undefined

Browse resources and methods

Browse resources and methods

gws events --help

gws events --help

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

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

gws schema events.<resource>.<method>


Use `gws schema` output to build your `--params` and `--json` flags.

gws schema events.<resource>.<method>


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