google-cloud-ai_platform-v1 0.38.0 → 0.40.0

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

@@ -0,0 +1,371 @@
+# 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
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#create_notebook_runtime_template NotebookService.CreateNotebookRuntimeTemplate}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to create the
+        #     NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] notebook_runtime_template
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate]
+        #     Required. The NotebookRuntimeTemplate to create.
+        # @!attribute [rw] notebook_runtime_template_id
+        #   @return [::String]
+        #     Optional. User specified ID for the notebook runtime template.
+        class CreateNotebookRuntimeTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata information for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#create_notebook_runtime_template NotebookService.CreateNotebookRuntimeTemplate}.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     The operation generic information.
+        class CreateNotebookRuntimeTemplateOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#get_notebook_runtime_template NotebookService.GetNotebookRuntimeTemplate}
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntimeTemplate resource.
+        #     Format:
+        #     `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
+        class GetNotebookRuntimeTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtime_templates NotebookService.ListNotebookRuntimeTemplates}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location from which to list the
+        #     NotebookRuntimeTemplates.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. An expression for filtering the results of the request. For field
+        #     names both snake_case and camelCase are supported.
+        #
+        #       * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
+        #         represents the NotebookRuntimeTemplate ID,
+        #         i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
+        #         [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
+        #       * `display_name` supports = and !=
+        #       * `labels` supports general map functions that is:
+        #         * `labels.key=value` - key:value equality
+        #         * `labels.key:* or labels:key - key existence
+        #         * A key including a space must be quoted. `labels."a key"`.
+        #       * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
+        #       [USER_DEFINED, ONE_CLICK].
+        #
+        #     Some examples:
+        #
+        #       * `notebookRuntimeTemplate=notebookRuntimeTemplate123`
+        #       * `displayName="myDisplayName"`
+        #       * `labels.myKey="myValue"`
+        #       * `notebookRuntimeType=USER_DEFINED`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The standard list page size.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The standard list page token.
+        #     Typically obtained via
+        #     {::Google::Cloud::AIPlatform::V1::ListNotebookRuntimeTemplatesResponse#next_page_token ListNotebookRuntimeTemplatesResponse.next_page_token}
+        #     of the previous
+        #     {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtime_templates NotebookService.ListNotebookRuntimeTemplates}
+        #     call.
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Mask specifying which fields to read.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. A comma-separated list of fields to order by, sorted in ascending
+        #     order. Use "desc" after a field name for descending. Supported fields:
+        #
+        #       * `display_name`
+        #       * `create_time`
+        #       * `update_time`
+        #
+        #     Example: `display_name, create_time desc`.
+        class ListNotebookRuntimeTemplatesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtime_templates NotebookService.ListNotebookRuntimeTemplates}.
+        # @!attribute [rw] notebook_runtime_templates
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplate>]
+        #     List of NotebookRuntimeTemplates in the requested page.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListNotebookRuntimeTemplatesRequest#page_token ListNotebookRuntimeTemplatesRequest.page_token}
+        #     to obtain that page.
+        class ListNotebookRuntimeTemplatesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#delete_notebook_runtime_template NotebookService.DeleteNotebookRuntimeTemplate}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntimeTemplate resource to be deleted.
+        #     Format:
+        #     `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
+        class DeleteNotebookRuntimeTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#assign_notebook_runtime NotebookService.AssignNotebookRuntime}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to get the NotebookRuntime
+        #     assignment. Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] notebook_runtime_template
+        #   @return [::String]
+        #     Required. The resource name of the NotebookRuntimeTemplate based on which a
+        #     NotebookRuntime will be assigned (reuse or create a new one).
+        # @!attribute [rw] notebook_runtime
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookRuntime]
+        #     Required. Provide runtime specific information (e.g. runtime owner,
+        #     notebook id) used for NotebookRuntime assignment.
+        # @!attribute [rw] notebook_runtime_id
+        #   @return [::String]
+        #     Optional. User specified ID for the notebook runtime.
+        class AssignNotebookRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata information for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#assign_notebook_runtime NotebookService.AssignNotebookRuntime}.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     The operation generic information.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     A human-readable message that shows the intermediate progress details of
+        #     NotebookRuntime.
+        class AssignNotebookRuntimeOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#get_notebook_runtime NotebookService.GetNotebookRuntime}
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntime resource.
+        #     Instead of checking whether the name is in valid NotebookRuntime resource
+        #     name format, directly throw NotFound exception if there is no such
+        #     NotebookRuntime in spanner.
+        class GetNotebookRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtimes NotebookService.ListNotebookRuntimes}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location from which to list the
+        #     NotebookRuntimes.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. An expression for filtering the results of the request. For field
+        #     names both snake_case and camelCase are supported.
+        #
+        #       * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
+        #         NotebookRuntime ID,
+        #         i.e. the last segment of the NotebookRuntime's [resource name]
+        #         [google.cloud.aiplatform.v1.NotebookRuntime.name].
+        #       * `displayName` supports = and != and regex.
+        #       * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
+        #         represents the NotebookRuntimeTemplate ID,
+        #         i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
+        #         [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
+        #       * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
+        #       HEALTH_STATE_UNSPECIFIED].
+        #       * `runtimeState` supports = and !=. runtimeState enum:
+        #       [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
+        #       STOPPED, BEING_UPGRADED, ERROR, INVALID].
+        #       * `runtimeUser` supports = and !=.
+        #       * API version is UI only: `uiState` supports = and !=. uiState enum:
+        #       [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
+        #       UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
+        #       UI_RESOURCE_STATE_CREATION_FAILED].
+        #       * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
+        #       [USER_DEFINED, ONE_CLICK].
+        #
+        #     Some examples:
+        #
+        #       * `notebookRuntime="notebookRuntime123"`
+        #       * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
+        #       * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
+        #       * `healthState=HEALTHY`
+        #       * `runtimeState=RUNNING`
+        #       * `runtimeUser="test@google.com"`
+        #       * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
+        #       * `notebookRuntimeType=USER_DEFINED`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The standard list page size.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The standard list page token.
+        #     Typically obtained via
+        #     {::Google::Cloud::AIPlatform::V1::ListNotebookRuntimesResponse#next_page_token ListNotebookRuntimesResponse.next_page_token}
+        #     of the previous
+        #     {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtimes NotebookService.ListNotebookRuntimes}
+        #     call.
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Mask specifying which fields to read.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. A comma-separated list of fields to order by, sorted in ascending
+        #     order. Use "desc" after a field name for descending. Supported fields:
+        #
+        #       * `display_name`
+        #       * `create_time`
+        #       * `update_time`
+        #
+        #     Example: `display_name, create_time desc`.
+        class ListNotebookRuntimesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#list_notebook_runtimes NotebookService.ListNotebookRuntimes}.
+        # @!attribute [rw] notebook_runtimes
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::NotebookRuntime>]
+        #     List of NotebookRuntimes in the requested page.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListNotebookRuntimesRequest#page_token ListNotebookRuntimesRequest.page_token}
+        #     to obtain that page.
+        class ListNotebookRuntimesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#delete_notebook_runtime NotebookService.DeleteNotebookRuntime}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntime resource to be deleted.
+        #     Instead of checking whether the name is in valid NotebookRuntime resource
+        #     name format, directly throw NotFound exception if there is no such
+        #     NotebookRuntime in spanner.
+        class DeleteNotebookRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#upgrade_notebook_runtime NotebookService.UpgradeNotebookRuntime}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntime resource to be upgrade.
+        #     Instead of checking whether the name is in valid NotebookRuntime resource
+        #     name format, directly throw NotFound exception if there is no such
+        #     NotebookRuntime in spanner.
+        class UpgradeNotebookRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata information for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#upgrade_notebook_runtime NotebookService.UpgradeNotebookRuntime}.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     The operation generic information.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     A human-readable message that shows the intermediate progress details of
+        #     NotebookRuntime.
+        class UpgradeNotebookRuntimeOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#upgrade_notebook_runtime NotebookService.UpgradeNotebookRuntime}.
+        class UpgradeNotebookRuntimeResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#start_notebook_runtime NotebookService.StartNotebookRuntime}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the NotebookRuntime resource to be started.
+        #     Instead of checking whether the name is in valid NotebookRuntime resource
+        #     name format, directly throw NotFound exception if there is no such
+        #     NotebookRuntime in spanner.
+        class StartNotebookRuntimeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata information for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#start_notebook_runtime NotebookService.StartNotebookRuntime}.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     The operation generic information.
+        # @!attribute [rw] progress_message
+        #   @return [::String]
+        #     A human-readable message that shows the intermediate progress details of
+        #     NotebookRuntime.
+        class StartNotebookRuntimeOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::NotebookService::Client#start_notebook_runtime NotebookService.StartNotebookRuntime}.
+        class StartNotebookRuntimeResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -32,17 +32,31 @@ module Google
         #   @return [::String]
         #     Optional. The format of the data.
         #     Supported formats:
