Method: catalogs.delete

Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method.

HTTP request

DELETE https://cloudprivatecatalogproducer.googleapis.com/v1beta1/{name=catalogs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The resource name of the catalog.

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudprivatecatalogproducer.catalogs.delete

Query parameters

Parameters
force

boolean

Forces deletion of the Catalog and its Association resources. If the Catalog is still associated with other resources and force is not set to true, then the operation fails.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Catalog.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!