google-cloud-notebooks-v1 0.1.0 → 0.3.0

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

@@ -1095,6 +1095,94 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Add/update metadata items for an instance.
+            #
+            # @overload update_instance_metadata_items(request, options = nil)
+            #   Pass arguments to `update_instance_metadata_items` via a request object, either of type
+            #   {::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest, ::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_instance_metadata_items(name: nil, items: nil)
+            #   Pass arguments to `update_instance_metadata_items` 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 name [::String]
+            #     Required. Format:
+            #     `projects/{project_id}/locations/{location}/instances/{instance_id}`
+            #   @param items [::Hash{::String => ::String}]
+            #     Metadata items to add/update for the instance.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/notebooks/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Notebooks::V1::NotebookService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest.new
+            #
+            #   # Call the update_instance_metadata_items method.
+            #   result = client.update_instance_metadata_items request
+            #
+            #   # The returned object is of type Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse.
+            #   p result
+            #
+            def update_instance_metadata_items request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest
+
+              # 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_instance_metadata_items.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Notebooks::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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_instance_metadata_items.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.update_instance_metadata_items.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @notebook_service_stub.call_rpc :update_instance_metadata_items, 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
+
             ##
             # Deletes a single Instance.
             #
@@ -1587,7 +1675,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload is_instance_upgradeable(notebook_instance: nil)
+            # @overload is_instance_upgradeable(notebook_instance: nil, type: nil)
             #   Pass arguments to `is_instance_upgradeable` 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).
@@ -1595,6 +1683,9 @@ module Google
             #   @param notebook_instance [::String]
             #     Required. Format:
             #     `projects/{project_id}/locations/{location}/instances/{instance_id}`
+            #   @param type [::Google::Cloud::Notebooks::V1::UpgradeType]
+            #     Optional. The optional UpgradeType. Setting this field will search for additional
+            #     compute images to upgrade this instance.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse]
@@ -1759,7 +1850,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload upgrade_instance(name: nil)
+            # @overload upgrade_instance(name: nil, type: nil)
             #   Pass arguments to `upgrade_instance` 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).
@@ -1767,6 +1858,9 @@ module Google
             #   @param name [::String]
             #     Required. Format:
             #     `projects/{project_id}/locations/{location}/instances/{instance_id}`
+            #   @param type [::Google::Cloud::Notebooks::V1::UpgradeType]
+            #     Optional. The optional UpgradeType. Setting this field will search for additional
+            #     compute images to upgrade this instance.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -1951,7 +2045,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload upgrade_instance_internal(name: nil, vm_id: nil)
+            # @overload upgrade_instance_internal(name: nil, vm_id: nil, type: nil)
             #   Pass arguments to `upgrade_instance_internal` 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).
@@ -1962,6 +2056,9 @@ module Google
             #   @param vm_id [::String]
             #     Required. The VM hardware token for authenticating the VM.
             #     https://cloud.google.com/compute/docs/instances/verifying-instance-identity
+            #   @param type [::Google::Cloud::Notebooks::V1::UpgradeType]
+            #     Optional. The optional UpgradeType. Setting this field will search for additional
+            #     compute images to upgrade this instance.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -3171,7 +3268,7 @@ module Google
             end
 
             ##
-            # Creates a new Scheduled Notebook in a given project and location.
+            # Creates a new Execution in a given project and location.
             #
             # @overload create_execution(request, options = nil)
             #   Pass arguments to `create_execution` via a request object, either of type
@@ -3449,6 +3546,11 @@ module Google
                 #
                 attr_reader :set_instance_labels
                 ##
+                # RPC-specific configuration for `update_instance_metadata_items`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :update_instance_metadata_items
+                ##
                 # RPC-specific configuration for `delete_instance`
                 # @return [::Gapic::Config::Method]
                 #
@@ -3584,6 +3686,8 @@ module Google
                   @update_shielded_instance_config = ::Gapic::Config::Method.new update_shielded_instance_config_config
                   set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
                   @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
+                  update_instance_metadata_items_config = parent_rpcs.update_instance_metadata_items if parent_rpcs.respond_to? :update_instance_metadata_items
+                  @update_instance_metadata_items = ::Gapic::Config::Method.new update_instance_metadata_items_config
                   delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
                   @delete_instance = ::Gapic::Config::Method.new delete_instance_config
                   start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance

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

@@ -95,6 +95,9 @@ module Google
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors
               )
+
+              # Used by an LRO wrapper for some methods of this service
+              @operations_client = self
             end
 
             # Service calls

data/lib/google/cloud/notebooks/v1/notebook_service/paths.rb

@@ -96,6 +96,25 @@ module Google
               "projects/#{project}/location/#{location}/schedules/#{schedule}"
             end
 
+            ##
+            # Create a fully-qualified Tensorboard resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param tensorboard [String]
+            #
+            # @return [::String]
+            def tensorboard_path project:, location:, tensorboard:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/tensorboards/#{tensorboard}"
+            end
+
             extend self
           end
         end

data/lib/google/cloud/notebooks/v1/runtime_pb.rb

@@ -1,11 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/notebooks/v1/runtime.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/notebooks/v1/environment_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/notebooks/v1/runtime.proto", :syntax => :proto3) do
@@ -37,6 +38,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :HEALTH_STATE_UNSPECIFIED, 0
       value :HEALTHY, 1
       value :UNHEALTHY, 2
+      value :AGENT_NOT_INSTALLED, 3
+      value :AGENT_NOT_RUNNING, 4
     end
     add_message "google.cloud.notebooks.v1.RuntimeAcceleratorConfig" do
       optional :type, :enum, 1, "google.cloud.notebooks.v1.RuntimeAcceleratorConfig.AcceleratorType"
@@ -88,6 +91,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :PD_STANDARD, 1
       value :PD_SSD, 2
       value :PD_BALANCED, 3
+      value :PD_EXTREME, 4
     end
     add_message "google.cloud.notebooks.v1.RuntimeAccessConfig" do
       optional :access_type, :enum, 1, "google.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType"
@@ -97,6 +101,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_enum "google.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType" do
       value :RUNTIME_ACCESS_TYPE_UNSPECIFIED, 0
       value :SINGLE_USER, 1
+      value :SERVICE_ACCOUNT, 2
     end
     add_message "google.cloud.notebooks.v1.RuntimeSoftwareConfig" do
       optional :notebook_upgrade_schedule, :string, 1
@@ -106,6 +111,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :install_gpu_driver, :bool, 5
       optional :custom_gpu_driver_path, :string, 6
       optional :post_startup_script, :string, 7
+      repeated :kernels, :message, 8, "google.cloud.notebooks.v1.ContainerImage"
+      proto3_optional :upgradeable, :bool, 9
     end
     add_message "google.cloud.notebooks.v1.RuntimeMetrics" do
       map :system_metrics, :string, :string, 1
@@ -136,6 +143,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       map :metadata, :string, :string, 15
       map :labels, :string, :string, 16
       optional :nic_type, :enum, 17, "google.cloud.notebooks.v1.VirtualMachineConfig.NicType"
+      optional :reserved_ip_range, :string, 18
+      optional :boot_image, :message, 19, "google.cloud.notebooks.v1.VirtualMachineConfig.BootImage"
+    end
+    add_message "google.cloud.notebooks.v1.VirtualMachineConfig.BootImage" do
     end
     add_enum "google.cloud.notebooks.v1.VirtualMachineConfig.NicType" do
       value :UNSPECIFIED_NIC_TYPE, 0
@@ -166,6 +177,7 @@ module Google
         RuntimeShieldedInstanceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig").msgclass
         VirtualMachine = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.VirtualMachine").msgclass
         VirtualMachineConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.VirtualMachineConfig").msgclass
+        VirtualMachineConfig::BootImage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.VirtualMachineConfig.BootImage").msgclass
         VirtualMachineConfig::NicType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.VirtualMachineConfig.NicType").enummodule
       end
     end

data/lib/google/cloud/notebooks/v1/schedule_pb.rb