-        #      for NUMBER type: float, double
-        #      for INTEGER type: int32, int64
+        #      for NUMBER type: "float", "double"
+        #      for INTEGER type: "int32", "int64"
+        #      for STRING type: "email", "byte", etc
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     Optional. The title of the Schema.
         # @!attribute [rw] description
         #   @return [::String]
         #     Optional. The description of the data.
         # @!attribute [rw] nullable
         #   @return [::Boolean]
         #     Optional. Indicates if the value may be null.
+        # @!attribute [rw] default
+        #   @return [::Google::Protobuf::Value]
+        #     Optional. Default value of the data.
         # @!attribute [rw] items
         #   @return [::Google::Cloud::AIPlatform::V1::Schema]
-        #     Optional. Schema of the elements of Type.ARRAY.
+        #     Optional. SCHEMA FIELDS FOR TYPE ARRAY
+        #     Schema of the elements of Type.ARRAY.
+        # @!attribute [rw] min_items
+        #   @return [::Integer]
+        #     Optional. Minimum number of the elements for Type.ARRAY.
+        # @!attribute [rw] max_items
+        #   @return [::Integer]
+        #     Optional. Maximum number of the elements for Type.ARRAY.
         # @!attribute [rw] enum
         #   @return [::Array<::String>]
         #     Optional. Possible values of the element of Type.STRING with enum format.
