google-cloud-notebooks-v1 0.3.0 → 0.4.1

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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!
+
+
+module Google
+  module Cloud
+    module Notebooks
+      module V1
+        # Defines flags that are used to run the diagnostic tool
+        # @!attribute [rw] gcs_bucket
+        #   @return [::String]
+        #     Required. User Cloud Storage bucket location (REQUIRED).
+        #     Must be formatted with path prefix (`gs://$GCS_BUCKET`).
+        #
+        #     Permissions:
+        #     User Managed Notebooks:
+        #     - storage.buckets.writer: Must be given to the project's service account
+        #       attached to VM.
+        #     Google Managed Notebooks:
+        #     - storage.buckets.writer: Must be given to the project's service account or
+        #       user credentials attached to VM depending on authentication mode.
+        #
+        #     Cloud Storage bucket Log file will be written to
+        #     `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
+        # @!attribute [rw] relative_path
+        #   @return [::String]
+        #     Optional. Defines the relative storage path in the Cloud Storage bucket
+        #     where the diagnostic logs will be written: Default path will be the root
+        #     directory of the Cloud Storage bucket
+        #     (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`)
+        #     Example of full path where Log file will be written:
+        #     `gs://$GCS_BUCKET/$RELATIVE_PATH/`
+        # @!attribute [rw] repair_flag_enabled
+        #   @return [::Boolean]
+        #     Optional. Enables flag to repair service for instance
+        # @!attribute [rw] packet_capture_flag_enabled
+        #   @return [::Boolean]
+        #     Optional. Enables flag to capture packets from the instance for 30 seconds
+        # @!attribute [rw] copy_home_files_flag_enabled
+        #   @return [::Boolean]
+        #     Optional. Enables flag to copy all `/home/jupyter` folder contents
+        class DiagnosticConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -156,6 +156,21 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for upgrading a Managed Notebook Runtime to the latest version.
+        # option (google.api.message_visibility).restriction =
+        #     "TRUSTED_TESTER,SPECIAL_TESTER";
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Format:
+        #     `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Idempotent request UUID.
+        class UpgradeRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request for reporting a Managed Notebook Event.
         # @!attribute [rw] name
         #   @return [::String]
@@ -173,6 +188,43 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for updating a Managed Notebook configuration.
+        # @!attribute [rw] runtime
+        #   @return [::Google::Cloud::Notebooks::V1::Runtime]
+        #     Required. The Runtime to be updated.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Specifies the path, relative to `Runtime`, of
+        #     the field to update. For example, to change the software configuration
+        #     kernels, the `update_mask` parameter would be
+        #     specified as `software_config.kernels`,
+        #     and the `PATCH` request body would specify the new value, as follows:
+        #
+        #         {
+        #           "software_config":{
+        #             "kernels": [{
+        #                'repository':
+        #                'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
+        #                'latest' }],
+        #             }
+        #         }
+        #
+        #
+        #     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
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Idempotent request UUID.
+        class UpdateRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request for getting a new access token.
         # @!attribute [rw] name
         #   @return [::String]
@@ -198,6 +250,19 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request for creating a notebook instance diagnostic file.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Format:
+        #     `projects/{project_id}/locations/{location}/runtimes/{runtimes_id}`
+        # @!attribute [rw] diagnostic_config
+        #   @return [::Google::Cloud::Notebooks::V1::DiagnosticConfig]
+        #     Required. Defines flags that are used to run the diagnostic tool
+        class DiagnoseRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -423,9 +423,31 @@ module Google
         # @!attribute [r] upgradeable
         #   @return [::Boolean]
         #     Output only. Bool indicating whether an newer image is available in an image family.
+        # @!attribute [rw] post_startup_script_behavior
+        #   @return [::Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig::PostStartupScriptBehavior]
+        #     Behavior for the post startup script.
+        # @!attribute [rw] disable_terminal
+        #   @return [::Boolean]
+        #     Bool indicating whether JupyterLab terminal will be available or not.
+        #     Default: False
+        # @!attribute [r] version
+        #   @return [::String]
+        #     Output only. version of boot image such as M100, from release label of the image.
         class RuntimeSoftwareConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Behavior for the post startup script.
