Package com.google.cloud.aiplatform.v1

Class DeployRequest.ModelConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder>
com.google.cloud.aiplatform.v1.DeployRequest.ModelConfig.Builder
All Implemented Interfaces:
DeployRequest.ModelConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DeployRequest.ModelConfig
public static final class DeployRequest.ModelConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder> implements DeployRequest.ModelConfigOrBuilder
 The model config to use for the deployment.
Protobuf type google.cloud.aiplatform.v1.DeployRequest.ModelConfig

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder>

    • clear

      public DeployRequest.ModelConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder>

    • getDefaultInstanceForType

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

    • build

      public DeployRequest.ModelConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public DeployRequest.ModelConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public DeployRequest.ModelConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployRequest.ModelConfig.Builder>

    • mergeFrom

      public DeployRequest.ModelConfig.Builder mergeFrom(DeployRequest.ModelConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DeployRequest.ModelConfig.Builder>

    • mergeFrom

      public DeployRequest.ModelConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeployRequest.ModelConfig.Builder>
      Throws:
      IOException

    • getAcceptEula

      public boolean getAcceptEula()
       Optional. Whether the user accepts the End User License Agreement (EULA)
 for the model.
      bool accept_eula = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAcceptEula in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The acceptEula.

    • setAcceptEula

      public DeployRequest.ModelConfig.Builder setAcceptEula(boolean value)
       Optional. Whether the user accepts the End User License Agreement (EULA)
 for the model.
      bool accept_eula = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The acceptEula to set.
      Returns:
      This builder for chaining.

    • clearAcceptEula

      public DeployRequest.ModelConfig.Builder clearAcceptEula()
       Optional. Whether the user accepts the End User License Agreement (EULA)
 for the model.
      bool accept_eula = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getHuggingFaceAccessToken

      public String getHuggingFaceAccessToken()
       Optional. The Hugging Face read access token used to access the model
 artifacts of gated models.
      string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHuggingFaceAccessToken in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The huggingFaceAccessToken.

    • getHuggingFaceAccessTokenBytes

      public com.google.protobuf.ByteString getHuggingFaceAccessTokenBytes()
       Optional. The Hugging Face read access token used to access the model
 artifacts of gated models.
      string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHuggingFaceAccessTokenBytes in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The bytes for huggingFaceAccessToken.

    • setHuggingFaceAccessToken

      public DeployRequest.ModelConfig.Builder setHuggingFaceAccessToken(String value)
       Optional. The Hugging Face read access token used to access the model
 artifacts of gated models.
      string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The huggingFaceAccessToken to set.
      Returns:
      This builder for chaining.

    • clearHuggingFaceAccessToken

      public DeployRequest.ModelConfig.Builder clearHuggingFaceAccessToken()
       Optional. The Hugging Face read access token used to access the model
 artifacts of gated models.
      string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setHuggingFaceAccessTokenBytes

      public DeployRequest.ModelConfig.Builder setHuggingFaceAccessTokenBytes(com.google.protobuf.ByteString value)
       Optional. The Hugging Face read access token used to access the model
 artifacts of gated models.
      string hugging_face_access_token = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for huggingFaceAccessToken to set.
      Returns:
      This builder for chaining.

    • getHuggingFaceCacheEnabled

      public boolean getHuggingFaceCacheEnabled()
       Optional. If true, the model will deploy with a cached version instead of
 directly downloading the model artifacts from Hugging Face. This is
 suitable for VPC-SC users with limited internet access.
      bool hugging_face_cache_enabled = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHuggingFaceCacheEnabled in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The huggingFaceCacheEnabled.

    • setHuggingFaceCacheEnabled

      public DeployRequest.ModelConfig.Builder setHuggingFaceCacheEnabled(boolean value)
       Optional. If true, the model will deploy with a cached version instead of
 directly downloading the model artifacts from Hugging Face. This is
 suitable for VPC-SC users with limited internet access.
      bool hugging_face_cache_enabled = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The huggingFaceCacheEnabled to set.
      Returns:
      This builder for chaining.

    • clearHuggingFaceCacheEnabled

      public DeployRequest.ModelConfig.Builder clearHuggingFaceCacheEnabled()
       Optional. If true, the model will deploy with a cached version instead of
 directly downloading the model artifacts from Hugging Face. This is
 suitable for VPC-SC users with limited internet access.
      bool hugging_face_cache_enabled = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getModelDisplayName

      public String getModelDisplayName()
       Optional. The user-specified display name of the uploaded model. If not
 set, a default name will be used.
      string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelDisplayName in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The modelDisplayName.

    • getModelDisplayNameBytes

      public com.google.protobuf.ByteString getModelDisplayNameBytes()
       Optional. The user-specified display name of the uploaded model. If not
 set, a default name will be used.
      string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelDisplayNameBytes in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The bytes for modelDisplayName.

    • setModelDisplayName

      public DeployRequest.ModelConfig.Builder setModelDisplayName(String value)
       Optional. The user-specified display name of the uploaded model. If not
 set, a default name will be used.
      string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The modelDisplayName to set.
      Returns:
      This builder for chaining.

    • clearModelDisplayName

      public DeployRequest.ModelConfig.Builder clearModelDisplayName()
       Optional. The user-specified display name of the uploaded model. If not
 set, a default name will be used.
      string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setModelDisplayNameBytes

      public DeployRequest.ModelConfig.Builder setModelDisplayNameBytes(com.google.protobuf.ByteString value)
       Optional. The user-specified display name of the uploaded model. If not
 set, a default name will be used.
      string model_display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for modelDisplayName to set.
      Returns:
      This builder for chaining.

    • hasContainerSpec

      public boolean hasContainerSpec()
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasContainerSpec in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      Whether the containerSpec field is set.

    • getContainerSpec

      public ModelContainerSpec getContainerSpec()
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContainerSpec in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The containerSpec.

    • setContainerSpec

      public DeployRequest.ModelConfig.Builder setContainerSpec(ModelContainerSpec value)
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

    • setContainerSpec

      public DeployRequest.ModelConfig.Builder setContainerSpec(ModelContainerSpec.Builder builderForValue)
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

    • mergeContainerSpec

      public DeployRequest.ModelConfig.Builder mergeContainerSpec(ModelContainerSpec value)
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

    • clearContainerSpec

      public DeployRequest.ModelConfig.Builder clearContainerSpec()
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getContainerSpecBuilder

      public ModelContainerSpec.Builder getContainerSpecBuilder()
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getContainerSpecOrBuilder

      public ModelContainerSpecOrBuilder getContainerSpecOrBuilder()
       Optional. The specification of the container that is to be used when
 deploying. If not set, the default container spec will be used.
      .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContainerSpecOrBuilder in interface DeployRequest.ModelConfigOrBuilder

    • getModelUserId

      public String getModelUserId()
       Optional. The ID to use for the uploaded Model, which will become the
 final component of the model resource name. When not provided, Vertex AI
 will generate a value for this ID. When Model Registry model is provided,
 this field will be ignored.

 This value may be up to 63 characters, and valid characters are
 `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelUserId in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The modelUserId.

    • getModelUserIdBytes

      public com.google.protobuf.ByteString getModelUserIdBytes()
       Optional. The ID to use for the uploaded Model, which will become the
 final component of the model resource name. When not provided, Vertex AI
 will generate a value for this ID. When Model Registry model is provided,
 this field will be ignored.

 This value may be up to 63 characters, and valid characters are
 `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelUserIdBytes in interface DeployRequest.ModelConfigOrBuilder
      Returns:
      The bytes for modelUserId.

    • setModelUserId

      public DeployRequest.ModelConfig.Builder setModelUserId(String value)
       Optional. The ID to use for the uploaded Model, which will become the
 final component of the model resource name. When not provided, Vertex AI
 will generate a value for this ID. When Model Registry model is provided,
 this field will be ignored.

 This value may be up to 63 characters, and valid characters are
 `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The modelUserId to set.
      Returns:
      This builder for chaining.

    • clearModelUserId

      public DeployRequest.ModelConfig.Builder clearModelUserId()
       Optional. The ID to use for the uploaded Model, which will become the
 final component of the model resource name. When not provided, Vertex AI
 will generate a value for this ID. When Model Registry model is provided,
 this field will be ignored.

 This value may be up to 63 characters, and valid characters are
 `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setModelUserIdBytes

      public DeployRequest.ModelConfig.Builder setModelUserIdBytes(com.google.protobuf.ByteString value)
       Optional. The ID to use for the uploaded Model, which will become the
 final component of the model resource name. When not provided, Vertex AI
 will generate a value for this ID. When Model Registry model is provided,
 this field will be ignored.

 This value may be up to 63 characters, and valid characters are
 `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      string model_user_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for modelUserId to set.
      Returns:
      This builder for chaining.