google-apis-notebooks_v1 0.9.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a6c0493a17453f6990d5e2a1b56c3f438c9eac41d33cf07f56b90256f5d82c
-  data.tar.gz: e6a3a68bad11516de994dc5f90359bb202d80dda3f35720db857ad2ffdc2cc56
+  metadata.gz: 85f44028b77a698830f8e86f92972f711b052c3ab291ca45b4aba5b6c8f8e331
+  data.tar.gz: 40ea545c95e939e75600aae414514211710ea8ae8f71a1a0e0f17128c59bb593
 SHA512:
-  metadata.gz: 32b8f99f63a31ba76227a0fa16ee46aecc7d092f26b65ecff694d640f9a321c2e5451c1af80e95ce1576fb730680c3c52d914a9d9cbdea50940f811dc8354736
-  data.tar.gz: ed252fe733948882ba77af196d82664e8a0572935f1d360a779059a76416bff86283a67d916cda5fb0d70ba170b2d1bbcd5db69de795947cafa17ff89ef938e7
+  metadata.gz: 3ea87d07ebf180bf45369a078054d596491664fe2bdee8418236f63f2ec7197f7910f65ab1e2b47b5a328dfc763f4335ffa791ebde5cd1cb4521cab637d8d425
+  data.tar.gz: 3a5c00a8bcce9f88b62af6f2a7fdf4ed30f5cb0a013626bb81a1ad86981f150dde9190406155ad648535d189437405d773d3c49d8903524d75c7d9fac797e93c

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-notebooks_v1
 
+### v0.13.0 (2021-07-15)
+
+* Regenerated from discovery document revision 20210713
+
+### v0.12.0 (2021-07-01)
+
+* Regenerated from discovery document revision 20210626
+* Regenerated using generator version 0.4.0
+
+### v0.11.0 (2021-06-24)
+
+* Unspecified changes
+
+### v0.10.0 (2021-06-15)
+
+* Regenerated from discovery document revision 20210610
+
 ### v0.9.0 (2021-06-09)
 
 * Regenerated from discovery document revision 20210603

data/OVERVIEW.md

@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
 
 **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
 
