Package com.google.cloud.aiplatform.v1

Class UpdateModelRequest

  • All Implemented Interfaces:
    UpdateModelRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class UpdateModelRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateModelRequestOrBuilder
     Request message for
 [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].
    Protobuf type google.cloud.aiplatform.v1.UpdateModelRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UpdateModelRequest.Builder
      Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MODEL_FIELD_NUMBER  
      static int UPDATE_MASK_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        hasModel in interface UpdateModelRequestOrBuilder
        Returns:
        Whether the model field is set.

      • 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];
        Specified by:
        getModel in interface UpdateModelRequestOrBuilder
        Returns:
        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];
        Specified by:
        getModelOrBuilder in interface UpdateModelRequestOrBuilder

      • hasUpdateMask

        public boolean hasUpdateMask()
         Required. The update mask applies to the resource.
 For the `FieldMask` definition, see
 [google.protobuf.FieldMask][google.protobuf.FieldMask].
        .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasUpdateMask in interface UpdateModelRequestOrBuilder
        Returns:
        Whether the updateMask field is set.

      • getUpdateMask

        public com.google.protobuf.FieldMask getUpdateMask()
         Required. The update mask applies to the resource.
 For the `FieldMask` definition, see
 [google.protobuf.FieldMask][google.protobuf.FieldMask].
        .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUpdateMask in interface UpdateModelRequestOrBuilder
        Returns:
        The updateMask.

      • getUpdateMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
         Required. The update mask applies to the resource.
 For the `FieldMask` definition, see
 [google.protobuf.FieldMask][google.protobuf.FieldMask].
        .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUpdateMaskOrBuilder in interface UpdateModelRequestOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UpdateModelRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UpdateModelRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public UpdateModelRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UpdateModelRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UpdateModelRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UpdateModelRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UpdateModelRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder