list method

Future<GoogleCloudApigeeV1ListApiProxiesResponse> list(
  1. String parent, {
  2. bool? includeMetaData,
  3. bool? includeRevisions,
  4. String? space,
  5. String? $fields,
})

Lists the names of all API proxies in an organization.

The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the space attribute set, the response may not return all resources. To learn more, read the Apigee Spaces Overview.

Request parameters:

parent - Required. Name of the organization in the following format: organizations/{org} If the resource has the space attribute set, IAM permissions are checked against the Space resource path. To learn more, read the Apigee Spaces Overview. Value must have pattern ^organizations/\[^/\]+$.

includeMetaData - Flag that specifies whether to include API proxy metadata in the response.

includeRevisions - Flag that specifies whether to include a list of revisions in the response.

space - Optional. The space ID to filter the list of proxies (optional). If unspecified, all proxies in the organization will be listed.

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

Completes with a GoogleCloudApigeeV1ListApiProxiesResponse.

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<GoogleCloudApigeeV1ListApiProxiesResponse> list(
  core.String parent, {
  core.bool? includeMetaData,
  core.bool? includeRevisions,
  core.String? space,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (includeMetaData != null) 'includeMetaData': ['${includeMetaData}'],
    if (includeRevisions != null) 'includeRevisions': ['${includeRevisions}'],
    if (space != null) 'space': [space],
    if ($fields != null) 'fields': [$fields],
  };

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

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