-The [product documentation](https://cloud.google.com/ai-platform/notebooks/docs/) may provide guidance regarding the preferred client library to use.
+The [product documentation](https://cloud.google.com/notebooks/docs/) may provide guidance regarding the preferred client library to use.
 
 ## Supported Ruby versions
 

data/lib/google/apis/notebooks_v1.rb

@@ -21,9 +21,9 @@ module Google
   module Apis
     # Notebooks API
     #
-    # AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
+    # Notebooks API is used to manage notebook resources in Google Cloud.
     #
-    # @see https://cloud.google.com/ai-platform/notebooks/docs/
+    # @see https://cloud.google.com/notebooks/docs/
     module NotebooksV1
       # Version of the Notebooks API this client connects to.
       # This is NOT the gem version.

data/lib/google/apis/notebooks_v1/classes.rb

@@ -368,6 +368,31 @@ module Google
         end
       end
       
+      # The definition of an Event for a managed / semi-managed notebook instance.
+      class Event
+        include Google::Apis::Core::Hashable
+      
+        # Event report time.
+        # Corresponds to the JSON property `reportTime`
+        # @return [String]
+        attr_accessor :report_time
+      
+        # Event type.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @report_time = args[:report_time] if args.key?(:report_time)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
       # The definition of a single executed notebook.
       class Execution
         include Google::Apis::Core::Hashable
@@ -393,6 +418,11 @@ module Google
         # @return [Google::Apis::NotebooksV1::ExecutionTemplate]
         attr_accessor :execution_template
       
+        # Output only. The URI of the external job used to execute the notebook.
+        # Corresponds to the JSON property `jobUri`
+        # @return [String]
+        attr_accessor :job_uri
+      
         # Output only. The resource name of the execute. Format: `projects/`project_id`/
         # locations/`location`/execution/`execution_id`
         # Corresponds to the JSON property `name`
@@ -424,6 +454,7 @@ module Google
           @description = args[:description] if args.key?(:description)
           @display_name = args[:display_name] if args.key?(:display_name)
           @execution_template = args[:execution_template] if args.key?(:execution_template)
+          @job_uri = args[:job_uri] if args.key?(:job_uri)
           @name = args[:name] if args.key?(:name)
           @output_notebook_file = args[:output_notebook_file] if args.key?(:output_notebook_file)
           @state = args[:state] if args.key?(:state)
@@ -503,7 +534,8 @@ module Google
         # @return [String]
         attr_accessor :params_yaml_file
       
-        # Required. Scale tier of the hardware used for notebook execution.
+        # Required. Scale tier of the hardware used for notebook execution. DEPRECATED
+        # Will be discontinued. As right now only CUSTOM is supported.
         # Corresponds to the JSON property `scaleTier`
         # @return [String]
         attr_accessor :scale_tier
@@ -791,6 +823,11 @@ module Google
         # @return [String]
         attr_accessor :proxy_uri
       
+        # Reservation Affinity for consuming Zonal reservation.
+        # Corresponds to the JSON property `reservationAffinity`
+        # @return [Google::Apis::NotebooksV1::ReservationAffinity]
+        attr_accessor :reservation_affinity
+      
         # The service account on this instance, giving access to other Google Cloud
         # services. You can use any service account within the same project, but you
         # must have the service account user permission to use the instance. If not
@@ -879,6 +916,7 @@ module Google
           @no_remove_data_disk = args[:no_remove_data_disk] if args.key?(:no_remove_data_disk)
           @post_startup_script = args[:post_startup_script] if args.key?(:post_startup_script)
           @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
+          @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
           @service_account = args[:service_account] if args.key?(:service_account)
           @service_account_scopes = args[:service_account_scopes] if args.key?(:service_account_scopes)
           @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
@@ -891,6 +929,33 @@ module Google
         end
       end
       
+      # Notebook instance configurations that can be updated.
+      class InstanceConfig
+        include Google::Apis::Core::Hashable
+      
+        # Verifies core internal services are running. More info: go/notebooks-health
+        # Corresponds to the JSON property `enableHealthMonitoring`
+        # @return [Boolean]
+        attr_accessor :enable_health_monitoring
+        alias_method :enable_health_monitoring?, :enable_health_monitoring
+      
+        # Cron expression in UTC timezone, used to schedule instance auto upgrade.
+        # Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
+        # Corresponds to the JSON property `notebookUpgradeSchedule`
+        # @return [String]
+        attr_accessor :notebook_upgrade_schedule
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @enable_health_monitoring = args[:enable_health_monitoring] if args.key?(:enable_health_monitoring)
+          @notebook_upgrade_schedule = args[:notebook_upgrade_schedule] if args.key?(:notebook_upgrade_schedule)
+        end
+      end
+      
       # Response for checking if a notebook instance is upgradeable.
       class IsInstanceUpgradeableResponse
         include Google::Apis::Core::Hashable
@@ -1618,6 +1683,63 @@ module Google
         end
       end
       
+      # Request for reporting a Managed Notebook Event.
+      class ReportRuntimeEventRequest
+        include Google::Apis::Core::Hashable
+      
+        # The definition of an Event for a managed / semi-managed notebook instance.
+        # Corresponds to the JSON property `event`
+        # @return [Google::Apis::NotebooksV1::Event]
+        attr_accessor :event
+      
+        # Required. The VM hardware token for authenticating the VM. https://cloud.
+        # google.com/compute/docs/instances/verifying-instance-identity
+        # Corresponds to the JSON property `vmId`
+        # @return [String]
+        attr_accessor :vm_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @event = args[:event] if args.key?(:event)
+          @vm_id = args[:vm_id] if args.key?(:vm_id)
+        end
+      end
+      
+      # Reservation Affinity for consuming Zonal reservation.
+      class ReservationAffinity
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Type of reservation to consume
+        # Corresponds to the JSON property `consumeReservationType`
+        # @return [String]
+        attr_accessor :consume_reservation_type
+      
+        # Optional. Corresponds to the label key of reservation resource.
+        # Corresponds to the JSON property `key`
+        # @return [String]
+        attr_accessor :key
+      
+        # Optional. Corresponds to the label values of reservation resource.
+        # Corresponds to the JSON property `values`
+        # @return [Array<String>]
+        attr_accessor :values
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @consume_reservation_type = args[:consume_reservation_type] if args.key?(:consume_reservation_type)
+          @key = args[:key] if args.key?(:key)
+          @values = args[:values] if args.key?(:values)
+        end
+      end
+      
       # Request for reseting a notebook instance
       class ResetInstanceRequest
         include Google::Apis::Core::Hashable
@@ -1902,13 +2024,13 @@ module Google
         attr_accessor :enable_health_monitoring
         alias_method :enable_health_monitoring?, :enable_health_monitoring
       
-        # Runtime will automatically shutdown after idle_shutdown_time. Default: False
+        # Runtime will automatically shutdown after idle_shutdown_time. Default: True
         # Corresponds to the JSON property `idleShutdown`
         # @return [Boolean]
         attr_accessor :idle_shutdown
         alias_method :idle_shutdown?, :idle_shutdown
       
-        # Time in minutes to wait before shuting down runtime. Default: 90 minutes
+        # Time in minutes to wait before shuting down runtime. Default: 180 minutes
         # Corresponds to the JSON property `idleShutdownTimeout`
         # @return [Fixnum]
         attr_accessor :idle_shutdown_timeout
@@ -2387,6 +2509,25 @@ module Google
         end
       end
       
+      # Request for updating instance configurations.
+      class UpdateInstanceConfigRequest
+        include Google::Apis::Core::Hashable
+      
+        # Notebook instance configurations that can be updated.
+        # Corresponds to the JSON property `config`
+        # @return [Google::Apis::NotebooksV1::InstanceConfig]
+        attr_accessor :config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @config = args[:config] if args.key?(:config)
+        end
+      end
+      
       # Request for updating the Shielded Instance config for a notebook instance. You
       # can only use this method on a stopped instance
       class UpdateShieldedInstanceConfigRequest

data/lib/google/apis/notebooks_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module NotebooksV1
       # Version of the google-apis-notebooks_v1 gem
-      GEM_VERSION = "0.9.0"
+      GEM_VERSION = "0.13.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.3.0"
+      GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210603"
+      REVISION = "20210713"
     end
   end
 end

data/lib/google/apis/notebooks_v1/representations.rb

@@ -70,6 +70,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Event
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Execution
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -106,6 +112,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class InstanceConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class IsInstanceUpgradeableResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -202,6 +214,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ReportRuntimeEventRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ReservationAffinity
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ResetInstanceRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -358,6 +382,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class UpdateInstanceConfigRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class UpdateShieldedInstanceConfigRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -479,6 +509,14 @@ module Google
         end
       end
       
+      class Event
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :report_time, as: 'reportTime'
+          property :type, as: 'type'
+        end
+      end
+      
       class Execution
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -487,6 +525,7 @@ module Google
           property :display_name, as: 'displayName'
           property :execution_template, as: 'executionTemplate', class: Google::Apis::NotebooksV1::ExecutionTemplate, decorator: Google::Apis::NotebooksV1::ExecutionTemplate::Representation
       
+          property :job_uri, as: 'jobUri'
           property :name, as: 'name'
           property :output_notebook_file, as: 'outputNotebookFile'
           property :state, as: 'state'
@@ -566,6 +605,8 @@ module Google
           property :no_remove_data_disk, as: 'noRemoveDataDisk'
           property :post_startup_script, as: 'postStartupScript'
           property :proxy_uri, as: 'proxyUri'
+          property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::NotebooksV1::ReservationAffinity, decorator: Google::Apis::NotebooksV1::ReservationAffinity::Representation
+      
           property :service_account, as: 'serviceAccount'
           collection :service_account_scopes, as: 'serviceAccountScopes'
           property :shielded_instance_config, as: 'shieldedInstanceConfig', class: Google::Apis::NotebooksV1::ShieldedInstanceConfig, decorator: Google::Apis::NotebooksV1::ShieldedInstanceConfig::Representation
@@ -581,6 +622,14 @@ module Google
         end
       end
       
+      class InstanceConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :enable_health_monitoring, as: 'enableHealthMonitoring'
+          property :notebook_upgrade_schedule, as: 'notebookUpgradeSchedule'
+        end
+      end
+      
       class IsInstanceUpgradeableResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -752,6 +801,24 @@ module Google
         end
       end
       
+      class ReportRuntimeEventRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :event, as: 'event', class: Google::Apis::NotebooksV1::Event, decorator: Google::Apis::NotebooksV1::Event::Representation
+      
+          property :vm_id, as: 'vmId'
+        end
+      end
+      
+      class ReservationAffinity
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :consume_reservation_type, as: 'consumeReservationType'
+          property :key, as: 'key'
+          collection :values, as: 'values'
+        end
+      end
+      
       class ResetInstanceRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -970,6 +1037,14 @@ module Google
         end
       end
       
+      class UpdateInstanceConfigRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :config, as: 'config', class: Google::Apis::NotebooksV1::InstanceConfig, decorator: Google::Apis::NotebooksV1::InstanceConfig::Representation
+      
+        end
+      end
+      
       class UpdateShieldedInstanceConfigRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/notebooks_v1/service.rb

@@ -22,7 +22,7 @@ module Google
     module NotebooksV1
       # Notebooks API
       #
-      # AI Platform Notebooks API is used to manage notebook resources in Google Cloud.
+      # Notebooks API is used to manage notebook resources in Google Cloud.
       #
       # @example
       #    require 'google/apis/notebooks_v1'
@@ -30,7 +30,7 @@ module Google
       #    Notebooks = Google::Apis::NotebooksV1 # Alias the module
       #    service = Notebooks::AIPlatformNotebooksService.new
       #
-      # @see https://cloud.google.com/ai-platform/notebooks/docs/
+      # @see https://cloud.google.com/notebooks/docs/
       class AIPlatformNotebooksService < Google::Apis::Core::BaseService
         # @return [String]
         #  API key. Your API key identifies your project and provides you with API access,
@@ -1024,6 +1024,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Update Notebook Instance configurations.
+        # @param [String] name
+        #   Required. Format: `projects/`project_id`/locations/`location`/instances/`
+        #   instance_id``
+        # @param [Google::Apis::NotebooksV1::UpdateInstanceConfigRequest] update_instance_config_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::NotebooksV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_project_location_instance_config(name, update_instance_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/{+name}:updateConfig', options)
+          command.request_representation = Google::Apis::NotebooksV1::UpdateInstanceConfigRequest::Representation
+          command.request_object = update_instance_config_request_object
+          command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
+          command.response_class = Google::Apis::NotebooksV1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Updates the Shielded instance configuration of a single Instance.
         # @param [String] name
         #   Required. Format: `projects/`project_id`/locations/`location`/instances/`
@@ -1413,6 +1447,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Report and process a runtime event.
+        # @param [String] name
+        #   Required. Format: `projects/`project_id`/locations/`location`/runtimes/`
+        #   runtime_id``
+        # @param [Google::Apis::NotebooksV1::ReportRuntimeEventRequest] report_runtime_event_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::NotebooksV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::NotebooksV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def report_project_location_runtime_event(name, report_runtime_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:reportEvent', options)
+          command.request_representation = Google::Apis::NotebooksV1::ReportRuntimeEventRequest::Representation
+          command.request_object = report_runtime_event_request_object
+          command.response_representation = Google::Apis::NotebooksV1::Operation::Representation
+          command.response_class = Google::Apis::NotebooksV1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Resets a Managed Notebook Runtime.
         # @param [String] name
         #   Required. Format: `projects/`project_id`/locations/`location`/runtimes/`

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-notebooks_v1
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
 description: This is the simple REST client for Notebooks API V1. Simple REST clients
   are Ruby client libraries that provide access to Google services via their HTTP
   REST API endpoints. These libraries are generated and updated automatically based
@@ -52,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-notebooks_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-notebooks_v1/v0.9.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-notebooks_v1/v0.13.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-notebooks_v1
 post_install_message: 
 rdoc_options: []