Google Workspace Events API (workspaceevents:v1)

Additions

Methods


• ▼ ▲ workspaceevents.getCard

  Path : v1/card

  HTTP Method : GET

  Description : GetAgentCard returns the agent card for the agent.

  Flat Path : v1/card

• ▼ ▲ workspaceevents.message.stream

  Flat Path : v1/message:stream

  HTTP Method : POST

  Path : v1/message:stream

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

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.create

  Path : v1/{+parent}

  Parameters :

  configId

  Type : string

  Location : query

  Description : Required. The ID for the new config.

  parent

  Type : string

  Description : Required. The parent task resource for this config. Format: tasks/{task_id}

  Required : Yes

  Pattern : ^tasks/[^/]+/pushNotificationConfigs$

  Location : path

  Description : Set a push notification config for a task.

  HTTP Method : POST

  Parameter Order : parent

  Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.delete

  Parameters :

  name

  Required : Yes

  Location : path

  Description : The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}

  Type : string

  Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$

  HTTP Method : DELETE

  Parameter Order : name

  Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}

  Description : Delete a push notification config for a task.

  Path : v1/{+name}

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.list

  Path : v1/{+parent}/pushNotificationConfigs

  Parameter Order : parent

  Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs

  HTTP Method : GET

  Description : Get a list of push notifications configured for a task.

  Parameters :

  pageToken

  Type : string

  Location : query

  Description : A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.

  parent

  Type : string

  Description : The parent task resource. Format: tasks/{task_id}

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Location : path

  pageSize

  Location : query

  Type : integer

  Format : int32

  Description : For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.get

  Description : Get a push notification config for a task.

  HTTP Method : GET

  Path : v1/{+name}

  Parameter Order : name

  Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}

  Parameters :

  name

  Type : string

  Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$

  Description : The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}

  Location : path

  Required : Yes

• ▼ ▲ workspaceevents.tasks.get

  Flat Path : v1/tasks/{tasksId}

  Parameters :

  historyLength

  Format : int32

  Location : query

  Type : integer

  Description : The number of most recent messages from the task's history to retrieve.

  name

  Location : path

  Description : Required. The resource name of the task. Format: tasks/{task_id}

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Type : string

  Parameter Order : name

  HTTP Method : GET

  Path : v1/{+name}

  Description : Get the current state of a task from the agent.

• ▼ ▲ workspaceevents.tasks.subscribe

  HTTP Method : GET

  Parameters :

  name

  Type : string

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Location : path

  Description : The resource name of the task to subscribe to. Format: tasks/{task_id}

  Description : 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.

  Parameter Order : name

  Flat Path : v1/tasks/{tasksId}:subscribe

  Path : v1/{+name}:subscribe

• ▼ ▲ workspaceevents.tasks.cancel

  Parameter Order : name

  Flat Path : v1/tasks/{tasksId}:cancel

  Parameters :

  name

  Pattern : ^tasks/[^/]+$

  Location : path

  Description : The resource name of the task to cancel. Format: tasks/{task_id}

  Type : string

  Required : Yes

  Path : v1/{+name}:cancel

  HTTP Method : POST

  Description : Cancel a task from the agent. If supported one should expect no more task updates for the task.