list method

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

Lists Memberships in a given project and location.

Request parameters:

parent - Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects / * /locations / * . projects / * /locations/- list memberships in all the regions. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called foo: labels.foo:* - Memberships that have a label called foo whose value is bar: labels.foo = bar - Memberships in the CREATING state: state = CREATING

orderBy - Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

pageSize - Optional. When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

pageToken - Optional. Token returned by previous call to ListMemberships which specifies the position in the list from where to continue listing the resources.

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

Completes with a ListMembershipsResponse.

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<ListMembershipsResponse> 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') + '/memberships';

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