google-cloud-recommender-v1 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736646a7b14bb372a37c935d1226bc4b44eaf94b05ce0f310cdcfb34fca8757d
-  data.tar.gz: ce84d36a2d29029c05bf87a776ba66f2a89560dab41dfcc1c4628472b84b4e4c
+  metadata.gz: 0c07ede538d7b6fe226deff0fe9555b72bc8b1ef957c4d1badf2bcfe1e8131db
+  data.tar.gz: 2a2578a106bae9b06695edafff7e5ada609faeaf62bb7dfa34d3deb6f15ac62c
 SHA512:
-  metadata.gz: 0cb5533b2734e04980a328e56cd9d12c3607adadc387e51506e47281cb5175099df39354609d9be0bfa15e47b570b491ab4bc21bab5171b2a51a3e89cfe56d82
-  data.tar.gz: 9b8cfe7d18e2e5f8eac84fcee2e3501405811a508f2d1f18e694a2339dd1b39b8cd7c82d96b52020c1b93f44028fc3787e3d4298659c76a7cf53b13f37a4707d
+  metadata.gz: a115cc7aafef4de636abb88c6a3e9d6e6a127f24fca040ff6752cd0d993e9f72cd6e1da5207db2820c7cfafd7ebc2030500f92295c281fd7fdba1adf2ba0f487
+  data.tar.gz: 7d1a8ad0828a66cd7959530436aba412a405222e59df4377bb0c917d1f7d4e1332f4b425beefcd9535da1eaaafb450d01916e0620c35560ba6e840f9ec33c747

data/AUTHENTICATION.md

@@ -1,16 +1,17 @@
 # Authentication
 
