google-cloud-ai_platform-v1 0.62.0 → 0.63.0

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

@@ -156,12 +156,16 @@ module Google
             # @!attribute [rw] value
             #   @return [::Google::Cloud::AIPlatform::V1::FeatureValue]
             #     Feature value if a single value is requested.
+            #
+            #     Note: The following fields are mutually exclusive: `value`, `values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] values
             #   @return [::Google::Cloud::AIPlatform::V1::FeatureValueList]
             #     Feature values list if values, successive in time, are requested.
             #     If the requested number of values is greater than the number of
             #     existing Feature values, nonexistent values are omitted instead of
             #     being returned as empty.
+            #
+            #     Note: The following fields are mutually exclusive: `values`, `value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             class Data
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -197,33 +201,53 @@ module Google
         # @!attribute [rw] bool_value
         #   @return [::Boolean]
         #     Bool type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] double_value
         #   @return [::Float]
         #     Double type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `double_value`, `bool_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] int64_value
         #   @return [::Integer]
         #     Int64 feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `int64_value`, `bool_value`, `double_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] string_value
         #   @return [::String]
         #     String feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `string_value`, `bool_value`, `double_value`, `int64_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bool_array_value
         #   @return [::Google::Cloud::AIPlatform::V1::BoolArray]
         #     A list of bool type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `bool_array_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] double_array_value
         #   @return [::Google::Cloud::AIPlatform::V1::DoubleArray]
         #     A list of double type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `double_array_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] int64_array_value
         #   @return [::Google::Cloud::AIPlatform::V1::Int64Array]
         #     A list of int64 type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `int64_array_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `string_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] string_array_value
         #   @return [::Google::Cloud::AIPlatform::V1::StringArray]
         #     A list of string type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `string_array_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `bytes_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bytes_value
         #   @return [::String]
         #     Bytes feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `bytes_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] struct_value
         #   @return [::Google::Cloud::AIPlatform::V1::StructValue]
         #     A struct type feature value.
+        #
+        #     Note: The following fields are mutually exclusive: `struct_value`, `bool_value`, `double_value`, `int64_value`, `string_value`, `bool_array_value`, `double_array_value`, `int64_array_value`, `string_array_value`, `bytes_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] metadata
         #   @return [::Google::Cloud::AIPlatform::V1::FeatureValue::Metadata]
         #     Metadata of feature value.

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

@@ -180,18 +180,25 @@ module Google
         # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#import_feature_values FeaturestoreService.ImportFeatureValues}.
         # @!attribute [rw] avro_source
         #   @return [::Google::Cloud::AIPlatform::V1::AvroSource]
+        #     Note: The following fields are mutually exclusive: `avro_source`, `bigquery_source`, `csv_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bigquery_source
         #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
+        #     Note: The following fields are mutually exclusive: `bigquery_source`, `avro_source`, `csv_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] csv_source
         #   @return [::Google::Cloud::AIPlatform::V1::CsvSource]
+        #     Note: The following fields are mutually exclusive: `csv_source`, `avro_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] feature_time_field
         #   @return [::String]
         #     Source column that holds the Feature timestamp for all Feature
         #     values in each entity.
+        #
+        #     Note: The following fields are mutually exclusive: `feature_time_field`, `feature_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] feature_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Single Feature timestamp for all entities being imported. The
         #     timestamp must not have higher than millisecond precision.
+        #
+        #     Note: The following fields are mutually exclusive: `feature_time`, `feature_time_field`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] entity_type
         #   @return [::String]
         #     Required. The resource name of the EntityType grouping the Features for
@@ -293,9 +300,13 @@ module Google
         #
         #     Values in the timestamp column must use the RFC 3339 format, e.g.
         #     `2012-07-30T10:43:17.123Z`.
+        #
+        #     Note: The following fields are mutually exclusive: `csv_read_instances`, `bigquery_read_instances`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bigquery_read_instances
         #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
         #     Similar to csv_read_instances, but from BigQuery source.
+        #
+        #     Note: The following fields are mutually exclusive: `bigquery_read_instances`, `csv_read_instances`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] featurestore
         #   @return [::String]
         #     Required. The resource name of the Featurestore from which to query Feature
@@ -364,10 +375,14 @@ module Google
         #   @return [::Google::Cloud::AIPlatform::V1::ExportFeatureValuesRequest::SnapshotExport]
         #     Exports the latest Feature values of all entities of the EntityType
         #     within a time range.
+        #
+        #     Note: The following fields are mutually exclusive: `snapshot_export`, `full_export`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] full_export
         #   @return [::Google::Cloud::AIPlatform::V1::ExportFeatureValuesRequest::FullExport]
         #     Exports all historical values of all entities of the EntityType within a
         #     time range
+        #
+        #     Note: The following fields are mutually exclusive: `full_export`, `snapshot_export`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] entity_type
         #   @return [::String]
         #     Required. The resource name of the EntityType from which to export Feature
@@ -441,6 +456,8 @@ module Google
         #     in
         #     {::Google::Cloud::AIPlatform::V1::FeatureValueDestination#bigquery_destination FeatureValueDestination.bigquery_destination}
         #     must refer to a table.
+        #
+        #     Note: The following fields are mutually exclusive: `bigquery_destination`, `tfrecord_destination`, `csv_destination`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] tfrecord_destination
         #   @return [::Google::Cloud::AIPlatform::V1::TFRecordDestination]
         #     Output in TFRecord format.
@@ -454,10 +471,14 @@ module Google
         #         STRING, STRING_ARRAY, BYTES                | BYTES_LIST
         #         true -> byte_string("true"), false -> byte_string("false")
         #         BOOL, BOOL_ARRAY (true, false)             | BYTES_LIST
+        #
+        #     Note: The following fields are mutually exclusive: `tfrecord_destination`, `bigquery_destination`, `csv_destination`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] csv_destination
         #   @return [::Google::Cloud::AIPlatform::V1::CsvDestination]
         #     Output in CSV format. Array Feature value types are not allowed in CSV
         #     format.
+        #
+        #     Note: The following fields are mutually exclusive: `csv_destination`, `bigquery_destination`, `tfrecord_destination`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class FeatureValueDestination
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1082,10 +1103,14 @@ module Google
         # @!attribute [rw] select_entity
         #   @return [::Google::Cloud::AIPlatform::V1::DeleteFeatureValuesRequest::SelectEntity]
         #     Select feature values to be deleted by specifying entities.
+        #
+        #     Note: The following fields are mutually exclusive: `select_entity`, `select_time_range_and_feature`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] select_time_range_and_feature
         #   @return [::Google::Cloud::AIPlatform::V1::DeleteFeatureValuesRequest::SelectTimeRangeAndFeature]
         #     Select feature values to be deleted by specifying time range and
         #     features.
+        #
+        #     Note: The following fields are mutually exclusive: `select_time_range_and_feature`, `select_entity`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] entity_type
         #   @return [::String]
         #     Required. The resource name of the EntityType grouping the Features for
@@ -1137,9 +1162,13 @@ module Google
         # @!attribute [rw] select_entity
         #   @return [::Google::Cloud::AIPlatform::V1::DeleteFeatureValuesResponse::SelectEntity]
         #     Response for request specifying the entities to delete
+        #
+        #     Note: The following fields are mutually exclusive: `select_entity`, `select_time_range_and_feature`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] select_time_range_and_feature
         #   @return [::Google::Cloud::AIPlatform::V1::DeleteFeatureValuesResponse::SelectTimeRangeAndFeature]
         #     Response for request specifying time range and feature
+        #
+        #     Note: The following fields are mutually exclusive: `select_time_range_and_feature`, `select_entity`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class DeleteFeatureValuesResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -191,12 +191,18 @@ module Google
           # @!attribute [rw] value_int
           #   @return [::Integer]
           #     Represents 64 bit integer.
+          #
+          #     Note: The following fields are mutually exclusive: `value_int`, `value_float`, `value_double`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] value_float
           #   @return [::Float]
           #     Represents 32 bit float.
+          #
+          #     Note: The following fields are mutually exclusive: `value_float`, `value_int`, `value_double`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] value_double
           #   @return [::Float]
           #     Represents 64 bit float.
+          #
+          #     Note: The following fields are mutually exclusive: `value_double`, `value_int`, `value_float`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] namespace
           #   @return [::String]
           #     The namespace of this restriction. e.g.: cost.

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

@@ -255,15 +255,23 @@ module Google
           # @!attribute [rw] sharepoint_folder_path
           #   @return [::String]
           #     The path of the SharePoint folder to download from.
