Google Cloud Ai Platform V1 Client - Class UpdateModelRequest (0.32.0)

Version 0.32.0

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

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

Request message for ModelService.UpdateModel.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ model	Google\Cloud\AIPlatform\V1\Model Required. The Model which replaces the resource on the server. When Model Versioning is enabled, the model.name will be used to determine whether to update the model or model version. 1. model.name with the @ value, e.g. models/123@1, refers to a version specific update. 2. model.name without the @ value, e.g. models/123, refers to a model update. 3. model.name with @-, e.g. models/123@-, refers to a model update. 4. Supported model fields: display_name, description; supported version-specific fields: version_description. Labels are supported in both scenarios. Both the model labels and the version labels are merged when a model is returned. When updating labels, if the request is for model-specific update, model label gets updated. Otherwise, version labels get updated. 5. A model name or model version name fields update mismatch will cause a precondition error. 6. One request cannot update both the model and the version fields. You must update them separately.
↳ update_mask	Google\Protobuf\FieldMask Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

getModel

Required. The Model which replaces the resource on the server.

When Model Versioning is enabled, the model.name will be used to determine whether to update the model or model version.

1. model.name with the @ value, e.g. models/123@1, refers to a version specific update.
2. model.name without the @ value, e.g. models/123, refers to a model update.
3. model.name with @-, e.g. models/123@-, refers to a model update.
4. Supported model fields: display_name, description; supported version-specific fields: version_description. Labels are supported in both scenarios. Both the model labels and the version labels are merged when a model is returned. When updating labels, if the request is for model-specific update, model label gets updated. Otherwise, version labels get updated.
5. A model name or model version name fields update mismatch will cause a precondition error.
6. One request cannot update both the model and the version fields. You must update them separately.

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

hasModel

clearModel

setModel

Required. The Model which replaces the resource on the server.

When Model Versioning is enabled, the model.name will be used to determine whether to update the model or model version.

1. model.name with the @ value, e.g. models/123@1, refers to a version specific update.
2. model.name without the @ value, e.g. models/123, refers to a model update.
3. model.name with @-, e.g. models/123@-, refers to a model update.
4. Supported model fields: display_name, description; supported version-specific fields: version_description. Labels are supported in both scenarios. Both the model labels and the version labels are merged when a model is returned. When updating labels, if the request is for model-specific update, model label gets updated. Otherwise, version labels get updated.
5. A model name or model version name fields update mismatch will cause a precondition error.
6. One request cannot update both the model and the version fields. You must update them separately.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\Model

Returns
Type	Description
$this

getUpdateMask

Required. The update mask applies to the resource.

For the FieldMask definition, see google.protobuf.FieldMask.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. The update mask applies to the resource.

For the FieldMask definition, see google.protobuf.FieldMask.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::build

Parameters
Name	Description
model	Google\Cloud\AIPlatform\V1\Model Required. The Model which replaces the resource on the server. When Model Versioning is enabled, the model.name will be used to determine whether to update the model or model version. model.name with the @ value, e.g. models/123@1, refers to a version specific update. model.name without the @ value, e.g. models/123, refers to a model update. model.name with @-, e.g. models/123@-, refers to a model update. Supported model fields: display_name, description; supported version-specific fields: version_description. Labels are supported in both scenarios. Both the model labels and the version labels are merged when a model is returned. When updating labels, if the request is for model-specific update, model label gets updated. Otherwise, version labels get updated. A model name or model version name fields update mismatch will cause a precondition error. One request cannot update both the model and the version fields. You must update them separately.
updateMask	Google\Protobuf\FieldMask Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

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