google-cloud-recommender-v1 0.5.2 → 0.8.1

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

@@ -33,3 +33,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1", "_helpers.rb"
+require "google/cloud/recommender/v1/_helpers" if ::File.file? helper_path

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

@@ -63,25 +63,43 @@ module Google
                 parent_config = while namespace.any?
                                   parent_name = namespace.join "::"
                                   parent_const = const_get parent_name
-                                  break parent_const.configure if parent_const&.respond_to? :configure
+                                  break parent_const.configure if parent_const.respond_to? :configure
                                   namespace.pop
                                 end
                 default_config = Client::Configuration.new parent_config
 
+                default_config.rpcs.list_insights.timeout = 60.0
+                default_config.rpcs.list_insights.retry_policy = {
+                  initial_delay: 0.1,
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 14]
+                }
+
+                default_config.rpcs.get_insight.timeout = 60.0
+                default_config.rpcs.get_insight.retry_policy = {
+                  initial_delay: 0.1,
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 14]
+                }
+
+                default_config.rpcs.mark_insight_accepted.timeout = 60.0
+
                 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:   [4, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 14]
                 }
 
                 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:   [4, 14]
+              max_delay: 60.0,
+              multiplier: 1.3,
+              retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.mark_recommendation_claimed.timeout = 60.0
@@ -151,7 +169,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                       @config.endpoint == Client.configure.endpoint &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope: @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
@@ -197,6 +221,8 @@ module Google
             #
             #     LOCATION here refers to GCP Locations:
             #     https://cloud.google.com/about/locations/
+            #     INSIGHT_TYPE_ID refers to supported insight types:
+            #     https://cloud.google.com/recommender/docs/insights/insight-types.)
             #   @param page_size [::Integer]
             #     Optional. The maximum number of results to return from this request.  Non-positive
             #     values are ignored. If not specified, the server will determine the number
@@ -428,6 +454,8 @@ module Google
             #
             #     LOCATION here refers to GCP Locations:
             #     https://cloud.google.com/about/locations/
+            #     RECOMMENDER_ID refers to supported recommenders:
+            #     https://cloud.google.com/recommender/docs/recommenders.
             #   @param page_size [::Integer]
             #     Optional. The maximum number of results to return from this request.  Non-positive
             #     values are ignored. If not specified, the server will determine the number
@@ -895,7 +923,7 @@ module Google
               config_attr :scope,         nil, ::String, ::Array, nil
               config_attr :lib_name,      nil, ::String, nil
               config_attr :lib_version,   nil, ::String, nil
-              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
               config_attr :interceptors,  nil, ::Array, nil
               config_attr :timeout,       nil, ::Numeric, nil
               config_attr :metadata,      nil, ::Hash, nil
@@ -916,7 +944,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -928,7 +956,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:
@@ -982,21 +1010,21 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
-                  list_insights_config = parent_rpcs&.list_insights if parent_rpcs&.respond_to? :list_insights
+                  list_insights_config = parent_rpcs.list_insights if parent_rpcs.respond_to? :list_insights
                   @list_insights = ::Gapic::Config::Method.new list_insights_config
-                  get_insight_config = parent_rpcs&.get_insight if parent_rpcs&.respond_to? :get_insight
+                  get_insight_config = parent_rpcs.get_insight if parent_rpcs.respond_to? :get_insight
                   @get_insight = ::Gapic::Config::Method.new get_insight_config
-                  mark_insight_accepted_config = parent_rpcs&.mark_insight_accepted if parent_rpcs&.respond_to? :mark_insight_accepted
+                  mark_insight_accepted_config = parent_rpcs.mark_insight_accepted if parent_rpcs.respond_to? :mark_insight_accepted
                   @mark_insight_accepted = ::Gapic::Config::Method.new mark_insight_accepted_config
-                  list_recommendations_config = parent_rpcs&.list_recommendations if parent_rpcs&.respond_to? :list_recommendations
+                  list_recommendations_config = parent_rpcs.list_recommendations if parent_rpcs.respond_to? :list_recommendations
                   @list_recommendations = ::Gapic::Config::Method.new list_recommendations_config
-                  get_recommendation_config = parent_rpcs&.get_recommendation if parent_rpcs&.respond_to? :get_recommendation
+                  get_recommendation_config = parent_rpcs.get_recommendation if parent_rpcs.respond_to? :get_recommendation
                   @get_recommendation = ::Gapic::Config::Method.new get_recommendation_config
