Package com.google.cloud.aiplatform.v1beta1

Class DeployPublisherModelRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DeployPublisherModelRequest.Builder>
com.google.cloud.aiplatform.v1beta1.DeployPublisherModelRequest.Builder
All Implemented Interfaces:
DeployPublisherModelRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DeployPublisherModelRequest
public static final class DeployPublisherModelRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<DeployPublisherModelRequest.Builder> implements DeployPublisherModelRequestOrBuilder
 Request message for
 [ModelGardenService.DeployPublisherModel][google.cloud.aiplatform.v1beta1.ModelGardenService.DeployPublisherModel].
Protobuf type google.cloud.aiplatform.v1beta1.DeployPublisherModelRequest

  • 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<DeployPublisherModelRequest.Builder>

    • clear

      public DeployPublisherModelRequest.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<DeployPublisherModelRequest.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<DeployPublisherModelRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DeployPublisherModelRequest.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<DeployPublisherModelRequest.Builder>

    • mergeFrom

      public DeployPublisherModelRequest.Builder mergeFrom(DeployPublisherModelRequest other)

    • isInitialized

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

    • mergeFrom

      public DeployPublisherModelRequest.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<DeployPublisherModelRequest.Builder>
      Throws:
      IOException

    • getModel

      public String getModel()
       Required. The model to deploy.
 Format:
 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
 `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
 2. Hugging Face model ID like `google/gemma-2-2b-it`.
 3. Custom model Google Cloud Storage URI like `gs://bucket`.
 4. Custom model zip file like `https://example.com/a.zip`.
      string model = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModel in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Required. The model to deploy.
 Format:
 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
 `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
 2. Hugging Face model ID like `google/gemma-2-2b-it`.
 3. Custom model Google Cloud Storage URI like `gs://bucket`.
 4. Custom model zip file like `https://example.com/a.zip`.
      string model = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelBytes in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The bytes for model.

    • setModel

      public DeployPublisherModelRequest.Builder setModel(String value)
       Required. The model to deploy.
 Format:
 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
 `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
 2. Hugging Face model ID like `google/gemma-2-2b-it`.
 3. Custom model Google Cloud Storage URI like `gs://bucket`.
 4. Custom model zip file like `https://example.com/a.zip`.
      string model = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The model to set.
      Returns:
      This builder for chaining.

    • clearModel

      public DeployPublisherModelRequest.Builder clearModel()
       Required. The model to deploy.
 Format:
 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
 `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
 2. Hugging Face model ID like `google/gemma-2-2b-it`.
 3. Custom model Google Cloud Storage URI like `gs://bucket`.
 4. Custom model zip file like `https://example.com/a.zip`.
      string model = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setModelBytes

      public DeployPublisherModelRequest.Builder setModelBytes(com.google.protobuf.ByteString value)
       Required. The model to deploy.
 Format:
 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
 `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
 2. Hugging Face model ID like `google/gemma-2-2b-it`.
 3. Custom model Google Cloud Storage URI like `gs://bucket`.
 4. Custom model zip file like `https://example.com/a.zip`.
      string model = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for model to set.
      Returns:
      This builder for chaining.

    • getDestination

      public String getDestination()
       Required. The resource name of the Location to deploy the model in.
 Format: `projects/{project}/locations/{location}`
      string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDestination in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The destination.

    • getDestinationBytes

      public com.google.protobuf.ByteString getDestinationBytes()
       Required. The resource name of the Location to deploy the model in.
 Format: `projects/{project}/locations/{location}`
      string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDestinationBytes in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The bytes for destination.

    • setDestination

      public DeployPublisherModelRequest.Builder setDestination(String value)
       Required. The resource name of the Location to deploy the model in.
 Format: `projects/{project}/locations/{location}`
      string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The destination to set.
      Returns:
      This builder for chaining.

    • clearDestination

      public DeployPublisherModelRequest.Builder clearDestination()
       Required. The resource name of the Location to deploy the model in.
 Format: `projects/{project}/locations/{location}`
      string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setDestinationBytes

      public DeployPublisherModelRequest.Builder setDestinationBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the Location to deploy the model in.
 Format: `projects/{project}/locations/{location}`
      string destination = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for destination to set.
      Returns:
      This builder for chaining.

    • getEndpointDisplayName

      public String getEndpointDisplayName()
       Optional. The user-specified display name of the endpoint. If not set, a
 default name will be used.
      string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEndpointDisplayName in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The endpointDisplayName.

    • getEndpointDisplayNameBytes

      public com.google.protobuf.ByteString getEndpointDisplayNameBytes()
       Optional. The user-specified display name of the endpoint. If not set, a
 default name will be used.
      string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEndpointDisplayNameBytes in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The bytes for endpointDisplayName.

    • setEndpointDisplayName

      public DeployPublisherModelRequest.Builder setEndpointDisplayName(String value)
       Optional. The user-specified display name of the endpoint. If not set, a
 default name will be used.
      string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The endpointDisplayName to set.
      Returns:
      This builder for chaining.

    • clearEndpointDisplayName

      public DeployPublisherModelRequest.Builder clearEndpointDisplayName()
       Optional. The user-specified display name of the endpoint. If not set, a
 default name will be used.
      string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setEndpointDisplayNameBytes

      public DeployPublisherModelRequest.Builder setEndpointDisplayNameBytes(com.google.protobuf.ByteString value)
       Optional. The user-specified display name of the endpoint. If not set, a
 default name will be used.
      string endpoint_display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for endpointDisplayName to set.
      Returns:
      This builder for chaining.

    • hasDedicatedResources

      public boolean hasDedicatedResources()
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDedicatedResources in interface DeployPublisherModelRequestOrBuilder
      Returns:
      Whether the dedicatedResources field is set.

    • getDedicatedResources

      public DedicatedResources getDedicatedResources()
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDedicatedResources in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The dedicatedResources.

    • setDedicatedResources

      public DeployPublisherModelRequest.Builder setDedicatedResources(DedicatedResources value)
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setDedicatedResources

      public DeployPublisherModelRequest.Builder setDedicatedResources(DedicatedResources.Builder builderForValue)
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeDedicatedResources

      public DeployPublisherModelRequest.Builder mergeDedicatedResources(DedicatedResources value)
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearDedicatedResources

      public DeployPublisherModelRequest.Builder clearDedicatedResources()
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDedicatedResourcesBuilder

      public DedicatedResources.Builder getDedicatedResourcesBuilder()
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDedicatedResourcesOrBuilder

      public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()
       Optional. The dedicated resources to use for the endpoint. If not set, the
 default resources will be used.
      .google.cloud.aiplatform.v1beta1.DedicatedResources dedicated_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDedicatedResourcesOrBuilder in interface DeployPublisherModelRequestOrBuilder

    • 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelDisplayName in interface DeployPublisherModelRequestOrBuilder
      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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelDisplayNameBytes in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The bytes for modelDisplayName.

    • setModelDisplayName

      public DeployPublisherModelRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The modelDisplayName to set.
      Returns:
      This builder for chaining.

    • clearModelDisplayName

      public DeployPublisherModelRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setModelDisplayNameBytes

      public DeployPublisherModelRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for modelDisplayName to set.
      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 = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHuggingFaceAccessToken in interface DeployPublisherModelRequestOrBuilder
      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 = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHuggingFaceAccessTokenBytes in interface DeployPublisherModelRequestOrBuilder
      Returns:
      The bytes for huggingFaceAccessToken.

    • setHuggingFaceAccessToken

      public DeployPublisherModelRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The huggingFaceAccessToken to set.
      Returns:
      This builder for chaining.

    • clearHuggingFaceAccessToken

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

    • setHuggingFaceAccessTokenBytes

      public DeployPublisherModelRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for huggingFaceAccessToken to set.
      Returns:
      This builder for chaining.

    • getAcceptEula

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

    • setAcceptEula

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

    • clearAcceptEula

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