google-cloud-notebooks-v1 0.4.1 → 0.5.0

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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/notebooks/v1/version"
+require "google/cloud/notebooks/v1/bindings_override"
+
+require "google/cloud/notebooks/v1/notebook_service/credentials"
+require "google/cloud/notebooks/v1/notebook_service/paths"
+require "google/cloud/notebooks/v1/notebook_service/rest/operations"
+require "google/cloud/notebooks/v1/notebook_service/rest/client"
+
+module Google
+  module Cloud
+    module Notebooks
+      module V1
+        ##
+        # API v1 service for Cloud AI Platform Notebooks.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/notebooks/v1/notebook_service/rest"
+        #     client = ::Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
+        #
+        module NotebookService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/notebooks/v1/notebook_service/rest/helpers" if ::File.file? helper_path

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

@@ -26,6 +26,7 @@ require "google/cloud/notebooks/v1/notebook_service/credentials"
 require "google/cloud/notebooks/v1/notebook_service/paths"
 require "google/cloud/notebooks/v1/notebook_service/operations"
 require "google/cloud/notebooks/v1/notebook_service/client"
+require "google/cloud/notebooks/v1/notebook_service/rest"
 
 module Google
   module Cloud
@@ -34,11 +35,16 @@ module Google
         ##
         # API v1 service for Cloud AI Platform Notebooks.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/notebooks/v1/notebook_service"
         #     client = ::Google::Cloud::Notebooks::V1::NotebookService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/notebooks/v1/notebook_service/rest"
+        #     client = ::Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
+        #
         module NotebookService
         end
       end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 "google/cloud/notebooks/v1/managed_notebook_service/rest"
+require "google/cloud/notebooks/v1/notebook_service/rest"
+require "google/cloud/notebooks/v1/bindings_override"
+require "google/cloud/notebooks/v1/version"
+
+module Google
+  module Cloud
+    module Notebooks
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/notebooks/v1/rest"
+      #     client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Notebooks
       module V1
-        VERSION = "0.4.1"
+        VERSION = "0.5.0"
       end
     end
   end

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

@@ -24,13 +24,18 @@ module Google
   module Cloud
     module Notebooks
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/notebooks/v1"
       #     client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Client.new
       #
+      # @example Load this package, including all its services, and instantiate a REST client
+      #
+      #     require "google/cloud/notebooks/v1"
+      #     client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.new
+      #
       module V1
       end
     end

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

@@ -173,20 +173,21 @@ module Google
           # @!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`.
+          #     [network](https://cloud.google.com/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.
+          #     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/
+          #     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

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

@@ -102,14 +102,15 @@ module Google
         #        https://www.googleapis.com/auth/compute
         # @!attribute [rw] machine_type
         #   @return [::String]
-        #     Required. The [Compute Engine machine type](/compute/docs/machine-types) of this
+        #     Required. The [Compute Engine machine
+        #     type](https://cloud.google.com/compute/docs/machine-types) of this
         #     instance.
         # @!attribute [rw] accelerator_config
         #   @return [::Google::Cloud::Notebooks::V1::Instance::AcceleratorConfig]
         #     The hardware accelerator used on this instance. If you use
         #     accelerators, make sure that your configuration has
-        #     [enough vCPUs and memory to support the `machine_type` you
-        #     have selected](/compute/docs/gpus/#gpus-list).
+        #     [enough vCPUs and memory to support the `machine_type` you have
+        #     selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
         # @!attribute [r] state
         #   @return [::Google::Cloud::Notebooks::V1::Instance::State]
         #     Output only. The state of this instance.
@@ -130,8 +131,8 @@ module Google
         # @!attribute [rw] boot_disk_size_gb
         #   @return [::Integer]
         #     Input only. The size of the boot disk in GB attached to this instance, up to a maximum
-        #     of 64000 GB (64 TB). The minimum recommended value is
-        #     100 GB. If not specified, this defaults to 100.
+        #     of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not
+        #     specified, this defaults to 100.
         # @!attribute [rw] data_disk_type
         #   @return [::Google::Cloud::Notebooks::V1::Instance::DiskType]
         #     Input only. The type of the data disk attached to this instance, defaults to
@@ -139,9 +140,8 @@ module Google
         # @!attribute [rw] data_disk_size_gb
         #   @return [::Integer]
         #     Input only. The size of the data disk in GB attached to this instance, up to a maximum
-        #     of 64000 GB (64 TB). You can choose the size of the data disk
-        #     based on how big your notebooks and data are. If not specified, this
-        #     defaults to 100.
+        #     of 64000 GB (64 TB). You can choose the size of the data disk based on how
+        #     big your notebooks and data are. If not specified, this defaults to 100.
         # @!attribute [rw] no_remove_data_disk
         #   @return [::Boolean]
         #     Input only. If true, the data disk will not be auto deleted when deleting the instance.
@@ -222,9 +222,9 @@ module Google
           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](/compute/docs/gpus/#gpus-list) to find a valid
-          # combination. TPUs are not supported.
+          # of `type` and `core_count` are valid. Check [GPUs on Compute
+          # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
+          # valid combination. TPUs are not supported.
           # @!attribute [rw] type
           #   @return [::Google::Cloud::Notebooks::V1::Instance::AcceleratorType]
           #     Type of this accelerator.
@@ -248,9 +248,9 @@ module Google
           # @!attribute [rw] device_name
           #   @return [::String]
           #     Indicates a unique device name of your choice that is reflected into the
-          #     /dev/disk/by-id/google-* tree of a Linux operating system running within
-          #     the instance. This name can be used to reference the device for mounting,
-          #     resizing, and so on, from within the instance.
+          #     `/dev/disk/by-id/google-*` tree of a Linux operating system running
+          #     within the instance. This name can be used to reference the device for
+          #     mounting, resizing, and so on, from within the instance.
           #
           #     If not specified, the server chooses a default device name to apply to
           #     this disk, in the form persistent-disk-x, where x is a number assigned by
@@ -278,8 +278,8 @@ module Google
           #     performance.
           #     Valid values:
           #
-          #     * NVME
-          #     * SCSI
+          #     * `NVME`
+          #     * `SCSI`
           # @!attribute [rw] kind
           #   @return [::String]
           #     Type of the resource. Always compute#attachedDisk for attached
@@ -291,23 +291,23 @@ module Google
           #     and marketplace images.
           # @!attribute [rw] mode
           #   @return [::String]
-          #     The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If
-          #     not specified, the default is to attach the disk in READ_WRITE mode.
-          #     Valid values:
+          #     The mode in which to attach this disk, either `READ_WRITE` or
+          #     `READ_ONLY`. If not specified, the default is to attach the disk in
+          #     `READ_WRITE` mode. Valid values:
           #
-          #     * READ_ONLY
-          #     * READ_WRITE
+          #     * `READ_ONLY`
+          #     * `READ_WRITE`
           # @!attribute [rw] source
           #   @return [::String]
           #     Indicates a valid partial or full URL to an existing Persistent Disk
           #     resource.
           # @!attribute [rw] type
           #   @return [::String]
-          #     Indicates the type of the disk, either SCRATCH or PERSISTENT.
+          #     Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
           #     Valid values:
           #
-          #     * PERSISTENT
-          #     * SCRATCH
+          #     * `PERSISTENT`
+          #     * `SCRATCH`
           class Disk
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,12 +319,12 @@ module Google
             #     features to see a list of available options.
             #     Valid values:
             #
-            #     * FEATURE_TYPE_UNSPECIFIED
-            #     * MULTI_IP_SUBNET
-            #     * SECURE_BOOT
-            #     * UEFI_COMPATIBLE
-            #     * VIRTIO_SCSI_MULTIQUEUE
-            #     * WINDOWS
+            #     * `FEATURE_TYPE_UNSPECIFIED`
+            #     * `MULTI_IP_SUBNET`
+            #     * `SECURE_BOOT`
+            #     * `UEFI_COMPATIBLE`
+            #     * `VIRTIO_SCSI_MULTIQUEUE`
+            #     * `WINDOWS`
             class GuestOsFeature
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -332,7 +332,8 @@ module Google
           end
 
           # A set of Shielded Instance options.
-          # Check [Images using supported Shielded VM features]
+          # Check [Images using supported Shielded VM
+          # features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
           # Not all combinations are valid.
           # @!attribute [rw] enable_secure_boot
           #   @return [::Boolean]
@@ -381,7 +382,7 @@ module Google
           #     The time that this instance upgrade history entry is created.
           # @!attribute [rw] target_image
           #   @return [::String]
-          #     Target VM Image. Format: ainotebooks-vm/project/image-name/name.
+          #     Target VM Image. Format: `ainotebooks-vm/project/image-name/name`.
           # @!attribute [rw] action
           #   @return [::Google::Cloud::Notebooks::V1::Instance::UpgradeHistoryEntry::Action]
           #     Action. Rolloback or Upgrade.

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

@@ -49,7 +49,7 @@ module Google
         # @!attribute [rw] unreachable
         #   @return [::Array<::String>]
         #     Locations that could not be reached. For example,
-        #     ['us-west1', 'us-central1'].
+        #     `['us-west1', 'us-central1']`.
         #     A ListRuntimesResponse will only contain either runtimes or unreachables,
         class ListRuntimesResponse
           include ::Google::Protobuf::MessageExts
@@ -211,12 +211,12 @@ module Google
         #
         #
         #     Currently, only the following fields can be updated:
-        #     - software_config.kernels
-        #     - software_config.post_startup_script
-        #     - software_config.custom_gpu_driver_path
-        #     - software_config.idle_shutdown
-        #     - software_config.idle_shutdown_timeout
-        #     - software_config.disable_terminal
+        #     - `software_config.kernels`
+        #     - `software_config.post_startup_script`
+        #     - `software_config.custom_gpu_driver_path`
+        #     - `software_config.idle_shutdown`
+        #     - `software_config.idle_shutdown_timeout`
+        #     - `software_config.disable_terminal`
         # @!attribute [rw] request_id
         #   @return [::String]
         #     Idempotent request UUID.

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

@@ -200,7 +200,7 @@ module Google
         #   @return [::String]
         #     Optional. Output only. Specifies a unique device name
         #     of your choice that is reflected into the
-        #     /dev/disk/by-id/google-* tree of a Linux operating system running within
+        #     `/dev/disk/by-id/google-*` tree of a Linux operating system running within
         #     the instance. This name can be used to reference the device for mounting,
         #     resizing, and so on, from within the instance.
         #
@@ -234,8 +234,8 @@ module Google
         #     performance characteristics of SCSI over NVMe, see Local SSD performance.
         #     Valid values:
         #
-        #     * NVME
-        #     * SCSI
+        #     * `NVME`
+        #     * `SCSI`
         # @!attribute [r] kind
         #   @return [::String]
         #     Output only. Type of the resource. Always compute#attachedDisk for attached disks.
@@ -244,24 +244,24 @@ module Google
         #     Output only. Any valid publicly visible licenses.
         # @!attribute [rw] mode
         #   @return [::String]
-        #     The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If
-        #     not specified, the default is to attach the disk in READ_WRITE mode.
+        #     The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
+        #     If not specified, the default is to attach the disk in `READ_WRITE` mode.
         #     Valid values:
         #
-        #     * READ_ONLY
-        #     * READ_WRITE
+        #     * `READ_ONLY`
+        #     * `READ_WRITE`
         # @!attribute [rw] source
         #   @return [::String]
         #     Specifies a valid partial or full URL to an existing Persistent Disk
         #     resource.
         # @!attribute [rw] type
         #   @return [::String]
-        #     Specifies the type of the disk, either SCRATCH or PERSISTENT. If not
-        #     specified, the default is PERSISTENT.
+        #     Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
+        #     specified, the default is `PERSISTENT`.
         #     Valid values:
         #
-        #     * PERSISTENT
-        #     * SCRATCH
+        #     * `PERSISTENT`
+        #     * `SCRATCH`
         class LocalDisk
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -280,12 +280,12 @@ module Google
           #
           #     Valid values:
           #
-          #     * FEATURE_TYPE_UNSPECIFIED
-          #     * MULTI_IP_SUBNET
-          #     * SECURE_BOOT
-          #     * UEFI_COMPATIBLE
-          #     * VIRTIO_SCSI_MULTIQUEUE
-          #     * WINDOWS
+          #     * `FEATURE_TYPE_UNSPECIFIED`
+          #     * `MULTI_IP_SUBNET`
+          #     * `SECURE_BOOT`
+          #     * `UEFI_COMPATIBLE`
+          #     * `VIRTIO_SCSI_MULTIQUEUE`
+          #     * `WINDOWS`
           class RuntimeGuestOsFeature
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -610,14 +610,15 @@ module Google
         #     The subnetwork allocation will use the range *name* if it's assigned.
         #
         #     Example: managed-notebooks-range-c
-        #     PEERING_RANGE_NAME_3=managed-notebooks-range-c
-        #     gcloud compute addresses create $PEERING_RANGE_NAME_3 \
-        #       --global \
-        #       --prefix-length=24 \
-        #       --description="Google Cloud Managed Notebooks Range 24 c" \
-        #       --network=$NETWORK \
-        #       --addresses=192.168.0.0 \
-        #       --purpose=VPC_PEERING
+        #
+        #         PEERING_RANGE_NAME_3=managed-notebooks-range-c
+        #         gcloud compute addresses create $PEERING_RANGE_NAME_3 \
+        #           --global \
+        #           --prefix-length=24 \
+        #           --description="Google Cloud Managed Notebooks Range 24 c" \
+        #           --network=$NETWORK \
+        #           --addresses=192.168.0.0 \
+        #           --purpose=VPC_PEERING
         #
         #     Field value will be: `managed-notebooks-range-c`
         # @!attribute [rw] boot_image

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

@@ -29,8 +29,8 @@ module Google
         # @!attribute [r] display_name
         #   @return [::String]
         #     Output only. Display name used for UI purposes.
-        #     Name can only contain alphanumeric characters, hyphens '-',
-        #     and underscores '_'.
+        #     Name can only contain alphanumeric characters, hyphens `-`,
+        #     and underscores `_`.
         # @!attribute [rw] description
         #   @return [::String]
         #     A brief description of this environment.
@@ -40,7 +40,7 @@ module Google
         #   @return [::String]
         #     Cron-tab formatted schedule by which the job will execute.
         #     Format: minute, hour, day of month, month, day of week,
-        #     e.g. 0 0 * * WED = every Wednesday
+        #     e.g. `0 0 * * WED` = every Wednesday
         #     More examples: https://crontab.guru/examples.html
         # @!attribute [rw] time_zone
         #   @return [::String]

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

@@ -82,7 +82,7 @@ module Google
         # @!attribute [rw] unreachable
         #   @return [::Array<::String>]
         #     Locations that could not be reached. For example,
-        #     ['us-west1-a', 'us-central1-b'].
+        #     `['us-west1-a', 'us-central1-b']`.
         #     A ListInstancesResponse will only contain either instances or unreachables,
         class ListInstancesResponse
           include ::Google::Protobuf::MessageExts
@@ -374,13 +374,13 @@ module Google
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Output only. Additional information about instance health.
         #     Example:
-        #      healthInfo": {
-        #       "docker_proxy_agent_status": "1",
-        #       "docker_status": "1",
-        #       "jupyterlab_api_status": "-1",
-        #       "jupyterlab_status": "-1",
-        #       "updated": "2020-10-18 09:40:03.573409"
-        #      }
+        #         healthInfo": {
+        #           "docker_proxy_agent_status": "1",
+        #           "docker_status": "1",
+        #           "jupyterlab_api_status": "-1",
+        #           "jupyterlab_status": "-1",
+        #           "updated": "2020-10-18 09:40:03.573409"
+        #         }
         class GetInstanceHealthResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,7 +441,7 @@ module Google
         # @!attribute [rw] target_snapshot
         #   @return [::String]
         #     Required. The snapshot for rollback.
-        #     Example: "projects/test-project/global/snapshots/krwlzipynril".
+        #     Example: `projects/test-project/global/snapshots/krwlzipynril`.
         class RollbackInstanceRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -651,7 +651,7 @@ module Google
         # @!attribute [rw] filter
         #   @return [::String]
         #     Filter applied to resulting executions. Currently only supports filtering
-        #     executions by a specified schedule_id.
+        #     executions by a specified `schedule_id`.
         #     Format: `schedule_id=<Schedule_ID>`
         # @!attribute [rw] order_by
         #   @return [::String]

data/proto_docs/google/rpc/status.rb

@@ -28,12 +28,14 @@ module Google
     # [API Design Guide](https://cloud.google.com/apis/design/errors).
     # @!attribute [rw] code
     #   @return [::Integer]
-    #     The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+    #     The status code, which should be an enum value of
+    #     [google.rpc.Code][google.rpc.Code].
     # @!attribute [rw] message
     #   @return [::String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
+    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
+    #     by the client.
     # @!attribute [rw] details
     #   @return [::Array<::Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of