Class UpdateModelRequest (3.56.0)

public final class UpdateModelRequest extends GeneratedMessageV3 implements UpdateModelRequestOrBuilder

Request message for ModelService.UpdateModel.

Protobuf type google.cloud.aiplatform.v1.UpdateModelRequest

Static Fields

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateModelRequest getDefaultInstance()
Returns
Type Description
UpdateModelRequest

getDescriptor()

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

newBuilder()

public static UpdateModelRequest.Builder newBuilder()
Returns
Type Description
UpdateModelRequest.Builder

newBuilder(UpdateModelRequest prototype)

public static UpdateModelRequest.Builder newBuilder(UpdateModelRequest prototype)
Parameter
Name Description
prototype UpdateModelRequest
Returns
Type Description
UpdateModelRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateModelRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateModelRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateModelRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateModelRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateModelRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateModelRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateModelRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateModelRequest> parser()
Returns
Type Description
Parser<UpdateModelRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateModelRequest getDefaultInstanceForType()
Returns
Type Description
UpdateModelRequest

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

Returns
Type Description
Model

The model.

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

Returns
Type Description
ModelOrBuilder

getParserForType()

public Parser<UpdateModelRequest> getParserForType()
Returns
Type Description
Parser<UpdateModelRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.v1.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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateModelRequest.Builder newBuilderForType()
Returns
Type Description
UpdateModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateModelRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateModelRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateModelRequest.Builder toBuilder()
Returns
Type Description
UpdateModelRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException