Google Cloud Ai Platform V1 Client - Class PurgeArtifactsRequest (0.31.0)

Version 0.31.0

• 1.11.0 (latest)
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PurgeArtifactsRequest.

Request message for MetadataService.PurgeArtifacts.

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.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Returns
Type	Description
string

setParent

Required. The metadata store to purge Artifacts from.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

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 Google\Cloud\AIPlatform\V1\MetadataServiceClient::metadataStoreName() for help formatting this field.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\PurgeArtifactsRequest