public static final class UpdateModelRequest.Builder extends GeneratedMessageV3.Builder<UpdateModelRequest.Builder> implements UpdateModelRequestOrBuilder
Request message for
ModelService.UpdateModel.
Protobuf type google.cloud.aiplatform.v1.UpdateModelRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public UpdateModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public UpdateModelRequest build()
Returns
public UpdateModelRequest buildPartial()
Returns
public UpdateModelRequest.Builder clear()
Returns
Overrides
public UpdateModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public UpdateModelRequest.Builder clearModel()
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
public UpdateModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public UpdateModelRequest.Builder clearUpdateMask()
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
public UpdateModelRequest.Builder clone()
Returns
Overrides
public UpdateModelRequest getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
Model | The model.
|
public Model.Builder getModelBuilder()
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
public 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.
- 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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
public 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
public FieldMask.Builder getUpdateMaskBuilder()
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
public 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
public 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.
- 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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the model field is set.
|
public 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.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public UpdateModelRequest.Builder mergeFrom(UpdateModelRequest other)
Parameter
Returns
public UpdateModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public UpdateModelRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public UpdateModelRequest.Builder mergeModel(Model value)
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
value | Model
|
Returns
public final UpdateModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public UpdateModelRequest.Builder mergeUpdateMask(FieldMask value)
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];
Parameter
Returns
public UpdateModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public UpdateModelRequest.Builder setModel(Model value)
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
value | Model
|
Returns
public UpdateModelRequest.Builder setModel(Model.Builder builderForValue)
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.
.google.cloud.aiplatform.v1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
public UpdateModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final UpdateModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public UpdateModelRequest.Builder setUpdateMask(FieldMask value)
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];
Parameter
Returns
public UpdateModelRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)
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];
Parameter
Name | Description |
builderForValue | Builder
|
Returns