google-cloud-ai_platform-v1 0.38.0 → 0.40.0

data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb

@@ -242,6 +242,23 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # A set of Shielded Instance options.
+        # See [Images using supported Shielded VM
+        # features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
+        # @!attribute [rw] enable_secure_boot
+        #   @return [::Boolean]
+        #     Defines whether the instance has [Secure
+        #     Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot)
+        #     enabled.
+        #
+        #     Secure Boot helps ensure that the system only runs authentic software by
+        #     verifying the digital signature of all boot components, and halting the
+        #     boot process if signature verification fails.
+        class ShieldedVmConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/aiplatform/v1/network_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Network spec.
+        # @!attribute [rw] enable_internet_access
+        #   @return [::Boolean]
+        #     Whether to enable public internet access. Default false.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     The full name of the Google Compute Engine
+        #     [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+        # @!attribute [rw] subnetwork
+        #   @return [::String]
+        #     The name of the subnet that this instance is in.
+        #     Format:
+        #     `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+        class NetworkSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/notebook_euc_config.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # The euc configuration of NotebookRuntimeTemplate.
+        # @!attribute [rw] euc_disabled
+        #   @return [::Boolean]
+        #     Input only. Whether EUC is disabled in this NotebookRuntimeTemplate.
+        #     In proto3, the default value of a boolean is false. In this way, by default
+        #     EUC will be enabled for NotebookRuntimeTemplate.
+        # @!attribute [r] bypass_actas_check
+        #   @return [::Boolean]
+        #     Output only. Whether ActAs check is bypassed for service account attached
+        #     to the VM. If false, we need ActAs check for the default Compute Engine
+        #     Service account. When a Runtime is created, a VM is allocated using Default
+        #     Compute Engine Service Account. Any user requesting to use this Runtime
+        #     requires Service Account User (ActAs) permission over this SA. If true,
+        #     Runtime owner is using EUC and does not require the above permission as VM
+        #     no longer use default Compute Engine SA, but a P4SA.
+        class NotebookEucConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/notebook_idle_shutdown_config.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # The idle shutdown configuration of NotebookRuntimeTemplate, which contains
+        # the idle_timeout as required field.
+        # @!attribute [rw] idle_timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     Required. Duration is accurate to the second. In Notebook, Idle Timeout is
+        #     accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440
+        #     * 60.
+        # @!attribute [rw] idle_shutdown_disabled
+        #   @return [::Boolean]
+        #     Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
+        class NotebookIdleShutdownConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # A template that specifies runtime configurations such as machine type,
+        # runtime version, network configurations, etc.
+        # Multiple runtimes can be created from a runtime template.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the NotebookRuntimeTemplate.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the NotebookRuntimeTemplate.
+        #     The name can be up to 128 characters long and can consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the NotebookRuntimeTemplate.
+        # @!attribute [r] is_default
+        #   @return [::Boolean]
+        #     Output only. The default template to use if not specified.
+        # @!attribute [rw] machine_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
+        #     Optional. Immutable. The specification of a single machine for the
+        #     template.
+        # @!attribute [rw] data_persistent_disk_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
+        #     Optional. The specification of [persistent
+        #     disk][https://cloud.google.com/compute/docs/disks/persistent-disks]
+        #     attached to the runtime as data disk storage.
+        # @!attribute [rw] network_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
+        #     Optional. Network spec.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     The service account that the runtime workload runs as.
+        #     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 specified, the [Compute Engine default service
+        #     account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
+        #     is used.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Used to perform consistent read-modify-write updates. If not set, a blind
+        #     "overwrite" update happens.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels with user-defined metadata to organize the
+        #     NotebookRuntimeTemplates.
+        #
+        #     Label keys and values can be no longer than 64 characters
+        #     (Unicode codepoints), can only contain lowercase letters, numeric
+        #     characters, underscores and dashes. International characters are allowed.
+        #
+        #     See https://goo.gl/xmQnxf for more information and examples of labels.
+        # @!attribute [rw] idle_shutdown_config
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig]
+        #     The idle shutdown configuration of NotebookRuntimeTemplate. This config
+        #     will only be set when idle shutdown is enabled.
+        # @!attribute [rw] euc_config
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookEucConfig]
+        #     EUC configuration of the NotebookRuntimeTemplate.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this NotebookRuntimeTemplate was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this NotebookRuntimeTemplate was most recently
+        #     updated.
+        # @!attribute [rw] notebook_runtime_type
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeType]
+        #     Optional. Immutable. The type of the notebook runtime template.
+        # @!attribute [rw] shielded_vm_config
+        #   @return [::Google::Cloud::AIPlatform::V1::ShieldedVmConfig]
+        #     Optional. Immutable. Runtime Shielded VM spec.
+        # @!attribute [rw] network_tags
+        #   @return [::Array<::String>]
+        #     Optional. The Compute Engine tags to add to runtime (see [Tagging
+        #     instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
+        class NotebookRuntimeTemplate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A runtime is a virtual machine allocated to a particular user for a
+        # particular Notebook file on temporary basis with lifetime limited to 24
+        # hours.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the NotebookRuntime.
+        # @!attribute [rw] runtime_user
+        #   @return [::String]
+        #     Required. The user email of the NotebookRuntime.
+        # @!attribute [r] notebook_runtime_template_ref
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplateRef]
+        #     Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is
+        #     created from.
+        # @!attribute [r] proxy_uri
+        #   @return [::String]
+        #     Output only. The proxy endpoint used to access the NotebookRuntime.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this NotebookRuntime was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this NotebookRuntime was most recently updated.
+        # @!attribute [r] health_state
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntime::HealthState]
+        #     Output only. The health state of the NotebookRuntime.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the NotebookRuntime.
+        #     The name can be up to 128 characters long and can consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the NotebookRuntime.
+        # @!attribute [r] service_account
+        #   @return [::String]
+        #     Output only. The service account that the NotebookRuntime workload runs as.
+        # @!attribute [r] runtime_state
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntime::RuntimeState]
+        #     Output only. The runtime (instance) state of the NotebookRuntime.
+        # @!attribute [r] is_upgradable
+        #   @return [::Boolean]
+        #     Output only. Whether NotebookRuntime is upgradable.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels with user-defined metadata to organize your
+        #     NotebookRuntime.
+        #
+        #     Label keys and values can be no longer than 64 characters
+        #     (Unicode codepoints), can only contain lowercase letters, numeric
+        #     characters, underscores and dashes. International characters are allowed.
+        #     No more than 64 user labels can be associated with one NotebookRuntime
+        #     (System labels are excluded).
+        #
+        #     See https://goo.gl/xmQnxf for more information and examples of labels.
+        #     System reserved label keys are prefixed with "aiplatform.googleapis.com/"
+        #     and are immutable. Following system labels exist for NotebookRuntime:
+        #
+        #     * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output
+        #     only, its value is the Compute Engine instance id.
+        #     * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is
+        #     either "bigquery" or "vertex"; if absent, it should be "vertex". This is to
+        #     describe the entry service, either BigQuery or Vertex.
+        # @!attribute [r] expiration_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this NotebookRuntime will be expired:
+        #     1. System Predefined NotebookRuntime: 24 hours after creation. After
+        #     expiration, system predifined runtime will be deleted.
+        #     2. User created NotebookRuntime: 6 months after last upgrade. After
+        #     expiration, user created runtime will be stopped and allowed for upgrade.
+        # @!attribute [r] version
+        #   @return [::String]
+        #     Output only. The VM os image version of NotebookRuntime.
+        # @!attribute [r] notebook_runtime_type
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeType]
+        #     Output only. The type of the notebook runtime.
+        # @!attribute [rw] network_tags
+        #   @return [::Array<::String>]
+        #     Optional. The Compute Engine tags to add to runtime (see [Tagging
+        #     instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
+        class NotebookRuntime
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The substate of the NotebookRuntime to display health information.
+          module HealthState
+            # Unspecified health state.
+            HEALTH_STATE_UNSPECIFIED = 0
+
+            # NotebookRuntime is in healthy state. Applies to ACTIVE state.
+            HEALTHY = 1
+
+            # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
+            UNHEALTHY = 2
+          end
+
+          # The substate of the NotebookRuntime to display state of runtime.
+          # The resource of NotebookRuntime is in ACTIVE state for these sub state.
+          module RuntimeState
+            # Unspecified runtime state.
+            RUNTIME_STATE_UNSPECIFIED = 0
+
+            # NotebookRuntime is in running state.
+            RUNNING = 1
+
+            # NotebookRuntime is in starting state.
+            BEING_STARTED = 2
+
+            # NotebookRuntime is in stopping state.
+            BEING_STOPPED = 3
+
+            # NotebookRuntime is in stopped state.
+            STOPPED = 4
+
+            # NotebookRuntime is in upgrading state. It is in the middle of upgrading
+            # process.
+            BEING_UPGRADED = 5
+
+            # NotebookRuntime was unable to start/stop properly.
+            ERROR = 100
+
+            # NotebookRuntime is in invalid state. Cannot be recovered.
+            INVALID = 101
+          end
+        end
+
+        # Represents a notebook runtime type.
+        module NotebookRuntimeType
+          # Unspecified notebook runtime type, NotebookRuntimeType will default to
+          # USER_DEFINED.
+          NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED = 0
+
+          # runtime or template with coustomized configurations from user.
+          USER_DEFINED = 1
+
+          # runtime or template with system defined configurations.
+          ONE_CLICK = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/notebook_runtime_template_ref.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Points to a NotebookRuntimeTemplateRef.
+        # @!attribute [rw] notebook_runtime_template
+        #   @return [::String]
+        #     Immutable. A resource name of the NotebookRuntimeTemplate.
+        class NotebookRuntimeTemplateRef
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end