listMemberships method

Future<ListBoundMembershipsResponse> listMemberships(String scopeName, { String? filter, int? pageSize, String? pageToken, String? $fields, })

Lists Memberships bound to a Scope.

The response includes relevant Memberships from all regions.

Request parameters:

scopeName - Required. Name of the Scope, in the format projects / * /locations/global/scopes / * , to which the Memberships are bound. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/scopes/\[^/\]+$.

filter - Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's name, labels, create_time, update_time, and unique_id.

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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.

pageToken - Optional. Token returned by previous call to ListBoundMemberships 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 ListBoundMembershipsResponse.

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<ListBoundMembershipsResponse> listMemberships(
  core.String scopeName, {
  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('$scopeName') + ':listMemberships';

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