@@ -50,10 +64,35 @@ module Google
         #     \\{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
         # @!attribute [rw] properties
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Schema}]
-        #     Optional. Properties of Type.OBJECT.
+        #     Optional. SCHEMA FIELDS FOR TYPE OBJECT
+        #     Properties of Type.OBJECT.
         # @!attribute [rw] required
         #   @return [::Array<::String>]
         #     Optional. Required properties of Type.OBJECT.
+        # @!attribute [rw] min_properties
+        #   @return [::Integer]
+        #     Optional. Minimum number of the properties for Type.OBJECT.
+        # @!attribute [rw] max_properties
+        #   @return [::Integer]
+        #     Optional. Maximum number of the properties for Type.OBJECT.
+        # @!attribute [rw] minimum
+        #   @return [::Float]
+        #     Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER
+        #     Minimum value of the Type.INTEGER and Type.NUMBER
+        # @!attribute [rw] maximum
+        #   @return [::Float]
+        #     Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+        # @!attribute [rw] min_length
+        #   @return [::Integer]
+        #     Optional. SCHEMA FIELDS FOR TYPE STRING
+        #     Minimum length of the Type.STRING
+        # @!attribute [rw] max_length
+        #   @return [::Integer]
+        #     Optional. Maximum length of the Type.STRING
+        # @!attribute [rw] pattern
+        #   @return [::String]
+        #     Optional. Pattern of the Type.STRING to restrict a string to a regular
+        #     expression.
         # @!attribute [rw] example
         #   @return [::Google::Protobuf::Value]
         #     Optional. Example of the object. Will only populated when the object is the