list method

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

Lists all Apigee runtime instances for the organization.

Note: Not supported for Apigee hybrid.

Request parameters:

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

pageSize - Maximum number of instances to return. Defaults to 25.

pageToken - Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.

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

Completes with a GoogleCloudApigeeV1ListInstancesResponse.

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

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

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