Method: projects.locations.metadataStores.artifacts.purge

Purges Artifacts.

HTTP request

POST https://{service-endpoint}/v1beta1/{parent}/artifacts:purge

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Request body

The request body contains data with the following structure:

JSON representation
{
  "filter": string,
  "force": boolean
}
Fields
filter

string

Required. A required filter matching the Artifacts to be purged. E.g., updateTime <= 2020-11-19T11:30:00-04:00.

force

boolean

Optional. Flag to indicate to actually perform the purge. If force is set to false, the method will return a sample of Artifact names that would be deleted.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.artifacts.delete

For more information, see the IAM documentation.