list method

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

Retrieves a list of private connections in a given project and location.

Request parameters:

parent - Required. The parent that owns the collection of private connections. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.

orderBy - Order by fields for the result.

pageSize - Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

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

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

Completes with a ListPrivateConnectionsResponse.

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

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

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