list method

Future<GoogleCloudApigeeV1ListAppsResponse> list(String parent, { String? apiProduct, String? apptype, bool? expand, String? filter, String? ids, bool? includeCred, String? keyStatus, int? pageSize, String? pageToken, String? rows, String? startKey, String? status, String? $fields, })

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

Request parameters:

parent - Required. Resource path of the parent in the following format: organizations/{org} Value must have pattern ^organizations/\[^/\]+$.

apiProduct - API product.

apptype - Optional. 'apptype' is no longer available. Use a 'filter' instead.

expand - Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.

filter - Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=[e-mail]", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.

ids - Optional. Comma-separated list of app IDs on which to filter.

includeCred - Optional. Flag that specifies whether to include credentials in the response.

keyStatus - Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.

pageSize - Optional. Count of apps a single page can have in the response. If unspecified, at most 1000 apps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. "page_size" is supported from ver 1.10.0 and above.

pageToken - Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.

rows - Optional. Maximum number of app IDs to return. Defaults to 1000, which is also the upper limit. To get more than 1000, use pagination with 'pageSize' and 'pageToken' parameters.

startKey - Returns the list of apps starting from the specified app ID.

status - Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.

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

Completes with a GoogleCloudApigeeV1ListAppsResponse.

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<GoogleCloudApigeeV1ListAppsResponse> list(
  core.String parent, {
  core.String? apiProduct,
  core.String? apptype,
  core.bool? expand,
  core.String? filter,
  core.String? ids,
  core.bool? includeCred,
  core.String? keyStatus,
  core.int? pageSize,
  core.String? pageToken,
  core.String? rows,
  core.String? startKey,
  core.String? status,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'apiProduct': ?apiProduct == null ? null : [apiProduct],
    'apptype': ?apptype == null ? null : [apptype],
    'expand': ?expand == null ? null : ['${expand}'],
    'filter': ?filter == null ? null : [filter],
    'ids': ?ids == null ? null : [ids],
    'includeCred': ?includeCred == null ? null : ['${includeCred}'],
    'keyStatus': ?keyStatus == null ? null : [keyStatus],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'rows': ?rows == null ? null : [rows],
    'startKey': ?startKey == null ? null : [startKey],
    'status': ?status == null ? null : [status],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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