google-cloud-ai_platform-v1 1.15.0 → 1.16.0

data/lib/google/cloud/ai_platform/v1/model_garden_service/paths.rb

@@ -24,6 +24,23 @@ module Google
         module ModelGardenService
           # Path helper methods for the ModelGardenService API.
           module Paths
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
             ##
             # Create a fully-qualified PublisherModel resource string.
             #
@@ -41,6 +58,25 @@ module Google
               "publishers/#{publisher}/models/#{model}"
             end
 
+            ##
+            # Create a fully-qualified Reservation resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project_id_or_number}/zones/{zone}/reservations/{reservation_name}`
+            #
+            # @param project_id_or_number [String]
+            # @param zone [String]
+            # @param reservation_name [String]
+            #
+            # @return [::String]
+            def reservation_path project_id_or_number:, zone:, reservation_name:
+              raise ::ArgumentError, "project_id_or_number cannot contain /" if project_id_or_number.to_s.include? "/"
+              raise ::ArgumentError, "zone cannot contain /" if zone.to_s.include? "/"
+
+              "projects/#{project_id_or_number}/zones/#{zone}/reservations/#{reservation_name}"
+            end
+
             extend self
           end
         end

data/lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb

@@ -148,6 +148,13 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+                @operations_client = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Operations.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
+                end
+
                 @model_garden_service_stub = ::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::ServiceStub.new(
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
@@ -185,6 +192,13 @@ module Google
                 end
               end
 
+              ##
+              # Get the associated client for long-running operations.
+              #
+              # @return [::Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Operations]
+              #
+              attr_reader :operations_client
+
               ##
               # Get the associated client for mix-in of the Locations.
               #
@@ -300,6 +314,115 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Deploys a model to a new endpoint.
+              #
+              # @overload deploy(request, options = nil)
+              #   Pass arguments to `deploy` via a request object, either of type
+              #   {::Google::Cloud::AIPlatform::V1::DeployRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AIPlatform::V1::DeployRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload deploy(publisher_model_name: nil, hugging_face_model_id: nil, destination: nil, model_config: nil, endpoint_config: nil, deploy_config: nil)
+              #   Pass arguments to `deploy` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param publisher_model_name [::String]
+              #     The Model Garden model to deploy.
+              #     Format:
+              #     `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
+              #     `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
+              #
+              #     Note: The following fields are mutually exclusive: `publisher_model_name`, `hugging_face_model_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+              #   @param hugging_face_model_id [::String]
+              #     The Hugging Face model to deploy.
+              #     Format: Hugging Face model ID like `google/gemma-2-2b-it`.
+              #
+              #     Note: The following fields are mutually exclusive: `hugging_face_model_id`, `publisher_model_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+              #   @param destination [::String]
+              #     Required. The resource name of the Location to deploy the model in.
+              #     Format: `projects/{project}/locations/{location}`
+              #   @param model_config [::Google::Cloud::AIPlatform::V1::DeployRequest::ModelConfig, ::Hash]
+              #     Optional. The model config to use for the deployment.
+              #     If not specified, the default model config will be used.
+              #   @param endpoint_config [::Google::Cloud::AIPlatform::V1::DeployRequest::EndpointConfig, ::Hash]
+              #     Optional. The endpoint config to use for the deployment.
+              #     If not specified, the default endpoint config will be used.
+              #   @param deploy_config [::Google::Cloud::AIPlatform::V1::DeployRequest::DeployConfig, ::Hash]
+              #     Optional. The deploy config to use for the deployment.
+              #     If not specified, the default deploy config will be used.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/ai_platform/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AIPlatform::V1::ModelGardenService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AIPlatform::V1::DeployRequest.new
+              #
+              #   # Call the deploy method.
+              #   result = client.deploy request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
+              def deploy request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeployRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.deploy.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.deploy.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.deploy.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @model_garden_service_stub.deploy request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the ModelGardenService REST API.
               #
@@ -458,11 +581,18 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :get_publisher_model
+                  ##
+                  # RPC-specific configuration for `deploy`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :deploy
 
                   # @private
                   def initialize parent_rpcs = nil
                     get_publisher_model_config = parent_rpcs.get_publisher_model if parent_rpcs.respond_to? :get_publisher_model
                     @get_publisher_model = ::Gapic::Config::Method.new get_publisher_model_config
+                    deploy_config = parent_rpcs.deploy if parent_rpcs.respond_to? :deploy
+                    @deploy = ::Gapic::Config::Method.new deploy_config
 
                     yield self if block_given?
                   end