list method

Future<ListPeeringRoutesResponse> list(String parent, { String? filter, int? pageSize, String? pageToken, String? $fields, })

Lists the network peering routes exchanged over a peering connection.

NetworkPeering is a global resource and location can only be global.

Request parameters:

parent - Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/networkPeerings/\[^/\]+$.

filter - A filter expression that matches resources returned in the response. Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

pageSize - The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

pageToken - A page token, received from a previous ListPeeringRoutes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPeeringRoutes must match the call that provided the page token.

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

Completes with a ListPeeringRoutesResponse.

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<ListPeeringRoutesResponse> 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') + '/peeringRoutes';

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