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
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: |
↳ filter |
string
Required. A required filter matching the Executions to be purged. E.g., |
↳ force |
bool
Optional. Flag to indicate to actually perform the purge. If |
getParent
Required. The metadata store to purge Executions from.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The metadata store to purge Executions from.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field bool force = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |