Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::UpdateModelRequest (v0.31.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::UpdateModelRequest.

Request message for ModelService.UpdateModel.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#model

def model() -> ::Google::Cloud::AIPlatform::V1::Model
Returns
  • (::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.

#model=

def model=(value) -> ::Google::Cloud::AIPlatform::V1::Model
Parameter
  • value (::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.
Returns
  • (::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

def update_mask() -> ::Google::Protobuf::FieldMask
Returns

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
Returns