google-cloud-retail-v2 0.14.0 → 0.15.0

data/lib/google/cloud/retail/v2/serving_config_service/rest/client.rb

@@ -674,9 +674,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

data/lib/google/cloud/retail/v2/user_event_pb.rb

@@ -32,6 +32,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :uri, :string, 13
       optional :referrer_uri, :string, 14
       optional :page_view_id, :string, 15
+      optional :entity, :string, 23
     end
     add_message "google.cloud.retail.v2.ProductDetail" do
       optional :product, :message, 1, "google.cloud.retail.v2.Product"

data/lib/google/cloud/retail/v2/user_event_service/client.rb

@@ -303,7 +303,7 @@ module Google
             #
             #   @param prebuilt_rule [::String]
             #     The prebuilt rule name that can convert a specific type of raw_json.
-            #     For example: "default_schema/v1.0"
+            #     For example: "ga4_bq" rule for the GA4 user event schema.
             #   @param parent [::String]
             #     Required. The parent catalog name, such as
             #     `projects/1234/locations/global/catalogs/default_catalog`.
@@ -763,9 +763,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/retail/v2/user_event_service/operations.rb

@@ -620,9 +620,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/retail/v2/user_event_service/rest/client.rb

@@ -271,7 +271,7 @@ module Google
               #
               #   @param prebuilt_rule [::String]
               #     The prebuilt rule name that can convert a specific type of raw_json.
-              #     For example: "default_schema/v1.0"
+              #     For example: "ga4_bq" rule for the GA4 user event schema.
               #   @param parent [::String]
               #     Required. The parent catalog name, such as
               #     `projects/1234/locations/global/catalogs/default_catalog`.
@@ -618,9 +618,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

data/lib/google/cloud/retail/v2/user_event_service/rest/operations.rb

@@ -411,9 +411,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

data/lib/google/cloud/retail/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.14.0"
+        VERSION = "0.15.0"
       end
     end
   end

data/lib/google/cloud/retail/v2.rb

@@ -19,6 +19,7 @@
 require "google/cloud/retail/v2/catalog_service"
 require "google/cloud/retail/v2/completion_service"
 require "google/cloud/retail/v2/control_service"
+require "google/cloud/retail/v2/model_service"
 require "google/cloud/retail/v2/prediction_service"
 require "google/cloud/retail/v2/product_service"
 require "google/cloud/retail/v2/search_service"

data/proto_docs/google/api/client.rb

@@ -35,7 +35,9 @@ module Google
     # Details about how and where to publish client libraries.
     # @!attribute [rw] version
     #   @return [::String]
-    #     Version of the API to apply these settings to.
+    #     Version of the API to apply these settings to. This is the full protobuf
+    #     package for the API, ending in the version element.
+    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
     # @!attribute [rw] launch_stage
     #   @return [::Google::Api::LaunchStage]
     #     Launch stage of this version of the API.
@@ -111,6 +113,10 @@ module Google
     #     Client library settings.  If the same version string appears multiple
     #     times in this list, then the last one wins.  Settings from earlier
     #     settings with the same version string are discarded.
+    # @!attribute [rw] proto_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to proto reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from original service names to renamed versions.
+    #     This is used when the default generated types
+    #     would cause a naming conflict. (Neither name is
+    #     fully-qualified.)
+    #     Example: Subscriber to SubscriberServiceApi.
+    # @!attribute [rw] renamed_resources
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from full resource types to the effective short name
+    #     for the resource. This is used when otherwise resource
+    #     named from different services would cause naming collisions.
+    #     Example entry:
+    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
+    # @!attribute [rw] ignored_resources
+    #   @return [::Array<::String>]
+    #     List of full resource types to ignore during generation.
+    #     This is typically used for API-specific Location resources,
+    #     which should be handled by the generator as if they were actually
+    #     the common Location resources.
+    #     Example entry: "documentai.googleapis.com/Location"
+    # @!attribute [rw] forced_namespace_aliases
+    #   @return [::Array<::String>]
+    #     Namespaces which must be aliased in snippets due to
+    #     a known (but non-generator-predictable) naming collision
+    # @!attribute [rw] handwritten_signatures
+    #   @return [::Array<::String>]
+    #     Method signatures (in the form "service.method(signature)")
+    #     which are provided separately, so shouldn't be generated.
+    #     Snippets *calling* these methods are still generated, however.
     class DotnetSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedResourcesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
     #     Example of a YAML configuration::
     #
     #      publishing:
