list method

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

Lists key value entries for key values maps scoped to an organization, environment, or API proxy.

Note: Supported for Apigee hybrid 1.8.x and higher.

Request parameters:

parent - Required. Scope as indicated by the URI in which to list key value maps. Use one of the following structures in your request: * organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}. * organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}

  • organizations/{organization}/keyvaluemaps/{keyvaluemap}. If the KeyValueMap is under an API Proxy resource that 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/\[^/\]+/apis/\[^/\]+/keyvaluemaps/\[^/\]+$.

pageSize - Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.

pageToken - Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used to retrieve the next page.

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

Completes with a GoogleCloudApigeeV1ListKeyValueEntriesResponse.

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<GoogleCloudApigeeV1ListKeyValueEntriesResponse> 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') + '/entries';

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