list method

Future<ListLogicalProductsResponse> list({
  1. String? filter,
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists LogicalProducts matching given criteria.

Request parameters:

filter - Optional. The filter expression for listing logical products. Filter syntax: https://google.aip.dev/160 Supported fields: suite_id

pageSize - Optional. The maximum number of logical products to return. The service may return fewer than this value. If unspecified, at most 100 logical products will be returned. The maximum value is 500; values above 500 will be coerced to 500.

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

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

Completes with a ListLogicalProductsResponse.

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

  const url_ = 'v1/logicalProducts';

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