Google Cloud Ai Platform V1 Client - Class PurgeExecutionsRequest (0.38.0)

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

Request message for MetadataService.PurgeExecutions.

Generated from protobuf message google.cloud.aiplatform.v1.PurgeExecutionsRequest

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 Executions from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
↳ filter string

Required. A required filter matching the Executions 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 Execution names that would be deleted.

getParent

Required. The metadata store to purge Executions from.

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

Returns
Type Description
string

setParent

Required. The metadata store to purge Executions from.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Required. A required filter matching the Executions 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 Executions 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 Execution 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 Execution 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 Executions 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\PurgeExecutionsRequest