-    #        method_behavior:
-    #          - selector: CreateAdDomain
+    #        method_settings:
+    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
     #              initial_poll_delay:
     #                seconds: 60 # 1 minute

data/proto_docs/google/cloud/retail/v2/catalog.rb

@@ -89,6 +89,10 @@ module Google
         #     characters and underscores. For example, an attribute named
         #     `attributes.abc_xyz` can be indexed, but an attribute named
         #     `attributes.abc-xyz` cannot be indexed.
+        #
+        #     If the attribute key starts with `attributes.`, then the attribute is a
+        #     custom attribute. Attributes such as `brands`, `patterns`, and `title` are
+        #     built-in and called system attributes.
         # @!attribute [r] in_use
         #   @return [::Boolean]
         #     Output only. Indicates whether this attribute has been used by any
@@ -153,11 +157,14 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption]
         #     If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
         #     This property only applies to textual custom attributes and requires
-        #     indexable set to enabled to enable exact-searchable.
+        #     indexable set to enabled to enable exact-searchable. If unset, the server
+        #     behavior defaults to
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption::EXACT_SEARCHABLE_DISABLED EXACT_SEARCHABLE_DISABLED}.
         # @!attribute [rw] retrievable_option
         #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption]
         #     If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
-        #     results.
+        #     results. If unset, the server behavior defaults to
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption::RETRIEVABLE_DISABLED RETRIEVABLE_DISABLED}.
         class CatalogAttribute
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -215,8 +222,7 @@ module Google
 
           # The status of the exact-searchable option of a catalog attribute.
           module ExactSearchableOption
-            # Value used when unset. Defaults to
-            # {::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption::EXACT_SEARCHABLE_DISABLED EXACT_SEARCHABLE_DISABLED}.
+            # Value used when unset.
             EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0
 
             # Exact searchable option enabled for an attribute.
@@ -228,8 +234,7 @@ module Google
 
           # The status of the retrievable option of a catalog attribute.
           module RetrievableOption
-            # Value used when unset. Defaults to
-            # {::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption::RETRIEVABLE_DISABLED RETRIEVABLE_DISABLED}.
+            # Value used when unset.
             RETRIEVABLE_OPTION_UNSPECIFIED = 0
 
             # Retrievable option enabled for an attribute.

data/proto_docs/google/cloud/retail/v2/common.rb

@@ -350,7 +350,7 @@ module Google
         #     it is expected to have only 1 color. May consider using single "Mixed"
         #     instead of multiple values.
         #
-        #     A maximum of 25 colors are allowed. Each value must be a UTF-8 encoded
+        #     A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded
         #     string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
@@ -805,6 +805,20 @@ module Google
           SOLUTION_TYPE_SEARCH = 2
         end
 
+        # If filtering for recommendations is enabled.
+        module RecommendationsFilteringOption
+          # Value used when unset.
+          # In this case, server behavior defaults to
+          # {::Google::Cloud::Retail::V2::RecommendationsFilteringOption::RECOMMENDATIONS_FILTERING_DISABLED RECOMMENDATIONS_FILTERING_DISABLED}.
+          RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED = 0
+
+          # Recommendation filtering is disabled.
+          RECOMMENDATIONS_FILTERING_DISABLED = 1
+
+          # Recommendation filtering is enabled.
+          RECOMMENDATIONS_FILTERING_ENABLED = 3
+        end
+
         # The use case of Cloud Retail Search.
         module SearchSolutionUseCase
           # The value when it's unspecified. In this case, server behavior defaults to

data/proto_docs/google/cloud/retail/v2/completion_service.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        # Auto-complete parameters.
+        # Autocomplete parameters.
         # @!attribute [rw] catalog
         #   @return [::String]
         #     Required. Catalog for which the completion is performed.
@@ -94,12 +94,20 @@ module Google
         #
         #     The maximum allowed max suggestions is 20. If it is set higher, it will be
         #     capped by 20.
