Interface UpdateModelRequestOrBuilder (3.17.0)

Version 3.17.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface UpdateModelRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getModel()

public abstract Model 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.

.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Model	The model.

getModelOrBuilder()

public abstract ModelOrBuilder getModelOrBuilder()

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.

.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ModelOrBuilder

getUpdateMask()

public abstract FieldMask getUpdateMask()

Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FieldMask	The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FieldMaskOrBuilder

hasModel()

public abstract boolean hasModel()

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.

.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the model field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the updateMask field is set.