-                  mark_recommendation_claimed_config = parent_rpcs&.mark_recommendation_claimed if parent_rpcs&.respond_to? :mark_recommendation_claimed
+                  mark_recommendation_claimed_config = parent_rpcs.mark_recommendation_claimed if parent_rpcs.respond_to? :mark_recommendation_claimed
                   @mark_recommendation_claimed = ::Gapic::Config::Method.new mark_recommendation_claimed_config
-                  mark_recommendation_succeeded_config = parent_rpcs&.mark_recommendation_succeeded if parent_rpcs&.respond_to? :mark_recommendation_succeeded
+                  mark_recommendation_succeeded_config = parent_rpcs.mark_recommendation_succeeded if parent_rpcs.respond_to? :mark_recommendation_succeeded
                   @mark_recommendation_succeeded = ::Gapic::Config::Method.new mark_recommendation_succeeded_config
-                  mark_recommendation_failed_config = parent_rpcs&.mark_recommendation_failed if parent_rpcs&.respond_to? :mark_recommendation_failed
+                  mark_recommendation_failed_config = parent_rpcs.mark_recommendation_failed if parent_rpcs.respond_to? :mark_recommendation_failed
                   @mark_recommendation_failed = ::Gapic::Config::Method.new mark_recommendation_failed_config
 
                   yield self if block_given?

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

@@ -27,81 +27,309 @@ module Google
             ##
             # Create a fully-qualified Insight resource string.
             #
-            # The resource will be in the following format:
+            # @overload insight_path(project:, location:, insight_type:, insight:)
+            #   The resource will be in the following format:
             #
-            # `projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
+            #   `projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
             #
-            # @param project [String]
-            # @param location [String]
-            # @param insight_type [String]
-            # @param insight [String]
+            #   @param project [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #   @param insight [String]
+            #
+            # @overload insight_path(billing_account:, location:, insight_type:, insight:)
+            #   The resource will be in the following format:
+            #
+            #   `billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
+            #
+            #   @param billing_account [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #   @param insight [String]
+            #
+            # @overload insight_path(folder:, location:, insight_type:, insight:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
+            #
+            #   @param folder [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #   @param insight [String]
+            #
+            # @overload insight_path(organization:, location:, insight_type:, insight:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
+            #
+            #   @param organization [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #   @param insight [String]
             #
             # @return [::String]
