delete method

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

Deletes an API product from an organization.

Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

Request parameters:

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

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

Completes with a GoogleCloudApigeeV1ApiProduct.

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