Class UpdateModelRequest.Builder (3.52.0)

public static final class UpdateModelRequest.Builder extends GeneratedMessageV3.Builder<UpdateModelRequest.Builder> implements UpdateModelRequestOrBuilder

Request message for ModelService.UpdateModel.

Protobuf type google.cloud.aiplatform.v1beta1.UpdateModelRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateModelRequest.Builder
Overrides

build()

public UpdateModelRequest build()
Returns
Type Description
UpdateModelRequest

buildPartial()

public UpdateModelRequest buildPartial()
Returns
Type Description
UpdateModelRequest

clear()

public UpdateModelRequest.Builder clear()
Returns
Type Description
UpdateModelRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateModelRequest.Builder
Overrides

clearModel()

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateModelRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateModelRequest.Builder
Overrides

clearUpdateMask()

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
Type Description
UpdateModelRequest.Builder

clone()

public UpdateModelRequest.Builder clone()
Returns
Type Description
UpdateModelRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateModelRequest getDefaultInstanceForType()
Returns
Type Description
UpdateModelRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getModel()

public 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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Model

The model.

getModelBuilder()

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Model.Builder

getModelOrBuilder()

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ModelOrBuilder

getUpdateMask()

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
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

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
Type Description
Builder

getUpdateMaskOrBuilder()

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
Type Description
FieldMaskOrBuilder

hasModel()

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the model field is set.

hasUpdateMask()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateModelRequest other)

public UpdateModelRequest.Builder mergeFrom(UpdateModelRequest other)
Parameter
Name Description
other UpdateModelRequest
Returns
Type Description
UpdateModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateModelRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateModelRequest.Builder
Overrides

mergeModel(Model value)

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Model
Returns
Type Description
UpdateModelRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateModelRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

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
Name Description
value FieldMask
Returns
Type Description
UpdateModelRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateModelRequest.Builder
Overrides

setModel(Model value)

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Model
Returns
Type Description
UpdateModelRequest.Builder

setModel(Model.Builder builderForValue)

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.

  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.v1beta1.Model model = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Model.Builder
Returns
Type Description
UpdateModelRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateModelRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateModelRequest.Builder
Overrides

setUpdateMask(FieldMask value)

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
Name Description
value FieldMask
Returns
Type Description
UpdateModelRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

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
Type Description
UpdateModelRequest.Builder