google-cloud-ai_platform-v1 0.39.0 → 0.41.0

data/lib/google/cloud/ai_platform/v1/model_service/rest.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/ai_platform/v1/version"
+require "google/cloud/ai_platform/v1/bindings_override"
+
+require "google/cloud/ai_platform/v1/model_service/credentials"
+require "google/cloud/ai_platform/v1/model_service/paths"
+require "google/cloud/ai_platform/v1/model_service/rest/operations"
+require "google/cloud/ai_platform/v1/model_service/rest/client"
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        ##
+        # A service for managing Vertex AI's machine learning Models.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/ai_platform/v1/model_service/rest"
+        #     client = ::Google::Cloud::AIPlatform::V1::ModelService::Rest::Client.new
+        #
+        module ModelService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/ai_platform/v1/model_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/ai_platform/v1/model_service.rb

@@ -26,6 +26,7 @@ require "google/cloud/ai_platform/v1/model_service/credentials"
 require "google/cloud/ai_platform/v1/model_service/paths"
 require "google/cloud/ai_platform/v1/model_service/operations"
 require "google/cloud/ai_platform/v1/model_service/client"
+require "google/cloud/ai_platform/v1/model_service/rest"
 
 module Google
   module Cloud
@@ -39,6 +40,11 @@ module Google
         #     require "google/cloud/ai_platform/v1/model_service"
         #     client = ::Google::Cloud::AIPlatform::V1::ModelService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/ai_platform/v1/model_service/rest"
+        #     client = ::Google::Cloud::AIPlatform::V1::ModelService::Rest::Client.new
+        #
         module ModelService
         end
       end

data/lib/google/cloud/ai_platform/v1/notebook_service/client.rb

@@ -32,6 +32,9 @@ module Google
           # The interface for Vertex Notebook service (a.k.a. Colab on Workbench).
           #
           class Client
+            # @private
+            API_VERSION = ""
+
             # @private
             DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$"
 
@@ -271,10 +274,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.create_notebook_runtime_template.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -359,10 +363,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.get_notebook_runtime_template.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -492,10 +497,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.list_notebook_runtime_templates.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -587,10 +593,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.delete_notebook_runtime_template.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -618,6 +625,99 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Updates a NotebookRuntimeTemplate.
+            #
+            # @overload update_notebook_runtime_template(request, options = nil)
+            #   Pass arguments to `update_notebook_runtime_template` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::UpdateNotebookRuntimeTemplateRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AIPlatform::V1::UpdateNotebookRuntimeTemplateRequest, ::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 update_notebook_runtime_template(notebook_runtime_template: nil, update_mask: nil)
+            #   Pass arguments to `update_notebook_runtime_template` 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 notebook_runtime_template [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate, ::Hash]
+            #     Required. The NotebookRuntimeTemplate to update.
+            #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Required. The update mask applies to the resource.
+            #     For the `FieldMask` definition, see
+            #     {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. Input format:
+            #     `{paths: "${updated_filed}"}` Updatable fields:
+            #
+            #       * `encryption_spec.kms_key_name`
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC 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::NotebookService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AIPlatform::V1::UpdateNotebookRuntimeTemplateRequest.new
+            #
+            #   # Call the update_notebook_runtime_template method.
+            #   result = client.update_notebook_runtime_template request
+            #
+            #   # The returned object is of type Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate.
+            #   p result
+            #
+            def update_notebook_runtime_template request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::UpdateNotebookRuntimeTemplateRequest
+
+              # 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
+              metadata = @config.rpcs.update_notebook_runtime_template.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.notebook_runtime_template&.name
+                header_params["notebook_runtime_template.name"] = request.notebook_runtime_template.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.update_notebook_runtime_template.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.update_notebook_runtime_template.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @notebook_service_stub.call_rpc :update_notebook_runtime_template, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Assigns a NotebookRuntime to a user for a particular Notebook file. This
             # method will either returns an existing assignment or generates a new one.
@@ -690,10 +790,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.assign_notebook_runtime.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -779,10 +880,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.get_notebook_runtime.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -926,10 +1028,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.list_notebook_runtimes.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -1022,10 +1125,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.delete_notebook_runtime.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -1118,10 +1222,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.upgrade_notebook_runtime.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -1214,10 +1319,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.start_notebook_runtime.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -1419,6 +1525,11 @@ module Google
                 #
                 attr_reader :delete_notebook_runtime_template
                 ##
+                # RPC-specific configuration for `update_notebook_runtime_template`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :update_notebook_runtime_template
+                ##
                 # RPC-specific configuration for `assign_notebook_runtime`
                 # @return [::Gapic::Config::Method]
                 #
@@ -1459,6 +1570,8 @@ module Google
                   @list_notebook_runtime_templates = ::Gapic::Config::Method.new list_notebook_runtime_templates_config
                   delete_notebook_runtime_template_config = parent_rpcs.delete_notebook_runtime_template if parent_rpcs.respond_to? :delete_notebook_runtime_template
                   @delete_notebook_runtime_template = ::Gapic::Config::Method.new delete_notebook_runtime_template_config
+                  update_notebook_runtime_template_config = parent_rpcs.update_notebook_runtime_template if parent_rpcs.respond_to? :update_notebook_runtime_template
+                  @update_notebook_runtime_template = ::Gapic::Config::Method.new update_notebook_runtime_template_config
                   assign_notebook_runtime_config = parent_rpcs.assign_notebook_runtime if parent_rpcs.respond_to? :assign_notebook_runtime
                   @assign_notebook_runtime = ::Gapic::Config::Method.new assign_notebook_runtime_config
                   get_notebook_runtime_config = parent_rpcs.get_notebook_runtime if parent_rpcs.respond_to? :get_notebook_runtime

data/lib/google/cloud/ai_platform/v1/notebook_service/operations.rb

@@ -26,6 +26,9 @@ module Google
         module NotebookService
           # Service that implements Longrunning Operations API.
           class Operations
+            # @private
+            API_VERSION = ""
+
             # @private
             DEFAULT_ENDPOINT_TEMPLATE = "aiplatform.$UNIVERSE_DOMAIN$"
 
@@ -191,10 +194,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.list_operations.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -287,10 +291,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.get_operation.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -376,10 +381,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.delete_operation.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -470,10 +476,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.cancel_operation.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
@@ -574,10 +581,11 @@ module Google
               # Customize the options with defaults
               metadata = @config.rpcs.wait_operation.metadata.to_h
 
-              # Set x-goog-api-client and x-goog-user-project headers
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
               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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}