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 \ V1Methods
__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 |
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.
- 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.
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.
- 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.
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.
|
updateMask |
Google\Protobuf\FieldMask
Required. The update mask applies to the resource.
For the |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\UpdateModelRequest |