Generated from protobuf message google.cloud.aiplatform.v1.PurgeArtifactsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The metadata store to purge Artifacts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
↳ filter
string
Required. A required filter matching the Artifacts to be purged. E.g., update_time <= 2020-11-19T11:30:00-04:00.
↳ force
bool
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.
getParent
Required. The metadata store to purge Artifacts from.
Required. A required filter matching the Artifacts to be purged.
E.g., update_time <= 2020-11-19T11:30:00-04:00.
Returns
Type
Description
string
setFilter
Required. A required filter matching the Artifacts to be purged.
E.g., update_time <= 2020-11-19T11:30:00-04:00.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getForce
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.
Returns
Type
Description
bool
setForce
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The metadata store to purge Artifacts from.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
Please see MetadataServiceClient::metadataStoreName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class PurgeArtifactsRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.PurgeArtifactsRequest)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.PurgeArtifactsRequest)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.PurgeArtifactsRequest)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.PurgeArtifactsRequest)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.PurgeArtifactsRequest)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.PurgeArtifactsRequest)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.PurgeArtifactsRequest)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.PurgeArtifactsRequest)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.PurgeArtifactsRequest)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.PurgeArtifactsRequest)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.PurgeArtifactsRequest)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.PurgeArtifactsRequest)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.PurgeArtifactsRequest)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.PurgeArtifactsRequest)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.PurgeArtifactsRequest)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.PurgeArtifactsRequest)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.PurgeArtifactsRequest)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.PurgeArtifactsRequest)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.PurgeArtifactsRequest)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.PurgeArtifactsRequest)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.PurgeArtifactsRequest)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.PurgeArtifactsRequest)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.PurgeArtifactsRequest)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.PurgeArtifactsRequest)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.PurgeArtifactsRequest)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.PurgeArtifactsRequest)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.PurgeArtifactsRequest)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.PurgeArtifactsRequest)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.PurgeArtifactsRequest)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.PurgeArtifactsRequest)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.PurgeArtifactsRequest)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.PurgeArtifactsRequest)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.PurgeArtifactsRequest)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.PurgeArtifactsRequest)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.PurgeArtifactsRequest)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.PurgeArtifactsRequest)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.PurgeArtifactsRequest)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.PurgeArtifactsRequest)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.PurgeArtifactsRequest)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.PurgeArtifactsRequest)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.PurgeArtifactsRequest)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.PurgeArtifactsRequest)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.PurgeArtifactsRequest)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.PurgeArtifactsRequest)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.PurgeArtifactsRequest)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.PurgeArtifactsRequest)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.PurgeArtifactsRequest)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.PurgeArtifactsRequest)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.PurgeArtifactsRequest)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.PurgeArtifactsRequest)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.PurgeArtifactsRequest)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.PurgeArtifactsRequest)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.PurgeArtifactsRequest)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.PurgeArtifactsRequest)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.PurgeArtifactsRequest)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.PurgeArtifactsRequest) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class PurgeArtifactsRequest.\n\nRequest message for\n[MetadataService.PurgeArtifacts](/php/docs/reference/cloud-ai-platform/latest/V1.Client.MetadataServiceClient#_Google_Cloud_AIPlatform_V1_Client_MetadataServiceClient__purgeArtifacts__).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.PurgeArtifactsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The metadata store to purge Artifacts from.\n\nFormat:\n`projects/{project}/locations/{location}/metadataStores/{metadatastore}`\n\n### setParent\n\nRequired. The metadata store to purge Artifacts from.\n\nFormat:\n`projects/{project}/locations/{location}/metadataStores/{metadatastore}`\n\n### getFilter\n\nRequired. A required filter matching the Artifacts to be purged.\n\nE.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.\n\n### setFilter\n\nRequired. A required filter matching the Artifacts to be purged.\n\nE.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.\n\n### getForce\n\nOptional. Flag to indicate to actually perform the purge.\n\nIf `force` is set to false, the method will return a sample of\nArtifact names that would be deleted.\n\n### setForce\n\nOptional. Flag to indicate to actually perform the purge.\n\nIf `force` is set to false, the method will return a sample of\nArtifact names that would be deleted.\n\n### static::build"]]