@@ -1,11 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/notebooks/v1/schedule.proto
 
+require 'google/protobuf'
+
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/notebooks/v1/execution_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/notebooks/v1/schedule.proto", :syntax => :proto3) do

data/lib/google/cloud/notebooks/v1/service_pb.rb

@@ -1,6 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/notebooks/v1/service.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -12,7 +14,6 @@ require 'google/cloud/notebooks/v1/instance_config_pb'
 require 'google/cloud/notebooks/v1/schedule_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/notebooks/v1/service.proto", :syntax => :proto3) do
@@ -65,6 +66,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 1
       map :labels, :string, :string, 2
     end
+    add_message "google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequest" do
+      optional :name, :string, 1
+      map :items, :string, :string, 2
+    end
+    add_message "google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse" do
+      map :items, :string, :string, 1
+    end
     add_message "google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest" do
       optional :name, :string, 1
       optional :shielded_instance_config, :message, 2, "google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig"
@@ -88,6 +96,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.notebooks.v1.IsInstanceUpgradeableRequest" do
       optional :notebook_instance, :string, 1
+      optional :type, :enum, 2, "google.cloud.notebooks.v1.UpgradeType"
     end
     add_message "google.cloud.notebooks.v1.IsInstanceUpgradeableResponse" do
       optional :upgradeable, :bool, 1
@@ -111,6 +120,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.notebooks.v1.UpgradeInstanceRequest" do
       optional :name, :string, 1
+      optional :type, :enum, 2, "google.cloud.notebooks.v1.UpgradeType"
     end
     add_message "google.cloud.notebooks.v1.RollbackInstanceRequest" do
       optional :name, :string, 1
@@ -119,6 +129,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.notebooks.v1.UpgradeInstanceInternalRequest" do
       optional :name, :string, 1
       optional :vm_id, :string, 2
+      optional :type, :enum, 3, "google.cloud.notebooks.v1.UpgradeType"
     end
     add_message "google.cloud.notebooks.v1.ListEnvironmentsRequest" do
       optional :parent, :string, 1
@@ -190,6 +201,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :execution_id, :string, 2
       optional :execution, :message, 3, "google.cloud.notebooks.v1.Execution"
     end
+    add_enum "google.cloud.notebooks.v1.UpgradeType" do
+      value :UPGRADE_TYPE_UNSPECIFIED, 0
+      value :UPGRADE_FRAMEWORK, 1
+      value :UPGRADE_OS, 2
+      value :UPGRADE_CUDA, 3
+      value :UPGRADE_ALL, 4
+    end
   end
 end
 
@@ -207,6 +225,8 @@ module Google
         SetInstanceMachineTypeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.SetInstanceMachineTypeRequest").msgclass
         UpdateInstanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpdateInstanceConfigRequest").msgclass
         SetInstanceLabelsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.SetInstanceLabelsRequest").msgclass
+        UpdateInstanceMetadataItemsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpdateInstanceMetadataItemsRequest").msgclass
+        UpdateInstanceMetadataItemsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpdateInstanceMetadataItemsResponse").msgclass
         UpdateShieldedInstanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpdateShieldedInstanceConfigRequest").msgclass
         DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.DeleteInstanceRequest").msgclass
         StartInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.StartInstanceRequest").msgclass
@@ -237,6 +257,7 @@ module Google
         GetExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.GetExecutionRequest").msgclass
         DeleteExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.DeleteExecutionRequest").msgclass
         CreateExecutionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.CreateExecutionRequest").msgclass
+        UpgradeType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpgradeType").enummodule
       end
     end
   end

data/lib/google/cloud/notebooks/v1/service_services_pb.rb

@@ -54,6 +54,8 @@ module Google
             rpc :UpdateShieldedInstanceConfig, ::Google::Cloud::Notebooks::V1::UpdateShieldedInstanceConfigRequest, ::Google::Longrunning::Operation
             # Replaces all the labels of an Instance.
             rpc :SetInstanceLabels, ::Google::Cloud::Notebooks::V1::SetInstanceLabelsRequest, ::Google::Longrunning::Operation
