list method
Lists all apps created by a developer in an Apigee organization.
Optionally, you can request an expanded view of the developer apps. A
maximum of 100 developer apps are returned per API call. You can paginate
the list of deveoper apps returned using the startKey
and count
query
parameters.
Request parameters:
parent
- Required. Name of the developer. Use the following structure in
your request: organizations/{org}/developers/{developer_email}
Value must have pattern ^organizations/\[^/\]+/developers/\[^/\]+$
.
count
- Number of developer apps to return in the API call. Use with the
startKey
parameter to provide more targeted filtering. The limit is
1000.
expand
- Optional. Specifies whether to expand the results. Set to
true
to expand the results. This query parameter is not valid if you use
the count
or startKey
query parameters.
shallowExpand
- Optional. Specifies whether to expand the results in
shallow mode. Set to true
to expand the results in shallow mode.
startKey
- Note: Must be used in conjunction with the count
parameter. Name of the developer app from which to start displaying the
list of developer apps. For example, if you're returning 50 developer apps
at a time (using the count
query parameter), you can view developer apps
50-99 by entering the name of the 50th developer app. The developer app
name is case sensitive.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApigeeV1ListDeveloperAppsResponse.
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<GoogleCloudApigeeV1ListDeveloperAppsResponse> list(
core.String parent, {
core.String? count,
core.bool? expand,
core.bool? shallowExpand,
core.String? startKey,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (count != null) 'count': [count],
if (expand != null) 'expand': ['${expand}'],
if (shallowExpand != null) 'shallowExpand': ['${shallowExpand}'],
if (startKey != null) 'startKey': [startKey],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/apps';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApigeeV1ListDeveloperAppsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}