2026-09-03
▼ ▲ cloudbilling.getCard
Description : GetAgentCard returns the agent card for the agent.
Scopes :
Parameters :
tenant
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Type : string
Location : query
Flat Path : v1/card
Path : v1/card
HTTP Method : GET
▼ ▲ cloudbilling.message.send
Flat Path : v1/message:send
Description : Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
Scopes :
Path : v1/message:send
HTTP Method : POST
▼ ▲ cloudbilling.message.stream
Flat Path : v1/message:stream
Scopes :
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.
HTTP Method : POST
Path : v1/message:stream
▼ ▲ cloudbilling.tasks.cancel
Parameter Order : name
Flat Path : v1/tasks/{tasksId}:cancel
HTTP Method : POST
Path : v1/{+name}:cancel
Parameters :
name
Location : path
Pattern : ^tasks/[^/]+$
Description : The resource name of the task to cancel. Format: tasks/{task_id}
Required : Yes
Type : string
Description : Cancel a task from the agent. If supported one should expect no more task updates for the task.
Scopes :
▼ ▲ cloudbilling.tasks.subscribe
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.
Scopes :
Path : v1/{+name}:subscribe
HTTP Method : GET
Flat Path : v1/tasks/{tasksId}:subscribe
Parameter Order : name
Parameters :
tenant
Location : query
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Type : string
name
Location : path
Description : The resource name of the task to subscribe to. Format: tasks/{task_id}
Pattern : ^tasks/[^/]+$
Required : Yes
Type : string
▼ ▲ cloudbilling.tasks.get
Parameters :
tenant
Type : string
Location : query
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
historyLength
Type : integer
Format : int32
Description : The number of most recent messages from the task's history to retrieve.
Location : query
name
Required : Yes
Pattern : ^tasks/[^/]+$
Location : path
Type : string
Description : Required. The resource name of the task. Format: tasks/{task_id}
Description : Get the current state of a task from the agent.
Scopes :
Parameter Order : name
Path : v1/{+name}
HTTP Method : GET
Flat Path : v1/tasks/{tasksId}
▼ ▲ cloudbilling.tasks.pushNotificationConfigs.create
Description : Set a push notification config for a task.
Parameter Order : parent
Path : v1/{+parent}
HTTP Method : POST
Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs
Parameters :
tenant
Location : query
Type : string
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
configId
Location : query
Description : Required. The ID for the new config.
Type : string
parent
Description : Required. The parent task resource for this config. Format: tasks/{task_id}
Type : string
Required : Yes
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Location : path
Scopes :
▼ ▲ cloudbilling.tasks.pushNotificationConfigs.get
Parameter Order : name
Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Scopes :
HTTP Method : GET
Description : Get a push notification config for a task.
Path : v1/{+name}
Parameters :
name
Description : The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Location : path
Type : string
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Required : Yes
tenant
Location : query
Type : string
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
▼ ▲ cloudbilling.tasks.pushNotificationConfigs.delete
Description : Delete a push notification config for a task.
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Scopes :
Parameters :
tenant
Type : string
Location : query
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
name
Description : The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
Required : Yes
Type : string
Location : path
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Path : v1/{+name}
▼ ▲ cloudbilling.tasks.pushNotificationConfigs.list
Flat Path : v1/tasks/{tasksId}/pushNotificationConfigs
Scopes :
Path : v1/{+parent}/pushNotificationConfigs
Description : Get a list of push notifications configured for a task.
Parameter Order : parent
Parameters :
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
tenant
Type : string
Description : Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
Location : query
parent
Description : The parent task resource. Format: tasks/{task_id}
Pattern : ^tasks/[^/]+$
Location : path
Type : string
Required : Yes
pageSize
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.
Type : integer
Location : query
HTTP Method : GET