+            # Add/update metadata items for an instance.
+            rpc :UpdateInstanceMetadataItems, ::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest, ::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse
             # Deletes a single Instance.
             rpc :DeleteInstance, ::Google::Cloud::Notebooks::V1::DeleteInstanceRequest, ::Google::Longrunning::Operation
             # Starts a notebook instance.
@@ -102,7 +104,7 @@ module Google
             rpc :GetExecution, ::Google::Cloud::Notebooks::V1::GetExecutionRequest, ::Google::Cloud::Notebooks::V1::Execution
             # Deletes execution
             rpc :DeleteExecution, ::Google::Cloud::Notebooks::V1::DeleteExecutionRequest, ::Google::Longrunning::Operation
-            # Creates a new Scheduled Notebook in a given project and location.
+            # Creates a new Execution in a given project and location.
             rpc :CreateExecution, ::Google::Cloud::Notebooks::V1::CreateExecutionRequest, ::Google::Longrunning::Operation
           end
 

data/lib/google/cloud/notebooks/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Notebooks
       module V1
-        VERSION = "0.1.0"
+        VERSION = "0.3.0"
       end
     end
   end

data/proto_docs/google/cloud/notebooks/v1/environment.rb

@@ -58,7 +58,7 @@ module Google
         # @!attribute [rw] project
         #   @return [::String]
         #     Required. The name of the Google Cloud project that this VM image belongs to.
-        #     Format: `projects/{project_id}`
+        #     Format: `{project_id}`
         # @!attribute [rw] image_name
         #   @return [::String]
         #     Use VM image name to find the image.

data/proto_docs/google/cloud/notebooks/v1/event.rb

@@ -28,17 +28,44 @@ module Google
         # @!attribute [rw] type
         #   @return [::Google::Cloud::Notebooks::V1::Event::EventType]
         #     Event type.
+        # @!attribute [rw] details
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Event details. This field is used to pass event information.
         class Event
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # The definition of the even types.
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class DetailsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The definition of the event types.
           module EventType
             # Event is not specified.
             EVENT_TYPE_UNSPECIFIED = 0
 
             # The instance / runtime is idle
             IDLE = 1
+
+            # The instance / runtime is available.
+            # This event indicates that instance / runtime underlying compute is
+            # operational.
+            HEARTBEAT = 2
+
+            # The instance / runtime health is available.
+            # This event indicates that instance / runtime health information.
+            HEALTH = 3
+
+            # The instance / runtime is available.
+            # This event allows instance / runtime to send Host maintenance
+            # information to Control Plane.
+            # https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
+            MAINTENANCE = 4
           end
         end
       end

data/proto_docs/google/cloud/notebooks/v1/execution.rb

@@ -74,7 +74,8 @@ module Google
         #
         #     Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
         #     field. Learn more about the [special configuration options for training
-        #     with TPU.
+        #     with
+        #     TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
         # @!attribute [rw] accelerator_config
         #   @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::SchedulerAcceleratorConfig]
         #     Configuration (count and accelerator type) for hardware running notebook
@@ -90,7 +91,7 @@ module Google
         #   @return [::String]
         #     Path to the notebook file to execute.
         #     Must be in a Google Cloud Storage bucket.
-        #     Format: `gs://{project_id}/{folder}/{notebook_file_name}`
+        #     Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
         #     Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
         # @!attribute [rw] container_image_uri
         #   @return [::String]
@@ -102,7 +103,7 @@ module Google
         #   @return [::String]
         #     Path to the notebook folder to write to.
         #     Must be in a Google Cloud Storage bucket path.
-        #     Format: `gs://{project_id}/{folder}`
+        #     Format: `gs://{bucket_name}/{folder}`
         #     Ex: `gs://notebook_user/scheduled_notebooks`
         # @!attribute [rw] params_yaml_file
         #   @return [::String]
@@ -125,13 +126,27 @@ module Google
         # @!attribute [rw] dataproc_parameters
         #   @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::DataprocParameters]
         #     Parameters used in Dataproc JobType executions.
