Google Cloud Ai Platform V1 Client - Class UpdateExecutionRequest (0.16.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

Methods

build

Parameters
NameDescription
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. Functionality of this field is not yet supported.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\UpdateExecutionRequest

__construct

Constructor.

Parameters
NameDescription
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. Functionality of this field is not yet supported.

↳ 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
TypeDescription
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
NameDescription
var Google\Cloud\AIPlatform\V1\Execution
Returns
TypeDescription
$this

getUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Functionality of this field is not yet supported.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. A FieldMask indicating which fields should be updated.

Functionality of this field is not yet supported.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getAllowMissing

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

Returns
TypeDescription
bool

setAllowMissing

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this