list method

Future<ListSubscriptionsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists all subscriptions in a given project and location.

Request parameters:

parent - Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - An expression for filtering the results of the request. Eligible fields for filtering are: + listing + data_exchange Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters: + data_exchange="projects/myproject/locations/us/dataExchanges/123" + listing="projects/123/locations/us/dataExchanges/456/listings/789" + "projects/myproject/locations/us/dataExchanges/123"

pageSize - The maximum number of results to return in a single response page.

pageToken - Page token, returned by a previous call.

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

Completes with a ListSubscriptionsResponse.

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<ListSubscriptionsResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/subscriptions';

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