Google Workspace Events API (workspaceevents:v1)

Deletions

Methods


• ▼ ▲ workspaceevents.message.stream

  Path : v1/message:stream

  HTTP Method : POST

  Flat 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.subscribe

  Path : v1/{+name}:subscribe

  Parameter Order : name

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

  HTTP Method : GET

  Parameters :

  tenant

  Location : query

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Type : string

  name

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Location : path

  Type : string

  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.

• ▼ ▲ workspaceevents.tasks.cancel

  Parameters :

  name

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

  Location : path

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Type : string

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

  Path : v1/{+name}:cancel

  Parameter Order : name

  HTTP Method : POST

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

• ▼ ▲ workspaceevents.tasks.get

  Flat Path : v1/tasks/{tasksId}

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

  Path : v1/{+name}

  Parameter Order : name

  HTTP Method : GET

  Parameters :

  name

  Required : Yes

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

  Pattern : ^tasks/[^/]+$

  Type : string

  Location : path

  historyLength

  Location : query

  Type : integer

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

  Format : int32

  tenant

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Location : query

  Type : string

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.create

  Path : v1/{+parent}

  HTTP Method : POST

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

  Parameters :

  parent

  Type : string

  Required : Yes

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

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

  Location : path

  configId

  Description : Required. The ID for the new config.

  Location : query

  Type : string

  tenant

  Type : string

  Location : query

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Parameter Order : parent

  Description : Set a push notification config for a task.

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.delete

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

  Parameter Order : name

  Path : v1/{+name}

  Description : Delete a push notification config for a task.

  HTTP Method : DELETE

  Parameters :

  name

  Required : Yes

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

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

  Location : path

  Type : string

  tenant

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Location : query

  Type : string

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.list

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

  Path : v1/{+parent}/pushNotificationConfigs

  HTTP Method : GET

  Parameters :

  tenant

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Type : string

  Location : query

  pageSize

  Format : int32

  Location : query

  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.

  Type : integer

  parent

  Required : Yes

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

  Pattern : ^tasks/[^/]+$

  Location : path

  Type : string

  pageToken

  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.

  Location : query

  Type : string

  Parameter Order : parent

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

• ▼ ▲ workspaceevents.tasks.pushNotificationConfigs.get

  Description : Get a push notification config for a task.

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

  HTTP Method : GET

  Parameters :

  tenant

  Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

  Location : query

  Type : string

  name

  Location : path

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

  Required : Yes

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

  Type : string

  Parameter Order : name

  Path : v1/{+name}