google-cloud-ai_platform-v1 0.1.0

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

@@ -0,0 +1,60 @@
+# 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
+        # Describes the state of a job.
+        module JobState
+          # The job state is unspecified.
+          JOB_STATE_UNSPECIFIED = 0
+
+          # The job has been just created or resumed and processing has not yet begun.
+          JOB_STATE_QUEUED = 1
+
+          # The service is preparing to run the job.
+          JOB_STATE_PENDING = 2
+
+          # The job is in progress.
+          JOB_STATE_RUNNING = 3
+
+          # The job completed successfully.
+          JOB_STATE_SUCCEEDED = 4
+
+          # The job failed.
+          JOB_STATE_FAILED = 5
+
+          # The job is being cancelled. From this state the job may only go to
+          # either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+          JOB_STATE_CANCELLING = 6
+
+          # The job has been cancelled.
+          JOB_STATE_CANCELLED = 7
+
+          # The job has been stopped, and can be resumed.
+          JOB_STATE_PAUSED = 8
+
+          # The job has expired.
+          JOB_STATE_EXPIRED = 9
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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 subgraph of the overall lineage graph. Event edges connect Artifact and
+        # Execution nodes.
+        # @!attribute [rw] artifacts
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Artifact>]
+        #     The Artifact nodes in the subgraph.
+        # @!attribute [rw] executions
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Execution>]
+        #     The Execution nodes in the subgraph.
+        # @!attribute [rw] events
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Event>]
+        #     The Event edges between Artifacts and Executions in the subgraph.
+        class LineageSubgraph
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,194 @@
+# 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
+        # Specification of a single machine.
+        # @!attribute [rw] machine_type
+        #   @return [::String]
+        #     Immutable. The type of the machine.
+        #
+        #     See the [list of machine types supported for
+        #     prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types)
+        #
+        #     See the [list of machine types supported for custom
+        #     training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).
+        #
+        #     For {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} this field is optional, and the default
+        #     value is `n1-standard-2`. For {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} or as part of
+        #     {::Google::Cloud::AIPlatform::V1::WorkerPoolSpec WorkerPoolSpec} this field is required.
+        # @!attribute [rw] accelerator_type
+        #   @return [::Google::Cloud::AIPlatform::V1::AcceleratorType]
+        #     Immutable. The type of accelerator(s) that may be attached to the machine as per
+        #     {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count accelerator_count}.
+        # @!attribute [rw] accelerator_count
+        #   @return [::Integer]
+        #     The number of accelerators to attach to the machine.
+        class MachineSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A description of resources that are dedicated to a DeployedModel, and
+        # that need a higher degree of manual configuration.
+        # @!attribute [rw] machine_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
+        #     Required. Immutable. The specification of a single machine used by the prediction.
+        # @!attribute [rw] min_replica_count
+        #   @return [::Integer]
+        #     Required. Immutable. The minimum number of machine replicas this DeployedModel will be always
+        #     deployed on. This value must be greater than or equal to 1.
+        #
+        #     If traffic against the DeployedModel increases, it may dynamically be
+        #     deployed onto more replicas, and as traffic decreases, some of these extra
+        #     replicas may be freed.
+        # @!attribute [rw] max_replica_count
+        #   @return [::Integer]
+        #     Immutable. The maximum number of replicas this DeployedModel may be deployed on when
+        #     the traffic against it increases. If the requested value is too large,
+        #     the deployment will error, but if deployment succeeds then the ability
+        #     to scale the model to that many replicas is guaranteed (barring service
+        #     outages). If traffic against the DeployedModel increases beyond what its
+        #     replicas at maximum may handle, a portion of the traffic will be dropped.
+        #     If this value is not provided, will use {::Google::Cloud::AIPlatform::V1::DedicatedResources#min_replica_count min_replica_count} as the
+        #     default value.
+        # @!attribute [rw] autoscaling_metric_specs
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec>]
+        #     Immutable. The metric specifications that overrides a resource
+        #     utilization metric (CPU utilization, accelerator's duty cycle, and so on)
+        #     target value (default to 60 if not set). At most one entry is allowed per
+        #     metric.
+        #
+        #     If {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count} is
+        #     above 0, the autoscaling will be based on both CPU utilization and
+        #     accelerator's duty cycle metrics and scale up when either metrics exceeds
+        #     its target value while scale down if both metrics are under their target
+        #     value. The default target value is 60 for both metrics.
+        #
+        #     If {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count} is
+        #     0, the autoscaling will be based on CPU utilization metric only with
+        #     default target value 60 if not explicitly set.
+        #
+        #     For example, in the case of Online Prediction, if you want to override
+        #     target CPU utilization to 80, you should set
+        #     {::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec#metric_name autoscaling_metric_specs.metric_name}
+        #     to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
+        #     {::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec#target autoscaling_metric_specs.target} to `80`.
+        class DedicatedResources
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A description of resources that to large degree are decided by Vertex AI,
+        # and require only a modest additional configuration.
+        # Each Model supporting these resources documents its specific guidelines.
+        # @!attribute [rw] min_replica_count
+        #   @return [::Integer]
+        #     Immutable. The minimum number of replicas this DeployedModel will be always deployed
+        #     on. If traffic against it increases, it may dynamically be deployed onto
+        #     more replicas up to {::Google::Cloud::AIPlatform::V1::AutomaticResources#max_replica_count max_replica_count}, and as traffic decreases, some
+        #     of these extra replicas may be freed.
+        #     If the requested value is too large, the deployment will error.
+        # @!attribute [rw] max_replica_count
+        #   @return [::Integer]
+        #     Immutable. The maximum number of replicas this DeployedModel may be deployed on when
+        #     the traffic against it increases. If the requested value is too large,
+        #     the deployment will error, but if deployment succeeds then the ability
+        #     to scale the model to that many replicas is guaranteed (barring service
+        #     outages). If traffic against the DeployedModel increases beyond what its
+        #     replicas at maximum may handle, a portion of the traffic will be dropped.
+        #     If this value is not provided, a no upper bound for scaling under heavy
+        #     traffic will be assume, though Vertex AI may be unable to scale beyond
+        #     certain replica number.
+        class AutomaticResources
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A description of resources that are used for performing batch operations, are
+        # dedicated to a Model, and need manual configuration.
+        # @!attribute [rw] machine_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
+        #     Required. Immutable. The specification of a single machine.
+        # @!attribute [rw] starting_replica_count
+        #   @return [::Integer]
+        #     Immutable. The number of machine replicas used at the start of the batch operation.
+        #     If not set, Vertex AI decides starting number, not greater than
+        #     {::Google::Cloud::AIPlatform::V1::BatchDedicatedResources#max_replica_count max_replica_count}
+        # @!attribute [rw] max_replica_count
+        #   @return [::Integer]
+        #     Immutable. The maximum number of machine replicas the batch operation may be scaled
+        #     to. The default value is 10.
+        class BatchDedicatedResources
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Statistics information about resource consumption.
+        # @!attribute [r] replica_hours
+        #   @return [::Float]
+        #     Output only. The number of replica hours used. Note that many replicas may run in
+        #     parallel, and additionally any given work may be queued for some time.
+        #     Therefore this value is not strictly related to wall time.
+        class ResourcesConsumed
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents the spec of disk options.
+        # @!attribute [rw] boot_disk_type
+        #   @return [::String]
+        #     Type of the boot disk (default is "pd-ssd").
+        #     Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or
+        #     "pd-standard" (Persistent Disk Hard Disk Drive).
+        # @!attribute [rw] boot_disk_size_gb
+        #   @return [::Integer]
+        #     Size in GB of the boot disk (default is 100GB).
+        class DiskSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The metric specification that defines the target resource utilization
+        # (CPU utilization, accelerator's duty cycle, and so on) for calculating the
+        # desired replica count.
+        # @!attribute [rw] metric_name
+        #   @return [::String]
+        #     Required. The resource metric name.
+        #     Supported metrics:
+        #
+        #     * For Online Prediction:
+        #     * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle`
+        #     * `aiplatform.googleapis.com/prediction/online/cpu/utilization`
+        # @!attribute [rw] target
+        #   @return [::Integer]
+        #     The target resource utilization in percentage (1% - 100%) for the given
+        #     metric; once the real usage deviates from the target by a certain
+        #     percentage, the machine replicas change. The default value is 60
+        #     (representing 60%) if not provided.
+        class AutoscalingMetricSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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
+        # Manual batch tuning parameters.
+        # @!attribute [rw] batch_size
+        #   @return [::Integer]
+        #     Immutable. The number of the records (e.g. instances) of the operation given in
+        #     each batch to a machine replica. Machine type, and size of a single
+        #     record should be considered when setting this parameter, higher value
+        #     speeds up the batch operation's execution, but too high value will result
+        #     in a whole batch not fitting in a machine's memory, and the whole
+        #     operation will fail.
+        #     The default value is 4.
+        class ManualBatchTuningParameters
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# 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
+        # Instance of a general MetadataSchema.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the MetadataSchema.
+        # @!attribute [rw] schema_version
+        #   @return [::String]
+        #     The version of the MetadataSchema. The version's format must match
+        #     the following regular expression: `^[0-9]+[.][0-9]+[.][0-9]+$`, which would
+        #     allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
+        # @!attribute [rw] schema
+        #   @return [::String]
+        #     Required. The raw YAML string representation of the MetadataSchema. The combination
+        #     of [MetadataSchema.version] and the schema name given by `title` in
+        #     [MetadataSchema.schema] must be unique within a MetadataStore.
+        #
+        #     The schema is defined as an OpenAPI 3.0.2
+        #     [MetadataSchema
+        #     Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
+        # @!attribute [rw] schema_type
+        #   @return [::Google::Cloud::AIPlatform::V1::MetadataSchema::MetadataSchemaType]
+        #     The type of the MetadataSchema. This is a property that identifies which
+        #     metadata types will use the MetadataSchema.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this MetadataSchema was created.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the Metadata Schema
+        class MetadataSchema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes the type of the MetadataSchema.
+          module MetadataSchemaType
+            # Unspecified type for the MetadataSchema.
+            METADATA_SCHEMA_TYPE_UNSPECIFIED = 0
+
+            # A type indicating that the MetadataSchema will be used by Artifacts.
+            ARTIFACT_TYPE = 1
+
+            # A typee indicating that the MetadataSchema will be used by Executions.
+            EXECUTION_TYPE = 2
+
+            # A state indicating that the MetadataSchema will be used by Contexts.
+            CONTEXT_TYPE = 3
+          end
+        end
+      end
+    end
+  end
+end