-In general, the google-cloud-recommender-v1 library uses [Service
-Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within [Google
-Cloud Platform environments](#google-cloud-platform-environments)
-the credentials will be discovered automatically. When running on other
+In general, the google-cloud-recommender-v1 library uses
+[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within
+[Google Cloud Platform environments](#google-cloud-platform-environments) the
+credentials will be discovered automatically. When running on other
 environments, the Service Account credentials can be specified by providing the
-path to the [JSON
-keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
-the account (or the JSON itself) in [environment
-variables](#environment-variables). Additionally, Cloud SDK credentials can also
-be discovered automatically, but this is only recommended during development.
+path to the
+[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
+for the account (or the JSON itself) in
+[environment variables](#environment-variables). Additionally, Cloud SDK
+credentials can also be discovered automatically, but this is only recommended
+during development.
 
 ## Quickstart
 
@@ -46,23 +47,24 @@ without **Service Account Credentials** directly in code.
 
 ### Google Cloud Platform environments
 
-When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
-Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
-(GCF) and Cloud Run, **Credentials** and are discovered
-automatically. Code should be written as if already authenticated.
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
+Code should be written as if already authenticated.
 
 ### Environment Variables
 
-The **Credentials JSON** can be placed in environment
-variables instead of declaring them directly in code. Each service has its own
-environment variable, allowing for different service accounts to be used for
-different services. (See the READMEs for the individual service gems for
-details.) The path to the **Credentials JSON** file can be stored in the
-environment variable, or the **Credentials JSON** itself can be stored for
-environments such as Docker containers where writing files is difficult or not
-encouraged.
+The **Credentials JSON** can be placed in environment variables instead of
+declaring them directly in code. Each service has its own environment variable,
+allowing for different service accounts to be used for different services. (See
+the READMEs for the individual service gems for details.) The path to the
+**Credentials JSON** file can be stored in the environment variable, or the
+**Credentials JSON** itself can be stored for environments such as Docker
+containers where writing files is difficult or not encouraged.
 
-The environment variables that google-cloud-recommender-v1 checks for credentials are configured on the service Credentials class (such as {Google::Cloud::Recommender::V1::Recommender::Credentials}):
+The environment variables that google-cloud-recommender-v1
+checks for credentials are configured on the service Credentials class (such as
+{Google::Cloud::Recommender::V1::Recommender::Credentials}):
 
 1. `RECOMMENDER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `RECOMMENDER_KEYFILE` - Path to JSON file, or JSON contents
@@ -80,7 +82,8 @@ client = Google::Cloud::Recommender::V1::Recommender::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in environment variables. Either on an individual client initialization:
+The **Credentials JSON** can be configured instead of placing them in
+environment variables. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/recommender/v1"
@@ -137,15 +140,15 @@ environments](#google-cloud-platform-environments), you need a Google
 Developers service account.
 
 1. Visit the [Google Developers Console][dev-console].
-1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
+2. Create a new project or click on an existing project.
+3. Activate the slide-out navigation tray and select **API Manager**. From
    here, you will enable the APIs that your application requires.
 
    ![Enable the APIs that your application requires][enable-apis]
 
    *Note: You may need to enable billing in order to use these services.*
 
-1. Select **Credentials** from the side navigation.
+4. Select **Credentials** from the side navigation.
 
    You should see a screen like one of the following.
 

data/lib/google/cloud/recommender/v1/recommender/client.rb

@@ -40,7 +40,18 @@ module Google
             attr_reader :recommender_stub
 
             ##
-            # Configuration for the Recommender Client API.
+            # Configure the Recommender Client class.
+            #
+            # See {Google::Cloud::Recommender::V1::Recommender::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # ## Example
+            #
+            # To modify the configuration for all Recommender clients:
+            #
+            #     Google::Cloud::Recommender::V1::Recommender::Client.configure do |config|
+            #       config.timeout = 10_000
+            #     end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -56,7 +67,31 @@ module Google
                                   break parent_const.configure if parent_const&.respond_to? :configure
                                   namespace.pop
                                 end
-                Client::Configuration.new parent_config
+                default_config = Client::Configuration.new parent_config
+
+                default_config.rpcs.list_recommendations.timeout = 60.0
+                default_config.rpcs.list_recommendations.retry_policy = {
+                  initial_delay: 0.1,
+                  max_delay:     60.0,
+                  multiplier:    1.3,
+                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                }
+
+                default_config.rpcs.get_recommendation.timeout = 60.0
+                default_config.rpcs.get_recommendation.retry_policy = {
+                  initial_delay: 0.1,
+                  max_delay:     60.0,
+                  multiplier:    1.3,
+                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                }
+
+                default_config.rpcs.mark_recommendation_claimed.timeout = 60.0
+
+                default_config.rpcs.mark_recommendation_succeeded.timeout = 60.0
+
+                default_config.rpcs.mark_recommendation_failed.timeout = 60.0
+
+                default_config
               end
               yield @configure if block_given?
               @configure
@@ -69,6 +104,9 @@ module Google
             # but structural changes (adding new fields, etc.) are not allowed. Structural changes
             # should be made on {Client.configure}.
             #
+            # See {Google::Cloud::Recommender::V1::Recommender::Client::Configuration}
+            # for a description of the configuration fields.
+            #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
             #
@@ -80,9 +118,23 @@ module Google
             end
 
             ##
-            # Create a new Client client object.
+            # Create a new Recommender client object.
             #
-            # @yield [config] Configure the Client client.
+            # ## Examples
+            #
+            # To create a new Recommender client with the default
+            # configuration:
+            #
+            #     client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            # To create a new Recommender client with a custom
+            # configuration:
+            #
+            #     client = Google::Cloud::Recommender::V1::Recommender::Client.new do |config|
+            #       config.timeout = 10_000
+            #     end
+            #
+            # @yield [config] Configure the Recommender client.
             # @yieldparam config [Client::Configuration]
             #
             def initialize
@@ -104,7 +156,7 @@ module Google
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
-
+              @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
 
               @recommender_stub = Gapic::ServiceStub.new(
                 Google::Cloud::Recommender::V1::Recommender::Stub,
@@ -167,15 +219,16 @@ module Google
               request = Gapic::Protobuf.coerce request, to: Google::Cloud::Recommender::V1::ListRecommendationsRequest
 
               # Converts hash and nil to an options object
-              options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+              options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
               # Customize the options with defaults
               metadata = @config.rpcs.list_recommendations.metadata.to_h
 
-              # Set x-goog-api-client header
+              # Set x-goog-api-client and x-goog-user-project headers
               metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
                 lib_name: @config.lib_name, lib_version: @config.lib_version,
                 gapic_version: ::Google::Cloud::Recommender::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
                 "parent" => request.parent
@@ -228,15 +281,16 @@ module Google
               request = Gapic::Protobuf.coerce request, to: Google::Cloud::Recommender::V1::GetRecommendationRequest
 
               # Converts hash and nil to an options object
-              options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+              options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
               # Customize the options with defaults
               metadata = @config.rpcs.get_recommendation.metadata.to_h
 
-              # Set x-goog-api-client header
+              # Set x-goog-api-client and x-goog-user-project headers
               metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
                 lib_name: @config.lib_name, lib_version: @config.lib_version,
                 gapic_version: ::Google::Cloud::Recommender::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
                 "name" => request.name
@@ -291,8 +345,8 @@ module Google
             #   @param state_metadata [Hash{String => String}]
             #     State properties to include with this state. Overwrites any existing
             #     `state_metadata`.
-            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-            #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+            #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
@@ -311,15 +365,16 @@ module Google
               request = Gapic::Protobuf.coerce request, to: Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest
 
               # Converts hash and nil to an options object
-              options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+              options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
               # Customize the options with defaults
               metadata = @config.rpcs.mark_recommendation_claimed.metadata.to_h
 
-              # Set x-goog-api-client header
+              # Set x-goog-api-client and x-goog-user-project headers
               metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
                 lib_name: @config.lib_name, lib_version: @config.lib_version,
                 gapic_version: ::Google::Cloud::Recommender::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
                 "name" => request.name
@@ -374,8 +429,8 @@ module Google
             #   @param state_metadata [Hash{String => String}]
             #     State properties to include with this state. Overwrites any existing
             #     `state_metadata`.
-            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-            #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+            #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
@@ -394,15 +449,16 @@ module Google
               request = Gapic::Protobuf.coerce request, to: Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest
 
               # Converts hash and nil to an options object
-              options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+              options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
               # Customize the options with defaults
               metadata = @config.rpcs.mark_recommendation_succeeded.metadata.to_h
 
-              # Set x-goog-api-client header
+              # Set x-goog-api-client and x-goog-user-project headers
               metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
                 lib_name: @config.lib_name, lib_version: @config.lib_version,
                 gapic_version: ::Google::Cloud::Recommender::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
                 "name" => request.name
@@ -457,8 +513,8 @@ module Google
             #   @param state_metadata [Hash{String => String}]
             #     State properties to include with this state. Overwrites any existing
             #     `state_metadata`.
-            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-            #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+            #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+            #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
             #   @param etag [String]
             #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
             #
@@ -477,15 +533,16 @@ module Google
               request = Gapic::Protobuf.coerce request, to: Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest
 
               # Converts hash and nil to an options object
-              options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+              options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
               # Customize the options with defaults
               metadata = @config.rpcs.mark_recommendation_failed.metadata.to_h
 
-              # Set x-goog-api-client header
+              # Set x-goog-api-client and x-goog-user-project headers
               metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
                 lib_name: @config.lib_name, lib_version: @config.lib_version,
                 gapic_version: ::Google::Cloud::Recommender::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {
                 "name" => request.name
@@ -509,6 +566,81 @@ module Google
 
             ##
             # Configuration class for the Recommender API.
+            #
+            # This class represents the configuration for Recommender,
+            # providing control over timeouts, retry behavior, logging, transport
+            # parameters, and other low-level controls. Certain parameters can also be
+            # applied individually to specific RPCs. See
+            # {Google::Cloud::Recommender::V1::Recommender::Client::Configuration::Rpcs}
+            # for a list of RPCs that can be configured independently.
+            #
+            # Configuration can be applied globally to all clients, or to a single client
+            # on construction.
+            #
+            # # Examples
+            #
+            # To modify the global config, setting the timeout for list_recommendations
+            # to 20 seconds, and all remaining timeouts to 10 seconds:
+            #
+            #     Google::Cloud::Recommender::V1::Recommender::Client.configure do |config|
+            #       config.timeout = 10_000
+            #       config.rpcs.list_recommendations.timeout = 20_000
+            #     end
+            #
+            # To apply the above configuration only to a new client:
+            #
+            #     client = Google::Cloud::Recommender::V1::Recommender::Client.new do |config|
+            #       config.timeout = 10_000
+            #       config.rpcs.list_recommendations.timeout = 20_000
+            #     end
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"recommender.googleapis.com"`.
+            #   @return [String]
+            # @!attribute [rw] credentials
+            #   Credentials to send with calls. You may provide any of the following types:
+            #    *  (`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))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+            #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+            #    *  (`nil`) indicating no credentials
+            #   @return [Object]
+            # @!attribute [rw] scope
+            #   The OAuth scopes
+            #   @return [Array<String>]
+            # @!attribute [rw] lib_name
+            #   The library name as recorded in instrumentation and logging
+            #   @return [String]
+            # @!attribute [rw] lib_version
+            #   The library version as recorded in instrumentation and logging
+            #   @return [String]
+            # @!attribute [rw] channel_args
+            #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+            #   `GRPC::Core::Channel` object is provided as the credential.
+            #   @return [Hash]
+            # @!attribute [rw] interceptors
+            #   An array of interceptors that are run before calls are executed.
+            #   @return [Array<GRPC::ClientInterceptor>]
+            # @!attribute [rw] timeout
+            #   The call timeout in milliseconds.
+            #   @return [Numeric]
+            # @!attribute [rw] metadata
+            #   Additional gRPC headers to be sent with the call.
+            #   @return [Hash{Symbol=>String}]
+            # @!attribute [rw] retry_policy
+            #   The retry policy. The value is a hash with the following keys:
+            #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+            #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+            #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [Hash]
+            #
             class Configuration
               extend Gapic::Config
 
@@ -527,12 +659,17 @@ module Google
               config_attr :metadata,     nil, Hash, nil
               config_attr :retry_policy, nil, Hash, Proc, nil
 
+              # @private
               def initialize parent_config = nil
                 @parent_config = parent_config unless parent_config.nil?
 
                 yield self if block_given?
               end
 
+              ##
+              # Configurations for individual RPCs
+              # @return [Rpcs]
+              #
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
@@ -543,13 +680,49 @@ module Google
 
               ##
               # Configuration RPC class for the Recommender API.
+              #
+              # Includes fields providing the configuration for each RPC in this service.
+              # Each configuration object is of type `Gapic::Config::Method` and includes
+              # the following configuration fields:
+              #
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+              #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+              #     include the following keys:
+              #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #         trigger a retry.
+              #
               class Rpcs
+                ##
+                # RPC-specific configuration for `list_recommendations`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :list_recommendations
+                ##
+                # RPC-specific configuration for `get_recommendation`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :get_recommendation
+                ##
+                # RPC-specific configuration for `mark_recommendation_claimed`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :mark_recommendation_claimed
+                ##
+                # RPC-specific configuration for `mark_recommendation_succeeded`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :mark_recommendation_succeeded
+                ##
+                # RPC-specific configuration for `mark_recommendation_failed`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :mark_recommendation_failed
 
+                # @private
                 def initialize parent_rpcs = nil
                   list_recommendations_config = parent_rpcs&.list_recommendations if parent_rpcs&.respond_to? :list_recommendations
                   @list_recommendations = Gapic::Config::Method.new list_recommendations_config

data/lib/google/cloud/recommender/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Recommender
       module V1
-        VERSION = "0.1.1"
+        VERSION = "0.2.0"
       end
     end
   end

data/proto_docs/google/api/resource.rb

@@ -27,110 +27,110 @@ module Google
     #
     # Example:
     #
-    #     message Topic \\\{
+    #     message Topic {
     #       // Indicates this message defines a resource schema.
-    #       // Declares the resource type in the format of \\\{service\}/\\\{kind\}.
-    #       // For Kubernetes resources, the format is \\\{api group\}/\\\{kind\}.
-    #       option (google.api.resource) = \\\{
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: \\\{
-    #           pattern: "projects/\\\{project\}/topics/\\\{topic\}"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/\\\{project\}"
-    #         \}
-    #       \};
-    #     \}
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
     #
     # The ResourceDescriptor Yaml config will look like:
     #
     #    resources:
     #    - type: "pubsub.googleapis.com/Topic"
     #      name_descriptor:
-    #        - pattern: "projects/\\\{project\}/topics/\\\{topic\}"
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
     #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\\{project\}"
+    #          parent_name_extractor: "projects/\\{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
     #
     # Example:
     #
-    #     message LogEntry \\\{
-    #       option (google.api.resource) = \\\{
+    #     message LogEntry {
+    #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: \\\{
-    #           pattern: "projects/\\\{project\}/logs/\\\{log\}"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/\\\{project\}"
-    #         \}
-    #         name_descriptor: \\\{
-    #           pattern: "folders/\\\{folder\}/logs/\\\{log\}"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/\\\{folder\}"
-    #         \}
-    #         name_descriptor: \\\{
-    #           pattern: "organizations/\\\{organization\}/logs/\\\{log\}"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/\\\{organization\}"
-    #         \}
-    #         name_descriptor: \\\{
-    #           pattern: "billingAccounts/\\\{billing_account\}/logs/\\\{log\}"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
     #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/\\\{billing_account\}"
-    #         \}
-    #       \};
-    #     \}
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
     #
     # The ResourceDescriptor Yaml config will look like:
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
     #       name_descriptor:
-    #         - pattern: "projects/\\\{project\}/logs/\\\{log\}"
+    #         - pattern: "projects/{project}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/\\\{project\}"
-    #         - pattern: "folders/\\\{folder\}/logs/\\\{log\}"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/\\\{folder\}"
-    #         - pattern: "organizations/\\\{organization\}/logs/\\\{log\}"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/\\\{organization\}"
-    #         - pattern: "billingAccounts/\\\{billing_account\}/logs/\\\{log\}"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
     #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/\\\{billing_account\}"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
     #
     # For flexible resources, the resource name doesn't contain parent names, but
     # the resource itself has parents for policy evaluation.
     #
     # Example:
     #
-    #     message Shelf \\\{
-    #       option (google.api.resource) = \\\{
+    #     message Shelf {
+    #       option (google.api.resource) = {
     #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: \\\{
-    #           pattern: "shelves/\\\{shelf\}"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         \}
-    #         name_descriptor: \\\{
-    #           pattern: "shelves/\\\{shelf\}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         \}
-    #       \};
-    #     \}
+    #         }
+    #       };
+    #     }
     #
     # The ResourceDescriptor Yaml config will look like:
     #
     #     resources:
     #     - type: 'library.googleapis.com/Shelf'
     #       name_descriptor:
-    #         - pattern: "shelves/\\\{shelf\}"
+    #         - pattern: "shelves/{shelf}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/\\\{shelf\}"
+    #         - pattern: "shelves/{shelf}"
     #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
     # @!attribute [rw] type
     #   @return [String]
     #     The resource type. It must be in the format of
-    #     \\\{service_name\}/\\\{resource_type_kind\}. The `resource_type_kind` must be
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
     #     singular and must not include version numbers.
     #
     #     Example: `storage.googleapis.com/Bucket`
@@ -147,14 +147,14 @@ module Google
     #     The path pattern must follow the syntax, which aligns with HTTP binding
     #     syntax:
     #
-    #         Template = Segment \\\{ "/" Segment \} ;
+    #         Template = Segment { "/" Segment } ;
     #         Segment = LITERAL | Variable ;
-    #         Variable = "\\\{" LITERAL "\}" ;
+    #         Variable = "{" LITERAL "}" ;
     #
     #     Examples:
     #
-    #         - "projects/\\\{project\}/topics/\\\{topic\}"
-    #         - "projects/\\\{project\}/knowledgeBases/\\\{knowledge_base\}"
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
     #
     #     The components in braces correspond to the IDs for each resource in the
     #     hierarchy. It is expected that, if multiple patterns are provided,
@@ -165,26 +165,26 @@ module Google
     #     Optional. The field on the resource that designates the resource name
     #     field. If omitted, this is assumed to be "name".
     # @!attribute [rw] history
-    #   @return [ENUM(History)]
+    #   @return [Google::Api::ResourceDescriptor::History]
     #     Optional. The historical or future-looking state of the resource pattern.
     #
     #     Example:
     #
     #         // The InspectTemplate message originally only supported resource
     #         // names with organization, and project was added later.
-    #         message InspectTemplate \\\{
-    #           option (google.api.resource) = \\\{
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
     #             type: "dlp.googleapis.com/InspectTemplate"
     #             pattern:
-    #             "organizations/\\\{organization\}/inspectTemplates/\\\{inspect_template\}"
-    #             pattern: "projects/\\\{project\}/inspectTemplates/\\\{inspect_template\}"
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
     #             history: ORIGINALLY_SINGLE_PATTERN
-    #           \};
-    #         \}
+    #           };
+    #         }
     # @!attribute [rw] plural
     #   @return [String]
     #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\\{project\}'. It is the same concept of the `plural`
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
     #     field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     # @!attribute [rw] singular
@@ -221,11 +221,11 @@ module Google
     #
     #     Example:
     #
-    #         message Subscription \\\{
-    #           string topic = 2 [(google.api.resource_reference) = \\\{
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
     #             type: "pubsub.googleapis.com/Topic"
-    #           \}];
-    #         \}
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +234,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest \\\{
-    #         string parent = 1 [(google.api.resource_reference) = \\\{
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
     #           child_type: "logging.googleapis.com/LogEntry"
-    #         \};
-    #       \}
+    #         };
+    #       }
     class ResourceReference
       include Google::Protobuf::MessageExts
       extend Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/recommender/v1/recommendation.rb

@@ -145,18 +145,18 @@ module Google
         #     This is intended to be an exact match per filter. To perform advanced
         #     matching, use path_value_matchers.
         #
-        #     * Example: \\\{
+        #     * Example: {
         #       "/versions/*/name" : "it-123"
         #       "/versions/*/targetSize/percent": 20
-        #      \}
-        #     * Example: \\\{
+        #      }
+        #     * Example: {
         #       "/bindings/*/role": "roles/admin"
         #       "/bindings/*/condition" : null
-        #      \}
-        #     * Example: \\\{
+        #      }
+        #     * Example: {
         #       "/bindings/*/role": "roles/admin"
         #       "/bindings/*/members/*" : ["x@google.com", "y@google.com"]
-        #      \}
+        #      }
         #     When both path_filters and path_value_matchers are set, an implicit AND
         #     must be performed.
         # @!attribute [rw] path_value_matchers
@@ -216,7 +216,7 @@ module Google
 
         # Contains the impact a recommendation can have for a given category.
         # @!attribute [rw] category
-        #   @return [ENUM(Category)]
+        #   @return [Google::Cloud::Recommender::V1::Impact::Category]
         #     Category that is being targeted.
         # @!attribute [rw] cost_projection
         #   @return [Google::Cloud::Recommender::V1::CostProjection]
@@ -246,7 +246,7 @@ module Google
 
         # Information for state. Contains state and metadata.
         # @!attribute [rw] state
-        #   @return [ENUM(State)]
+        #   @return [Google::Cloud::Recommender::V1::RecommendationStateInfo::State]
         #     The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
         # @!attribute [rw] state_metadata
         #   @return [Google::Protobuf::Map{String => String}]

data/proto_docs/google/cloud/recommender/v1/recommender_service.rb

@@ -83,8 +83,8 @@ module Google
         #   @return [Google::Protobuf::Map{String => String}]
         #     State properties to include with this state. Overwrites any existing
         #     `state_metadata`.
-        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-        #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+        #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
         # @!attribute [rw] etag
         #   @return [String]
         #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
@@ -110,8 +110,8 @@ module Google
         #   @return [Google::Protobuf::Map{String => String}]
         #     State properties to include with this state. Overwrites any existing
         #     `state_metadata`.
-        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-        #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+        #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
         # @!attribute [rw] etag
         #   @return [String]
         #     Required. Fingerprint of the Recommendation. Provides optimistic locking.
@@ -137,8 +137,8 @@ module Google
         #   @return [Google::Protobuf::Map{String => String}]
         #     State properties to include with this state. Overwrites any existing
         #     `state_metadata`.
-        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\\{0,62\}$/.
-        #     Values must match the regex /^[a-zA-Z0-9_./-]\\\{0,255\}$/.
+        #     Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
+        #     Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
         # @!attribute [rw] etag
         #   @return [String]
         #     Required. Fingerprint of the Recommendation. Provides optimistic locking.

data/proto_docs/google/protobuf/duration.rb

@@ -37,13 +37,13 @@ module Google
     #     duration.seconds = end.seconds - start.seconds;
     #     duration.nanos = end.nanos - start.nanos;
     #
-    #     if (duration.seconds < 0 && duration.nanos > 0) \\\{
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
     #       duration.seconds += 1;
     #       duration.nanos -= 1000000000;
-    #     \} else if (durations.seconds > 0 && duration.nanos < 0) \\\{
+    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
     #       duration.seconds -= 1;
     #       duration.nanos += 1000000000;
-    #     \}
+    #     }
     #
     # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
     #
@@ -54,13 +54,13 @@ module Google
     #     end.seconds = start.seconds + duration.seconds;
     #     end.nanos = start.nanos + duration.nanos;
     #
-    #     if (end.nanos < 0) \\\{
+    #     if (end.nanos < 0) {
     #       end.seconds -= 1;
     #       end.nanos += 1000000000;
-    #     \} else if (end.nanos >= 1000000000) \\\{
+    #     } else if (end.nanos >= 1000000000) {
     #       end.seconds += 1;
     #       end.nanos -= 1000000000;
-    #     \}
+    #     }
     #
     # Example 3: Compute Duration from datetime.timedelta in Python.
     #

data/proto_docs/google/protobuf/struct.rb

@@ -51,7 +51,7 @@ module Google
     #
     # The JSON representation for `Value` is JSON value.
     # @!attribute [rw] null_value
-    #   @return [ENUM(NullValue)]
+    #   @return [Google::Protobuf::NullValue]
     #     Represents a null value.
     # @!attribute [rw] number_value
     #   @return [Float]

data/proto_docs/google/protobuf/timestamp.rb

@@ -77,9 +77,9 @@ module Google
     #
     # In JSON format, the Timestamp type is encoded as a string in the
     # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
-    # format is "\\\{year\}-\\\{month\}-\\\{day\}T\\\{hour\}:\\\{min\}:\\\{sec\}[.\\\{frac_sec\}]Z"
-    # where \\\{year\} is always expressed using four digits while \\\{month\}, \\\{day\},
-    # \\\{hour\}, \\\{min\}, and \\\{sec\} are zero-padded to two digits each. The fractional
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
     # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
     # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
     # is required. A proto3 JSON serializer should always use UTC (as indicated by

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +70,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement