google-cloud-ai_platform-v1 0.1.0

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

@@ -0,0 +1,109 @@
+# 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 AIPlatform
+      module V1
+        # Represents a HyperparameterTuningJob. A HyperparameterTuningJob
+        # has a Study specification and multiple CustomJobs with identical
+        # CustomJob specification.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the HyperparameterTuningJob.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the HyperparameterTuningJob.
+        #     The name can be up to 128 characters long and can be consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] study_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::StudySpec]
+        #     Required. Study configuration of the HyperparameterTuningJob.
+        # @!attribute [rw] max_trial_count
+        #   @return [::Integer]
+        #     Required. The desired total number of Trials.
+        # @!attribute [rw] parallel_trial_count
+        #   @return [::Integer]
+        #     Required. The desired number of Trials to run in parallel.
+        # @!attribute [rw] max_failed_trial_count
+        #   @return [::Integer]
+        #     The number of failed Trials that need to be seen before failing
+        #     the HyperparameterTuningJob.
+        #
+        #     If set to 0, Vertex AI decides how many Trials must fail
+        #     before the whole job fails.
+        # @!attribute [rw] trial_job_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::CustomJobSpec]
+        #     Required. The spec of a trial job. The same spec applies to the CustomJobs created
+        #     in all the trials.
+        # @!attribute [r] trials
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Trial>]
+        #     Output only. Trials of the HyperparameterTuningJob.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AIPlatform::V1::JobState]
+        #     Output only. The detailed state of the job.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the HyperparameterTuningJob was created.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the HyperparameterTuningJob for the first time entered the
+        #     `JOB_STATE_RUNNING` state.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the HyperparameterTuningJob entered any of the following states:
+        #     `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the HyperparameterTuningJob was most recently updated.
+        # @!attribute [r] error
+        #   @return [::Google::Rpc::Status]
+        #     Output only. Only populated when job's state is JOB_STATE_FAILED or
+        #     JOB_STATE_CANCELLED.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels with user-defined metadata to organize HyperparameterTuningJobs.
+        #
+        #     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] encryption_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
+        #     Customer-managed encryption key options for a HyperparameterTuningJob.
+        #     If this is set, then all resources created by the HyperparameterTuningJob
+        #     will be encrypted with the provided encryption key.
+        class HyperparameterTuningJob
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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 AIPlatform
+      module V1
+        # A representation of a collection of database items organized in a way that
+        # allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the Index.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the Index.
+        #     The name can be up to 128 characters long and can be consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of the Index.
+        # @!attribute [rw] metadata_schema_uri
+        #   @return [::String]
+        #     Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
+        #     information about the Index, that is specific to it. Unset if the Index
+        #     does not have any additional information.
+        #     The schema is defined as an OpenAPI 3.0.2 [Schema
+        #     Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
+        #     Note: The URI given on output will be immutable and probably different,
+        #     including the URI scheme, than the one given on input. The output URI will
+        #     point to a location where the user only has a read access.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Protobuf::Value]
+        #     An additional information about the Index; the schema of the metadata can
+        #     be found in {::Google::Cloud::AIPlatform::V1::Index#metadata_schema_uri metadata_schema}.
+        # @!attribute [r] deployed_indexes
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef>]
+        #     Output only. The pointers to DeployedIndexes created from this Index.
+        #     An Index can be only deleted if all its DeployedIndexes had been undeployed
+        #     first.
+        # @!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 your Indexes.
+        #
+        #     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 [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Index was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Index was most recently updated.
+        #     This also includes any update to the contents of the Index.
+        #     Note that Operations working on this Index may have their
+        #     [Operations.metadata.generic_metadata.update_time]
+        #     [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this
+        #     timestamp, yet that does not mean their results are not already reflected
+        #     in the Index. Result of any successfully completed Operation on the Index
+        #     is reflected in it.
+        class Index
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,252 @@
+# 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 AIPlatform
+      module V1
+        # Indexes are deployed into it. An IndexEndpoint can have multiple
+        # DeployedIndexes.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the IndexEndpoint.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the IndexEndpoint.
+        #     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 IndexEndpoint.
+        # @!attribute [r] deployed_indexes
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::DeployedIndex>]
+        #     Output only. The indexes deployed in this endpoint.
+        # @!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 your IndexEndpoints.
+        #
+        #     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 [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this IndexEndpoint was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this IndexEndpoint was last updated.
+        #     This timestamp is not updated when the endpoint's DeployedIndexes are
+        #     updated, e.g. due to updates of the original Indexes they are the
+        #     deployments of.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Optional. The full name of the Google Compute Engine
+        #     [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
+        #     to which the IndexEndpoint should be peered.
+        #
+        #     Private services access must already be configured for the network. If left
+        #     unspecified, the Endpoint is not peered with any network.
+        #
+        #     Only one of the fields, {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} or
+        #     {::Google::Cloud::AIPlatform::V1::IndexEndpoint#enable_private_service_connect enable_private_service_connect},
+        #     can be set.
+        #
+        #     [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
+        #     projects/\\{project}/global/networks/\\{network}.
+        #     Where \\{project} is a project number, as in '12345', and \\{network} is
+        #     network name.
+        # @!attribute [rw] enable_private_service_connect
+        #   @return [::Boolean]
+        #     Optional. If true, expose the IndexEndpoint via private service connect.
+        #
+        #     Only one of the fields, {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} or
+        #     {::Google::Cloud::AIPlatform::V1::IndexEndpoint#enable_private_service_connect enable_private_service_connect},
+        #     can be set.
+        class IndexEndpoint
+          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 deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Required. The user specified ID of the DeployedIndex.
+        #     The ID can be up to 128 characters long and must start with a letter and
+        #     only contain letters, numbers, and underscores.
+        #     The ID must be unique within the project it is created in.
+        # @!attribute [rw] index
+        #   @return [::String]
+        #     Required. The name of the Index this is the deployment of.
+        #     We may refer to this Index as the DeployedIndex's "original" Index.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the DeployedIndex. If not provided upon creation,
+        #     the Index's display_name is used.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the DeployedIndex was created.
+        # @!attribute [r] private_endpoints
+        #   @return [::Google::Cloud::AIPlatform::V1::IndexPrivateEndpoints]
+        #     Output only. Provides paths for users to send requests directly to the deployed index
+        #     services running on Cloud via private services access. This field is
+        #     populated if {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} is configured.
+        # @!attribute [r] index_sync_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The DeployedIndex may depend on various data on its original Index.
+        #     Additionally when certain changes to the original Index are being done
+        #     (e.g. when what the Index contains is being changed) the DeployedIndex may
+        #     be asynchronously updated in the background to reflect this changes.
+        #     If this timestamp's value is at least the {::Google::Cloud::AIPlatform::V1::Index#update_time Index.update_time} of the
+        #     original Index, it means that this DeployedIndex and the original Index are
+        #     in sync. If this timestamp is older, then to see which updates this
+        #     DeployedIndex already contains (and which not), one must
+        #     [list][Operations.ListOperations] [Operations][Operation]
+        #     [working][Operation.name] on the original Index. Only
+        #     the successfully completed Operations with
+        #     [Operations.metadata.generic_metadata.update_time]
+        #     [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time]
+        #     equal or before this sync time are contained in this DeployedIndex.
+        # @!attribute [rw] automatic_resources
+        #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
+        #     Optional. A description of resources that the DeployedIndex uses, which to large
+        #     degree are decided by Vertex AI, and optionally allows only a modest
+        #     additional configuration.
+        #     If min_replica_count is not set, the default value is 2 (we don't provide
+        #     SLA when min_replica_count=1). If max_replica_count is not set, the
+        #     default value is min_replica_count. The max allowed replica count is
+        #     1000.
+        # @!attribute [rw] dedicated_resources
+        #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
+        #     Optional. A description of resources that are dedicated to the DeployedIndex, and
+        #     that need a higher degree of manual configuration.
+        #     If min_replica_count is not set, the default value is 2 (we don't provide
+        #     SLA when min_replica_count=1). If max_replica_count is not set, the
+        #     default value is min_replica_count. The max allowed replica count is
+        #     1000.
+        #
+        #     Available machine types:
+        #     n1-standard-16
+        #     n1-standard-32
+        # @!attribute [rw] enable_access_logging
+        #   @return [::Boolean]
+        #     Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
+        #
+        #     These logs are like standard server access logs, containing
+        #     information like timestamp and latency for each MatchRequest.
+        #
+        #     Note that Stackdriver logs may incur a cost, especially if the deployed
+        #     index receives a high queries per second rate (QPS).
+        #     Estimate your costs before enabling this option.
+        # @!attribute [rw] deployed_index_auth_config
+        #   @return [::Google::Cloud::AIPlatform::V1::DeployedIndexAuthConfig]
+        #     Optional. If set, the authentication is enabled for the private endpoint.
+        # @!attribute [rw] reserved_ip_ranges
+        #   @return [::Array<::String>]
+        #     Optional. A list of reserved ip ranges under the VPC network that can be
+        #     used for this DeployedIndex.
+        #
+        #     If set, we will deploy the index within the provided ip ranges. Otherwise,
+        #     the index might be deployed to any ip ranges under the provided VPC
+        #     network.
+        #
+        #     The value sohuld be the name of the address
+        #     (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
+        #     Example: 'vertex-ai-ip-range'.
+        # @!attribute [rw] deployment_group
+        #   @return [::String]
+        #     Optional. The deployment group can be no longer than 64 characters (eg:
+        #     'test', 'prod'). If not set, we will use the 'default' deployment group.
+        #
+        #     Creating `deployment_groups` with `reserved_ip_ranges` is a recommended
+        #     practice when the peered network has multiple peering ranges. This creates
+        #     your deployments from predictable IP spaces for easier traffic
+        #     administration. Also, one deployment_group (except 'default') can only be
+        #     used with the same reserved_ip_ranges which means if the deployment_group
+        #     has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or
+        #     [d, e] is disallowed.
+        #
+        #     Note: we only support up to 5 deployment groups(not including 'default').
+        class DeployedIndex
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Used to set up the auth on the DeployedIndex's private endpoint.
+        # @!attribute [rw] auth_provider
+        #   @return [::Google::Cloud::AIPlatform::V1::DeployedIndexAuthConfig::AuthProvider]
+        #     Defines the authentication provider that the DeployedIndex uses.
+        class DeployedIndexAuthConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for an authentication provider, including support for
+          # [JSON Web Token
+          # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+          # @!attribute [rw] audiences
+          #   @return [::Array<::String>]
+          #     The list of JWT
+          #     [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
+          #     that are allowed to access. A JWT containing any of these audiences will
+          #     be accepted.
+          # @!attribute [rw] allowed_issuers
+          #   @return [::Array<::String>]
+          #     A list of allowed JWT issuers. Each entry must be a valid Google
+          #     service account, in the following format:
+          #
+          #     `service-account-name@project-id.iam.gserviceaccount.com`
+          class AuthProvider
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # IndexPrivateEndpoints proto is used to provide paths for users to send
+        # requests via private endpoints (e.g. private service access, private service
+        # connect).
+        # To send request via private service access, use match_grpc_address.
+        # To send request via private service connect, use service_attachment.
+        # @!attribute [r] match_grpc_address
+        #   @return [::String]
+        #     Output only. The ip address used to send match gRPC requests.
+        # @!attribute [r] service_attachment
+        #   @return [::String]
+        #     Output only. The name of the service attachment resource. Populated if private service
+        #     connect is enabled.
+        class IndexPrivateEndpoints
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end