delete method

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

Deletes an app's consumer key and removes all API products associated with the app.

After the consumer key is deleted, it cannot be used to access any APIs. Note: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required.

Request parameters:

name - Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key} Value must have pattern ^organizations/\[^/\]+/developers/\[^/\]+/apps/\[^/\]+/keys/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1DeveloperAppKey.

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<GoogleCloudApigeeV1DeveloperAppKey> 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 GoogleCloudApigeeV1DeveloperAppKey.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}