Google Cloud Ai Platform V1 Client - Class UpdateExecutionRequest (1.4.0)

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

Request message for MetadataService.UpdateExecution.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ execution Google\Cloud\AIPlatform\V1\Execution

Required. The Execution containing updates. The Execution's Execution.name field is used to identify the Execution to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

↳ update_mask Google\Protobuf\FieldMask

Optional. A FieldMask indicating which fields should be updated.

↳ allow_missing bool

If set to true, and the Execution is not found, a new Execution is created.

getExecution

Required. The Execution containing updates.

The Execution's Execution.name field is used to identify the Execution to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

Returns
Type Description
Google\Cloud\AIPlatform\V1\Execution|null

hasExecution

clearExecution

setExecution

Required. The Execution containing updates.

The Execution's Execution.name field is used to identify the Execution to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\Execution
Returns
Type Description
$this

getUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getAllowMissing

If set to true, and the Execution is not found, a new Execution is created.

Returns
Type Description
bool

setAllowMissing

If set to true, and the Execution is not found, a new Execution is created.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
execution Google\Cloud\AIPlatform\V1\Execution

Required. The Execution containing updates. The Execution's Execution.name field is used to identify the Execution to be updated. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}

updateMask Google\Protobuf\FieldMask

Optional. A FieldMask indicating which fields should be updated.

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