list method

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

Lists Connections in a given project and location.

Request parameters:

parent - Required. Parent resource of the Connection, of the form: projects / * /locations / * Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Filter.

orderBy - Order by parameters.

pageSize - Page size.

pageToken - Page token.

view - Specifies which fields of the Connection are returned in the response. Defaults to BASIC view. Possible string values are:

  • "CONNECTION_VIEW_UNSPECIFIED" : CONNECTION_UNSPECIFIED.
  • "BASIC" : Do not include runtime required configs.
  • "FULL" : Include runtime required configs.

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

Completes with a ListConnectionsResponse.

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

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

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