subscribe method

Future<SubscribeListingResponse> subscribe(
  1. SubscribeListingRequest request,
  2. String name, {
  3. String? $fields,
})

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

request - The metadata request object.

Request parameters:

name - Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/dataExchanges/\[^/\]+/listings/\[^/\]+$.

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

Completes with a SubscribeListingResponse.

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<SubscribeListingResponse> subscribe(
  SubscribeListingRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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