list method

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

Lists customer workloads for a given customer org id

Request parameters:

parent - Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer} Value must have pattern ^organizations/\[^/\]+/locations/\[^/\]+/customers/\[^/\]+$.

filter - Optional. Filtering results.

orderBy - Optional. Hint for how to order the results.

pageSize - The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

pageToken - A page token, received from a previous ListWorkloads call. Provide this to retrieve the subsequent page.

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

Completes with a ListWorkloadsResponse.

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<ListWorkloadsResponse> 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') + '/workloads';

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