delete method

Future<GoogleCloudApigeeV1KeyValueEntry> delete(
  1. String name, {
  2. String? $fields,
})

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy.

Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

Request parameters:

name - Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: * organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}. * organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry} * organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}. Value must have pattern ^organizations/\[^/\]+/environments/\[^/\]+/keyvaluemaps/\[^/\]+/entries/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1KeyValueEntry.

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<GoogleCloudApigeeV1KeyValueEntry> delete(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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