list method

Future<GoogleCloudApigeeV1ListApiProductsResponse> list(String parent, { String? attributename, String? attributevalue, String? count, bool? expand, String? startKey, String? $fields, })

Lists all API product names for an organization.

Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

Request parameters:

parent - Required. Name of the organization. Use the following structure in your request: organizations/{org} Value must have pattern ^organizations/\[^/\]+$.

attributename - Name of the attribute used to filter the search.

attributevalue - Value of the attribute used to filter the search.

count - Enter the number of API products you want returned in the API call. The limit is 1000.

expand - Flag that specifies whether to expand the results. Set to true to get expanded details about each API.

startKey - Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.

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

Completes with a GoogleCloudApigeeV1ListApiProductsResponse.

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<GoogleCloudApigeeV1ListApiProductsResponse> list(
  core.String parent, {
  core.String? attributename,
  core.String? attributevalue,
  core.String? count,
  core.bool? expand,
  core.String? startKey,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (attributename != null) 'attributename': [attributename],
    if (attributevalue != null) 'attributevalue': [attributevalue],
    if (count != null) 'count': [count],
    if (expand != null) 'expand': ['${expand}'],
    if (startKey != null) 'startKey': [startKey],
    if ($fields != null) 'fields': [$fields],
  };

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

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