Method: projects.locations.collections.engines.assistants.agents.tasks.subscribe

tasks.subscribe 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 tasks.get) and close the stream.

HTTP request

GET https://discoveryengine.googleapis.com/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/{name=tasks/*}:subscribe

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
tenant

string

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

name

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains a stream of StreamResponse instances.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.