subscribe method

Future<StreamResponse> subscribe(
  1. String name, {
  2. String? tenant,
  3. String? $fields,
})

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.

Request parameters:

name - The resource name of the task to subscribe to. Format: tasks/{task_id} Value must have pattern ^tasks/\[^/\]+$.

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

$fields - Selector specifying which fields to include in a partial response.

Completes with a StreamResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<StreamResponse> subscribe(
  core.String name, {
  core.String? tenant,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'tenant': ?tenant == null ? null : [tenant],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':subscribe';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return StreamResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}