+        # @!attribute [rw] vertex_ai_parameters
+        #   @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::VertexAIParameters]
+        #     Parameters used in Vertex AI JobType executions.
+        # @!attribute [rw] kernel_spec
+        #   @return [::String]
+        #     Name of the kernel spec to use. This must be specified if the
+        #     kernel spec name on the execution target does not match the name in the
+        #     input notebook file.
+        # @!attribute [rw] tensorboard
+        #   @return [::String]
+        #     The name of a Vertex AI [Tensorboard] resource to which this execution
+        #     will upload Tensorboard logs.
+        #     Format:
+        #     `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
         class ExecutionTemplate
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
           # Definition of a hardware accelerator. Note that not all combinations
-          # of `type` and `core_count` are valid. Check GPUs on
-          # Compute Engine to find a valid
+          # of `type` and `core_count` are valid. Check [GPUs on
+          # Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid
           # combination. TPUs are not supported.
           # @!attribute [rw] type
           #   @return [::Google::Cloud::Notebooks::V1::ExecutionTemplate::SchedulerAcceleratorType]
@@ -154,6 +169,38 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Parameters used in Vertex AI JobType executions.
+          # @!attribute [rw] network
+          #   @return [::String]
+          #     The full name of the Compute Engine
+          #     [network](/compute/docs/networks-and-firewalls#networks) to which the Job
+          #     should be peered. For example, `projects/12345/global/networks/myVPC`.
+          #     [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert)
+          #     is of the form `projects/{project}/global/networks/{network}`.
+          #     Where \\{project} is a project number, as in `12345`, and \\{network} is a
+          #     network name.
+          #
+          #     Private services access must already be configured for the network. If
+          #     left unspecified, the job is not peered with any network.
+          # @!attribute [rw] env
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Environment variables.
+          #      At most 100 environment variables can be specified and unique.
+          #     Example: GCP_BUCKET=gs://my-bucket/samples/
+          class VertexAIParameters
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class EnvEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value
@@ -189,25 +236,9 @@ module Google
             # own cluster specification. When you use this tier, set values to
             # configure your processing cluster according to these guidelines:
             #
-            # *   You _must_ set `TrainingInput.masterType` to specify the type
+            # *   You _must_ set `ExecutionTemplate.masterType` to specify the type
             #     of machine to use for your master node. This is the only required
             #     setting.
-            #
-            # *   You _may_ set `TrainingInput.workerCount` to specify the number of
-            #     workers to use. If you specify one or more workers, you _must_ also
-            #     set `TrainingInput.workerType` to specify the type of machine to use
-            #     for your worker nodes.
-            #
-            # *   You _may_ set `TrainingInput.parameterServerCount` to specify the
-            #     number of parameter servers to use. If you specify one or more
-            #     parameter servers, you _must_ also set
-            #     `TrainingInput.parameterServerType` to specify the type of machine to
-            #     use for your parameter servers.
-            #
-            # Note that all of your workers must use the same machine type, which can
-            # be different from your parameter server type and master type. Your
-            # parameter servers must likewise use the same machine type, which can be
-            # different from your worker type and master type.
             CUSTOM = 6
           end
 
@@ -231,6 +262,9 @@ module Google
             # Nvidia Tesla T4 GPU.
             NVIDIA_TESLA_T4 = 5
 
+            # Nvidia Tesla A100 GPU.
+            NVIDIA_TESLA_A100 = 10
+
             # TPU v2.
             TPU_V2 = 6
 
@@ -260,7 +294,7 @@ module Google
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The resource name of the execute. Format:
-        #     `projects/{project_id}/locations/{location}/execution/{execution_id}`
+        #     `projects/{project_id}/locations/{location}/executions/{execution_id}`
         # @!attribute [r] display_name
         #   @return [::String]
         #     Output only. Name used for UI purposes.
@@ -316,7 +350,7 @@ module Google
             # `error_message` should describe the reason for the cancellation.
             CANCELLED = 7
 
-            # The jobs has become expired (added for uCAIP jobs)
+            # The job has become expired (relevant to Vertex AI jobs)
             # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
             EXPIRED = 9