+        # @!attribute [rw] entity
+        #   @return [::String]
+        #     The entity for customers that may run multiple different entities, domains,
+        #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+        #     `google.com`, `youtube.com`, etc.
+        #     If this is set, it should be exactly matched with
+        #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get
+        #     per-entity autocomplete results.
         class CompleteQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response of the auto-complete query.
+        # Response of the autocomplete query.
         # @!attribute [rw] completion_results
         #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>]
         #     Results of the matching suggestions. The result list is ordered and the

data/proto_docs/google/cloud/retail/v2/import_config.rb

@@ -113,7 +113,7 @@ module Google
         #       The schema is available here:
         #       https://support.google.com/analytics/answer/7029846.
         #
-        #     Supported values for auto-completion imports:
+        #     Supported values for autocomplete imports:
         #
         #     * `suggestions` (default): One JSON completion suggestion per line.
         #     * `denylist`:  One JSON deny suggestion per line.

data/proto_docs/google/cloud/retail/v2/model.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Retail
+      module V2
+        # Metadata that describes the training and serving parameters of a
+        # {::Google::Cloud::Retail::V2::Model Model}. A
+        # {::Google::Cloud::Retail::V2::Model Model} can be associated with a
+        # {::Google::Cloud::Retail::V2::ServingConfig ServingConfig} and then queried
+        # through the Predict API.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified resource name of the model.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        #     catalog_id has char limit of 50.
+        #     recommendation_model_id has char limit of 40.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the model.
+        #
+        #     Should be human readable, used to display Recommendation Models in the
+        #     Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024
+        #     characters.
+        # @!attribute [rw] training_state
+        #   @return [::Google::Cloud::Retail::V2::Model::TrainingState]
+        #     Optional. The training state that the model is in (e.g.
+        #     `TRAINING` or `PAUSED`).
+        #
+        #     Since part of the cost of running the service
+        #     is frequency of training - this can be used to determine when to train
+        #     model in order to control cost. If not specified: the default value for
+        #     `CreateModel` method is `TRAINING`. The default value for
+        #     `UpdateModel` method is to keep the state the same as before.
+        # @!attribute [r] serving_state
+        #   @return [::Google::Cloud::Retail::V2::Model::ServingState]
+        #     Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the Recommendation Model was created at.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the Recommendation Model was last updated. E.g.
+        #     if a Recommendation Model was paused - this would be the time the pause was
+        #     initiated.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     Required. The type of model e.g. `home-page`.
+        #
+        #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
+        #     `frequently-bought-together`, `page-optimization`, `similar-items`,
+        #     `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).
+        #
+        #
+        #     This field together with
+        #     {::Google::Cloud::Retail::V2::Model#optimization_objective optimization_objective}
+        #     describe model metadata to use to control model training and serving.
+        #     See https://cloud.google.com/retail/docs/models
+        #     for more details on what the model metadata control and which combination
+        #     of parameters are valid. For invalid combinations of parameters (e.g. type
+        #     = `frequently-bought-together` and optimization_objective = `ctr`), you
+        #     receive an error 400 if you try to create/update a recommendation with
+        #     this set of knobs.
+        # @!attribute [rw] optimization_objective
+        #   @return [::String]
+        #     Optional. The optimization objective e.g. `cvr`.
+        #
+        #     Currently supported
+        #     values: `ctr`, `cvr`, `revenue-per-order`.
+        #
+        #      If not specified, we choose default based on model type.
+        #     Default depends on type of recommendation:
+        #
+        #     `recommended-for-you` => `ctr`
+        #
+        #     `others-you-may-like` => `ctr`
+        #
+        #     `frequently-bought-together` => `revenue_per_order`
+        #
+        #     This field together with
+        #     {::Google::Cloud::Retail::V2::Model#type optimization_objective}
+        #     describe model metadata to use to control model training and serving.
+        #     See https://cloud.google.com/retail/docs/models
+        #     for more details on what the model metadata control and which combination
+        #     of parameters are valid. For invalid combinations of parameters (e.g. type
+        #     = `frequently-bought-together` and optimization_objective = `ctr`), you
+        #     receive an error 400 if you try to create/update a recommendation with
+        #     this set of knobs.
+        # @!attribute [rw] periodic_tuning_state
+        #   @return [::Google::Cloud::Retail::V2::Model::PeriodicTuningState]
+        #     Optional. The state of periodic tuning.
+        #
+        #     The period we use is 3 months - to do a
+        #     one-off tune earlier use the `TuneModel` method. Default value
+        #     is `PERIODIC_TUNING_ENABLED`.
+        # @!attribute [r] last_tune_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the latest successful tune finished.
+        # @!attribute [r] tuning_operation
+        #   @return [::String]
+        #     Output only. The tune operation associated with the model.
+        #
+        #     Can be used to determine if there is an ongoing tune for this
+        #     recommendation. Empty field implies no tune is goig on.
+        # @!attribute [r] data_state
+        #   @return [::Google::Cloud::Retail::V2::Model::DataState]
+        #     Output only. The state of data requirements for this model: `DATA_OK` and
+        #     `DATA_ERROR`.
+        #
+        #     Recommendation model cannot be trained if the data is in
+        #     `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even
+        #     if serving state is `ACTIVE`: models were trained successfully before, but
+        #     cannot be refreshed because model no longer has sufficient
+        #     data for training.
+        # @!attribute [rw] filtering_option
+        #   @return [::Google::Cloud::Retail::V2::RecommendationsFilteringOption]
+        #     Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering
+        #     by attributes is enabled for the model.
+        # @!attribute [r] serving_config_lists
+        #   @return [::Array<::Google::Cloud::Retail::V2::Model::ServingConfigList>]
+        #     Output only. The list of valid serving configs associated with the
+        #     PageOptimizationConfig.
+        class Model
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents an ordered combination of valid serving configs, which
+          # can be used for `PAGE_OPTIMIZATION` recommendations.
+          # @!attribute [rw] serving_config_ids
+          #   @return [::Array<::String>]
+          #     Optional. A set of valid serving configs that may be used for
+          #     `PAGE_OPTIMIZATION`.
+          class ServingConfigList
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The serving state of the model.
+          module ServingState
+            # Unspecified serving state.
+            SERVING_STATE_UNSPECIFIED = 0
+
+            # The model is not serving.
+            INACTIVE = 1
+
+            # The model is serving and can be queried.
+            ACTIVE = 2
+
+            # The model is trained on tuned hyperparameters and can be
+            # queried.
+            TUNED = 3
+          end
+
+          # The training state of the model.
+          module TrainingState
+            # Unspecified training state.
+            TRAINING_STATE_UNSPECIFIED = 0
+
+            # The model training is paused.
+            PAUSED = 1
+
+            # The model is training.
+            TRAINING = 2
+          end
+
+          # Describes whether periodic tuning is enabled for this model
+          # or not. Periodic tuning is scheduled at most every three months. You can
+          # start a tuning process manually by using the `TuneModel`
+          # method, which starts a tuning process immediately and resets the quarterly
+          # schedule. Enabling or disabling periodic tuning does not affect any
+          # current tuning processes.
+          module PeriodicTuningState
+            # Unspecified default value, should never be explicitly set.
+            PERIODIC_TUNING_STATE_UNSPECIFIED = 0
+
+            # The model has periodic tuning disabled. Tuning
+            # can be reenabled by calling the `EnableModelPeriodicTuning`
+            # method or by calling the `TuneModel` method.
+            PERIODIC_TUNING_DISABLED = 1
+
+            # The model cannot be tuned with periodic tuning OR the
+            # `TuneModel` method. Hide the options in customer UI and
+            # reject any requests through the backend self serve API.
+            ALL_TUNING_DISABLED = 3
+
+            # The model has periodic tuning enabled. Tuning
+            # can be disabled by calling the `DisableModelPeriodicTuning`
+            # method.
+            PERIODIC_TUNING_ENABLED = 2
+          end
+
+          # Describes whether this model have sufficient training data
+          # to be continuously trained.
+          module DataState
+            # Unspecified default value, should never be explicitly set.
+            DATA_STATE_UNSPECIFIED = 0
+
+            # The model has sufficient training data.
+            DATA_OK = 1
+
+            # The model does not have sufficient training data. Error
+            # messages can be queried via Stackdriver.
+            DATA_ERROR = 2
+          end
+        end
+      end
+    end
+  end
+end