+          #
+          #     Note: The following fields are mutually exclusive: `sharepoint_folder_path`, `sharepoint_folder_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] sharepoint_folder_id
           #   @return [::String]
           #     The ID of the SharePoint folder to download from.
+          #
+          #     Note: The following fields are mutually exclusive: `sharepoint_folder_id`, `sharepoint_folder_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] drive_name
           #   @return [::String]
           #     The name of the drive to download from.
+          #
+          #     Note: The following fields are mutually exclusive: `drive_name`, `drive_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] drive_id
           #   @return [::String]
           #     The ID of the drive to download from.
+          #
+          #     Note: The following fields are mutually exclusive: `drive_id`, `drive_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] client_id
           #   @return [::String]
           #     The Application ID for the app registered in Microsoft Azure Portal.

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

@@ -26,15 +26,23 @@ module Google
         # @!attribute [r] ml_engine_model_version
         #   @return [::Google::Cloud::AIPlatform::V1::MigratableResource::MlEngineModelVersion]
         #     Output only. Represents one Version in ml.googleapis.com.
+        #
+        #     Note: The following fields are mutually exclusive: `ml_engine_model_version`, `automl_model`, `automl_dataset`, `data_labeling_dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] automl_model
         #   @return [::Google::Cloud::AIPlatform::V1::MigratableResource::AutomlModel]
         #     Output only. Represents one Model in automl.googleapis.com.
+        #
+        #     Note: The following fields are mutually exclusive: `automl_model`, `ml_engine_model_version`, `automl_dataset`, `data_labeling_dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] automl_dataset
         #   @return [::Google::Cloud::AIPlatform::V1::MigratableResource::AutomlDataset]
         #     Output only. Represents one Dataset in automl.googleapis.com.
+        #
+        #     Note: The following fields are mutually exclusive: `automl_dataset`, `ml_engine_model_version`, `automl_model`, `data_labeling_dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_labeling_dataset
         #   @return [::Google::Cloud::AIPlatform::V1::MigratableResource::DataLabelingDataset]
         #     Output only. Represents one Dataset in datalabeling.googleapis.com.
+        #
+        #     Note: The following fields are mutually exclusive: `data_labeling_dataset`, `ml_engine_model_version`, `automl_model`, `automl_dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] last_migrate_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Timestamp when the last migration attempt on this

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

@@ -92,18 +92,26 @@ module Google
         # @!attribute [rw] migrate_ml_engine_model_version_config
         #   @return [::Google::Cloud::AIPlatform::V1::MigrateResourceRequest::MigrateMlEngineModelVersionConfig]
         #     Config for migrating Version in ml.googleapis.com to Vertex AI's Model.
+        #
+        #     Note: The following fields are mutually exclusive: `migrate_ml_engine_model_version_config`, `migrate_automl_model_config`, `migrate_automl_dataset_config`, `migrate_data_labeling_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] migrate_automl_model_config
         #   @return [::Google::Cloud::AIPlatform::V1::MigrateResourceRequest::MigrateAutomlModelConfig]
         #     Config for migrating Model in automl.googleapis.com to Vertex AI's
         #     Model.
+        #
+        #     Note: The following fields are mutually exclusive: `migrate_automl_model_config`, `migrate_ml_engine_model_version_config`, `migrate_automl_dataset_config`, `migrate_data_labeling_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] migrate_automl_dataset_config
         #   @return [::Google::Cloud::AIPlatform::V1::MigrateResourceRequest::MigrateAutomlDatasetConfig]
         #     Config for migrating Dataset in automl.googleapis.com to Vertex AI's
         #     Dataset.
+        #
+        #     Note: The following fields are mutually exclusive: `migrate_automl_dataset_config`, `migrate_ml_engine_model_version_config`, `migrate_automl_model_config`, `migrate_data_labeling_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] migrate_data_labeling_dataset_config
         #   @return [::Google::Cloud::AIPlatform::V1::MigrateResourceRequest::MigrateDataLabelingDatasetConfig]
         #     Config for migrating Dataset in datalabeling.googleapis.com to
         #     Vertex AI's Dataset.
