Google Cloud Ai Platform V1 Client - Class PurgeArtifactsRequest (0.24.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
NameDescription
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
TypeDescription
string

setParent

Required. The metadata store to purge Artifacts from.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Required. A required filter matching the Artifacts to be purged.

E.g., update_time <= 2020-11-19T11:30:00-04:00.

Returns
TypeDescription
string

setFilter

Required. A required filter matching the Artifacts to be purged.

E.g., update_time <= 2020-11-19T11:30:00-04:00.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\AIPlatform\V1\PurgeArtifactsRequest