list method

Future<ListTopicSubscriptionsResponse> list(
  1. String topic, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists the names of the attached subscriptions on this topic.

Request parameters:

topic - Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}. Value must have pattern ^projects/\[^/\]+/topics/\[^/\]+$.

pageSize - Optional. Maximum number of subscription names to return.

pageToken - Optional. The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

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

Completes with a ListTopicSubscriptionsResponse.

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

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

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