+          module PostStartupScriptBehavior
+            # Unspecified post startup script behavior. Will run only once at creation.
+            POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED = 0
+
+            # Runs the post startup script provided during creation at every start.
+            RUN_EVERY_START = 1
+
+            # Downloads and runs the provided post startup script at every start.
+            DOWNLOAD_AND_RUN_EVERY_START = 2
+          end
         end
 
         # Contains runtime daemon metrics, such as OS and kernels and sessions stats.
@@ -526,8 +548,8 @@ module Google
         #
         #     A full URL or partial URI. Examples:
         #
-        #     * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`
-        #     * `projects/[project_id]/regions/global/default`
+        #     * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default`
+        #     * `projects/[project_id]/global/networks/default`
         #
         #     Runtimes are managed resources inside Google Infrastructure.
         #     Runtimes support the following network configurations:

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

@@ -481,6 +481,19 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for creating a notebook instance diagnostic file.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Format:
+        #     `projects/{project_id}/locations/{location}/instances/{instance_id}`
+        # @!attribute [rw] diagnostic_config
+        #   @return [::Google::Cloud::Notebooks::V1::DiagnosticConfig]
+        #     Required. Defines flags that are used to run the diagnostic tool
+        class DiagnoseInstanceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Response for listing environments.
         # @!attribute [rw] environments
         #   @return [::Array<::Google::Cloud::Notebooks::V1::Environment>]

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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!
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/expr.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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!
+
+
+module Google
+  module Type
+    # Represents a textual expression in the Common Expression Language (CEL)
+    # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+    # are documented at https://github.com/google/cel-spec.
+    #
+    # Example (Comparison):
+    #
+    #     title: "Summary size limit"
+    #     description: "Determines if a summary is less than 100 chars"
+    #     expression: "document.summary.size() < 100"
+    #
+    # Example (Equality):
+    #
+    #     title: "Requestor is owner"
+    #     description: "Determines if requestor is the document owner"
+    #     expression: "document.owner == request.auth.claims.email"
+    #
+    # Example (Logic):
+    #
+    #     title: "Public documents"
+    #     description: "Determine whether the document should be publicly visible"
+    #     expression: "document.type != 'private' && document.type != 'internal'"
+    #
+    # Example (Data Manipulation):
+    #
+    #     title: "Notification string"
+    #     description: "Create a notification string with a timestamp."
+    #     expression: "'New message received at ' + string(document.create_time)"
+    #
+    # The exact variables and functions that may be referenced within an expression
+    # are determined by the service that evaluates it. See the service
+    # documentation for additional information.
+    # @!attribute [rw] expression
+    #   @return [::String]
+    #     Textual representation of an expression in Common Expression Language
+    #     syntax.
+    # @!attribute [rw] title
+    #   @return [::String]
+    #     Optional. Title for the expression, i.e. a short string describing
+    #     its purpose. This can be used e.g. in UIs which allow to enter the
+    #     expression.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     Optional. Description of the expression. This is a longer text which
+    #     describes the expression, e.g. when hovered over it in a UI.
+    # @!attribute [rw] location
+    #   @return [::String]
+    #     Optional. String indicating the location of the expression for error
+    #     reporting, e.g. a file name and a position in the file.
+    class Expr
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-notebooks-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,6 +44,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-iam-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +213,7 @@ files:
 - README.md
 - lib/google-cloud-notebooks-v1.rb
 - lib/google/cloud/notebooks/v1.rb
+- lib/google/cloud/notebooks/v1/diagnostic_config_pb.rb
 - lib/google/cloud/notebooks/v1/environment_pb.rb
 - lib/google/cloud/notebooks/v1/event_pb.rb
 - lib/google/cloud/notebooks/v1/execution_pb.rb
@@ -196,8 +237,11 @@ files:
 - lib/google/cloud/notebooks/v1/service_services_pb.rb
 - lib/google/cloud/notebooks/v1/version.rb
 - proto_docs/README.md
+- proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/notebooks/v1/diagnostic_config.rb
 - proto_docs/google/cloud/notebooks/v1/environment.rb
 - proto_docs/google/cloud/notebooks/v1/event.rb
 - proto_docs/google/cloud/notebooks/v1/execution.rb
@@ -211,8 +255,10 @@ files:
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
+- proto_docs/google/type/expr.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0