-            def insight_path project:, location:, insight_type:, insight:
-              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
-              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
-              raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
+            def insight_path **args
+              resources = {
+                "insight:insight_type:location:project" => (proc do |project:, location:, insight_type:, insight:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+                end),
+                "billing_account:insight:insight_type:location" => (proc do |billing_account:, location:, insight_type:, insight:|
+                  raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
+
+                  "billingAccounts/#{billing_account}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+                end),
+                "folder:insight:insight_type:location" => (proc do |folder:, location:, insight_type:, insight:|
+                  raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
+
+                  "folders/#{folder}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+                end),
+                "insight:insight_type:location:organization" => (proc do |organization:, location:, insight_type:, insight:|
+                  raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
+
+                  "organizations/#{organization}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+                end)
+              }
 
-              "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             ##
             # Create a fully-qualified InsightType resource string.
             #
-            # The resource will be in the following format:
+            # @overload insight_type_path(project:, location:, insight_type:)
+            #   The resource will be in the following format:
             #
-            # `projects/{project}/locations/{location}/insightTypes/{insight_type}`
+            #   `projects/{project}/locations/{location}/insightTypes/{insight_type}`
             #
-            # @param project [String]
-            # @param location [String]
-            # @param insight_type [String]
+            #   @param project [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #
+            # @overload insight_type_path(billing_account:, location:, insight_type:)
+            #   The resource will be in the following format:
+            #
+            #   `billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}`
+            #
+            #   @param billing_account [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #
+            # @overload insight_type_path(folder:, location:, insight_type:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/locations/{location}/insightTypes/{insight_type}`
+            #
+            #   @param folder [String]
+            #   @param location [String]
+            #   @param insight_type [String]
+            #
+            # @overload insight_type_path(organization:, location:, insight_type:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/locations/{location}/insightTypes/{insight_type}`
+            #
+            #   @param organization [String]
+            #   @param location [String]
+            #   @param insight_type [String]
             #
             # @return [::String]
-            def insight_type_path project:, location:, insight_type:
-              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
-              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+            def insight_type_path **args
+              resources = {
+                "insight_type:location:project" => (proc do |project:, location:, insight_type:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}"
+                end),
+                "billing_account:insight_type:location" => (proc do |billing_account:, location:, insight_type:|
+                  raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "billingAccounts/#{billing_account}/locations/#{location}/insightTypes/#{insight_type}"
+                end),
+                "folder:insight_type:location" => (proc do |folder:, location:, insight_type:|
+                  raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "folders/#{folder}/locations/#{location}/insightTypes/#{insight_type}"
+                end),
+                "insight_type:location:organization" => (proc do |organization:, location:, insight_type:|
+                  raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "organizations/#{organization}/locations/#{location}/insightTypes/#{insight_type}"
+                end)
+              }
 
-              "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}"
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             ##
             # Create a fully-qualified Recommendation resource string.
             #
-            # The resource will be in the following format:
+            # @overload recommendation_path(project:, location:, recommender:, recommendation:)
+            #   The resource will be in the following format:
             #
-            # `projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
+            #   `projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
             #
-            # @param project [String]
-            # @param location [String]
-            # @param recommender [String]
-            # @param recommendation [String]
+            #   @param project [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #   @param recommendation [String]
+            #
+            # @overload recommendation_path(billing_account:, location:, recommender:, recommendation:)
+            #   The resource will be in the following format:
+            #
+            #   `billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
+            #
+            #   @param billing_account [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #   @param recommendation [String]
+            #
+            # @overload recommendation_path(folder:, location:, recommender:, recommendation:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
+            #
+            #   @param folder [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #   @param recommendation [String]
+            #
+            # @overload recommendation_path(organization:, location:, recommender:, recommendation:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
+            #
+            #   @param organization [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #   @param recommendation [String]
             #
             # @return [::String]
-            def recommendation_path project:, location:, recommender:, recommendation:
-              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
-              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
-              raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
+            def recommendation_path **args
+              resources = {
+                "location:project:recommendation:recommender" => (proc do |project:, location:, recommender:, recommendation:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
+                end),
+                "billing_account:location:recommendation:recommender" => (proc do |billing_account:, location:, recommender:, recommendation:|
+                  raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
+
+                  "billingAccounts/#{billing_account}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
+                end),
+                "folder:location:recommendation:recommender" => (proc do |folder:, location:, recommender:, recommendation:|
+                  raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
+
+                  "folders/#{folder}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
+                end),
+                "location:organization:recommendation:recommender" => (proc do |organization:, location:, recommender:, recommendation:|
+                  raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
+
+                  "organizations/#{organization}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
+                end)
+              }
 
-              "projects/#{project}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             ##
             # Create a fully-qualified Recommender resource string.
             #
-            # The resource will be in the following format:
+            # @overload recommender_path(project:, location:, recommender:)
+            #   The resource will be in the following format:
             #
-            # `projects/{project}/locations/{location}/recommenders/{recommender}`
+            #   `projects/{project}/locations/{location}/recommenders/{recommender}`
             #
-            # @param project [String]
-            # @param location [String]
-            # @param recommender [String]
+            #   @param project [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #
+            # @overload recommender_path(billing_account:, location:, recommender:)
+            #   The resource will be in the following format:
+            #
+            #   `billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}`
+            #
+            #   @param billing_account [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #
+            # @overload recommender_path(folder:, location:, recommender:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/locations/{location}/recommenders/{recommender}`
+            #
+            #   @param folder [String]
+            #   @param location [String]
+            #   @param recommender [String]
+            #
+            # @overload recommender_path(organization:, location:, recommender:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/locations/{location}/recommenders/{recommender}`
+            #
+            #   @param organization [String]
+            #   @param location [String]
+            #   @param recommender [String]
             #
             # @return [::String]
-            def recommender_path project:, location:, recommender:
-              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
-              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+            def recommender_path **args
+              resources = {
+                "location:project:recommender" => (proc do |project:, location:, recommender:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/recommenders/#{recommender}"
+                end),
+                "billing_account:location:recommender" => (proc do |billing_account:, location:, recommender:|
+                  raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "billingAccounts/#{billing_account}/locations/#{location}/recommenders/#{recommender}"
+                end),
+                "folder:location:recommender" => (proc do |folder:, location:, recommender:|
+                  raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "folders/#{folder}/locations/#{location}/recommenders/#{recommender}"
+                end),
+                "location:organization:recommender" => (proc do |organization:, location:, recommender:|
+                  raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "organizations/#{organization}/locations/#{location}/recommenders/#{recommender}"
+                end)
+              }
 
-              "projects/#{project}/locations/#{location}/recommenders/#{recommender}"
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
             end
 
             extend self