+        #
+        #     Note: The following fields are mutually exclusive: `migrate_data_labeling_dataset_config`, `migrate_ml_engine_model_version_config`, `migrate_automl_model_config`, `migrate_automl_dataset_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class MigrateResourceRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -213,9 +221,13 @@ module Google
         # @!attribute [rw] dataset
         #   @return [::String]
         #     Migrated Dataset's resource name.
+        #
+        #     Note: The following fields are mutually exclusive: `dataset`, `model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] model
         #   @return [::String]
         #     Migrated Model's resource name.
+        #
+        #     Note: The following fields are mutually exclusive: `model`, `dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] migratable_resource
         #   @return [::Google::Cloud::AIPlatform::V1::MigratableResource]
         #     Before migration, the identifier in ml.googleapis.com,
@@ -242,12 +254,18 @@ module Google
           # @!attribute [rw] error
           #   @return [::Google::Rpc::Status]
           #     The error result of the migration request in case of failure.
+          #
+          #     Note: The following fields are mutually exclusive: `error`, `model`, `dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] model
           #   @return [::String]
           #     Migrated model resource name.
+          #
+          #     Note: The following fields are mutually exclusive: `model`, `error`, `dataset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] dataset
           #   @return [::String]
           #     Migrated dataset resource name.
+          #
+          #     Note: The following fields are mutually exclusive: `dataset`, `error`, `model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] request
           #   @return [::Google::Cloud::AIPlatform::V1::MigrateResourceRequest]
           #     It's the same as the value in

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

@@ -59,6 +59,9 @@ module Google
         # @!attribute [rw] version_description
         #   @return [::String]
         #     The description of this version.
+        # @!attribute [rw] default_checkpoint_id
+        #   @return [::String]
+        #     The default checkpoint id of a model version.
         # @!attribute [rw] predict_schemata
         #   @return [::Google::Cloud::AIPlatform::V1::PredictSchemata]
         #     The schemata that describe formats of the Model's predictions and
@@ -409,9 +412,13 @@ module Google
           # @!attribute [rw] model_garden_source
           #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
           #     Source information of Model Garden models.
+          #
+          #     Note: The following fields are mutually exclusive: `model_garden_source`, `genie_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] genie_source
           #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
           #     Information about the base model of Genie models.
+          #
+          #     Note: The following fields are mutually exclusive: `genie_source`, `model_garden_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class BaseModelSource
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -146,16 +146,22 @@ module Google
               #   @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::Value]
               #     A unique specific value for a given feature.
               #     Example: `{ "value": { "string_value": "12345" } }`
+              #
+              #     Note: The following fields are mutually exclusive: `value`, `range`, `all_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] range
               #   @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::Range]
               #     A range of values for a numerical feature.
               #     Example: `{"range":{"low":10000.0,"high":50000.0}}`
               #     will capture 12345 and 23334 in the slice.
+              #
+              #     Note: The following fields are mutually exclusive: `range`, `value`, `all_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] all_values
               #   @return [::Google::Protobuf::BoolValue]
               #     If all_values is set to true, then all possible labels of the keyed
               #     feature will have another slice computed.
               #     Example: `{"all_values":{"value":true}}`
+              #
+              #     Note: The following fields are mutually exclusive: `all_values`, `value`, `range`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               class SliceConfig
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -178,9 +184,13 @@ module Google
               # @!attribute [rw] string_value
               #   @return [::String]
               #     String type.
+              #
+              #     Note: The following fields are mutually exclusive: `string_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] float_value
               #   @return [::Float]
               #     Float type.
+              #
+              #     Note: The following fields are mutually exclusive: `float_value`, `string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               class Value
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -44,14 +44,20 @@ module Google
           # @!attribute [rw] dataset
           #   @return [::String]
           #     The resource name of the Dataset used to train this Model.
+          #
+          #     Note: The following fields are mutually exclusive: `dataset`, `gcs_source`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] gcs_source
           #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
           #     The Google Cloud Storage uri of the unmanaged Dataset used to train
           #     this Model.
+          #
+          #     Note: The following fields are mutually exclusive: `gcs_source`, `dataset`, `bigquery_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] bigquery_source
           #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
           #     The BigQuery table of the unmanaged Dataset used to train this
           #     Model.
+          #
+          #     Note: The following fields are mutually exclusive: `bigquery_source`, `dataset`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] data_format
           #   @return [::String]
           #     Data format of the dataset, only applicable if the input is from
@@ -180,9 +186,13 @@ module Google
             # @!attribute [rw] gcs
             #   @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
             #     Cloud Storage location for BatchExplain output.
+            #
+            #     Note: The following fields are mutually exclusive: `gcs`, `bigquery`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] bigquery
             #   @return [::Google::Cloud::AIPlatform::V1::BigQueryDestination]
             #     BigQuery location for BatchExplain output.
+            #
+            #     Note: The following fields are mutually exclusive: `bigquery`, `gcs`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] prediction_format
             #   @return [::Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig::ExplanationBaseline::PredictionFormat]
             #     The storage format of the predictions generated BatchPrediction job.

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

@@ -240,6 +240,65 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_version_checkpoints ModelService.ListModelVersionCheckpoints}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the model version to list checkpoints for.
+        #     `projects/{project}/locations/{location}/models/{model}@{version}`
+        #     Example: `projects/{project}/locations/{location}/models/{model}@2`
+        #     or
+        #     `projects/{project}/locations/{location}/models/{model}@golden`
+        #     If no version ID or alias is specified, the latest version will be
+        #     used.
+        # @!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::ListModelVersionCheckpointsResponse#next_page_token next_page_token}
+        #     of the previous
+        #     {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_version_checkpoints ListModelVersionCheckpoints}
+        #     call.
+        class ListModelVersionCheckpointsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A proto representation of a Spanner-stored ModelVersionCheckpoint.
+        # The meaning of the fields is equivalent to their in-Spanner counterparts.
+        # @!attribute [rw] checkpoint_id
+        #   @return [::String]
+        #     The ID of the checkpoint.
+        # @!attribute [rw] epoch
+        #   @return [::Integer]
+        #     The epoch of the checkpoint.
+        # @!attribute [rw] step
+        #   @return [::Integer]
+        #     The step of the checkpoint.
+        class ModelVersionCheckpoint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::ModelService::Client#list_model_version_checkpoints ModelService.ListModelVersionCheckpoints}
+        # @!attribute [rw] checkpoints
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::ModelVersionCheckpoint>]
+        #     List of Model Version checkpoints.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListModelVersionCheckpointsRequest#page_token ListModelVersionCheckpointsRequest.page_token}
+        #     to obtain that page.
+        class ListModelVersionCheckpointsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::AIPlatform::V1::ModelService::Client#update_model ModelService.UpdateModel}.
         # @!attribute [rw] model
@@ -447,11 +506,15 @@ module Google
         #
         #     This value may be up to 63 characters, and valid characters are
         #     `[a-z0-9_-]`. The first character cannot be a number or hyphen.
+        #
+        #     Note: The following fields are mutually exclusive: `model_id`, `parent_model`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] parent_model
         #   @return [::String]
         #     Optional. Specify this field to copy source_model into this existing
         #     Model as a new version. Format:
         #     `projects/{project}/locations/{location}/models/{model}`
+        #
+        #     Note: The following fields are mutually exclusive: `parent_model`, `model_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The resource name of the Location into which to copy the Model.

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

@@ -25,19 +25,29 @@ module Google
         # @!attribute [rw] dataform_repository_source
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource]
         #     The Dataform Repository pointing to a single file notebook repository.
+        #
+        #     Note: The following fields are mutually exclusive: `dataform_repository_source`, `gcs_notebook_source`, `direct_notebook_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] gcs_notebook_source
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource]
         #     The Cloud Storage url pointing to the ipynb file. Format:
         #     `gs://bucket/notebook_file.ipynb`
+        #
+        #     Note: The following fields are mutually exclusive: `gcs_notebook_source`, `dataform_repository_source`, `direct_notebook_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] direct_notebook_source
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource]
         #     The contents of an input notebook file.
+        #
+        #     Note: The following fields are mutually exclusive: `direct_notebook_source`, `dataform_repository_source`, `gcs_notebook_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] notebook_runtime_template_resource_name
         #   @return [::String]
         #     The NotebookRuntimeTemplate to source compute configuration from.
+        #
+        #     Note: The following fields are mutually exclusive: `notebook_runtime_template_resource_name`, `custom_environment_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] custom_environment_spec
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec]
         #     The custom compute configuration for an execution job.
+        #
+        #     Note: The following fields are mutually exclusive: `custom_environment_spec`, `notebook_runtime_template_resource_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] gcs_output_uri
         #   @return [::String]
         #     The Cloud Storage location to upload the result to. Format:
@@ -45,9 +55,13 @@ module Google
         # @!attribute [rw] execution_user
         #   @return [::String]
         #     The user email to run the execution as. Only supported by Colab runtimes.
+        #
+        #     Note: The following fields are mutually exclusive: `execution_user`, `service_account`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] service_account
         #   @return [::String]
         #     The service account to run the execution as.
+        #
+        #     Note: The following fields are mutually exclusive: `service_account`, `execution_user`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] workbench_runtime
         #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::WorkbenchRuntime]
         #     The Workbench runtime configuration to use for the notebook execution.

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

@@ -398,9 +398,13 @@ module Google
         # @!attribute [r] container_detail
         #   @return [::Google::Cloud::AIPlatform::V1::PipelineTaskExecutorDetail::ContainerDetail]
         #     Output only. The detailed info for a container executor.
+        #
+        #     Note: The following fields are mutually exclusive: `container_detail`, `custom_job_detail`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] custom_job_detail
         #   @return [::Google::Cloud::AIPlatform::V1::PipelineTaskExecutorDetail::CustomJobDetail]
         #     Output only. The detailed info for a custom job executor.
+        #
+        #     Note: The following fields are mutually exclusive: `custom_job_detail`, `container_detail`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class PipelineTaskExecutorDetail
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -471,6 +471,9 @@ module Google
         #   @return [::Integer]
         #     The total number of billable characters counted across all instances from
         #     the request.
+        # @!attribute [r] prompt_tokens_details
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>]
+        #     Output only. List of modalities that were processed in the request input.
         class CountTokensResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -617,6 +620,16 @@ module Google
           #   @return [::Integer]
           #     Output only. Number of tokens in the cached part in the input (the cached
           #     content).
+          # @!attribute [r] prompt_tokens_details
+          #   @return [::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>]
+          #     Output only. List of modalities that were processed in the request input.
+          # @!attribute [r] cache_tokens_details
+          #   @return [::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>]
+          #     Output only. List of modalities of the cached content in the request
+          #     input.
+          # @!attribute [r] candidates_tokens_details
+          #   @return [::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>]
+          #     Output only. List of modalities that were returned in the response.
           class UsageMetadata
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -64,17 +64,25 @@ module Google
           # @!attribute [rw] uri
           #   @return [::String]
           #     The URI of the resource.
+          #
+          #     Note: The following fields are mutually exclusive: `uri`, `resource_name`, `use_case`, `description`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] resource_name
           #   @return [::String]
           #     The resource name of the Google Cloud resource.
+          #
+          #     Note: The following fields are mutually exclusive: `resource_name`, `uri`, `use_case`, `description`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] use_case
           #   @deprecated This field is deprecated and may be removed in the next major version update.
           #   @return [::String]
           #     Use case (CUJ) of the resource.
+          #
+          #     Note: The following fields are mutually exclusive: `use_case`, `uri`, `resource_name`, `description`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] description
           #   @deprecated This field is deprecated and may be removed in the next major version update.
           #   @return [::String]
           #     Description of the resource.
+          #
+          #     Note: The following fields are mutually exclusive: `description`, `uri`, `resource_name`, `use_case`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class ResourceReference
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -204,15 +212,21 @@ module Google
             #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
             #     A description of resources that are dedicated to the DeployedModel,
             #     and that need a higher degree of manual configuration.
+            #
+            #     Note: The following fields are mutually exclusive: `dedicated_resources`, `automatic_resources`, `shared_resources`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] automatic_resources
             #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
             #     A description of resources that to large degree are decided by Vertex
             #     AI, and require only a modest additional configuration.
+            #
+            #     Note: The following fields are mutually exclusive: `automatic_resources`, `dedicated_resources`, `shared_resources`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] shared_resources
             #   @return [::String]
             #     The resource name of the shared DeploymentResourcePool to deploy on.
             #     Format:
             #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
+            #
+            #     Note: The following fields are mutually exclusive: `shared_resources`, `dedicated_resources`, `automatic_resources`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             # @!attribute [rw] model_display_name
             #   @return [::String]
             #     Optional. Default model display name.