google-cloud-recommender-v1 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54b1052159b78e8f617677704f4af520f174464800c801432330a3a18ee322d9
-  data.tar.gz: fed1be380b52b53e8136a81a6f3d09a1102065fb56e30ea04e93635fdf28cbec
+  metadata.gz: 46fb7c89b82a0dea66ee1a8f050fef7fee2ca7f0ca80a708e0ec5da7a46078ce
+  data.tar.gz: f05bb2566528e5dcc18e3529748db0d9b9b4ab0e3cfdf24b4c06c4f4dfcb88b2
 SHA512:
-  metadata.gz: a04f71f5f3246425da931e8727eb77f5f2ffb86cdb113c564be5e9963a77362e0deb3e785443f55c19a15ef87abd1dc2739e4f2b615af830146028ba1714db2a
-  data.tar.gz: 7a1f84adac7827cfa6cac15d9e4188e053501cca97eac389d331302f130b00a24f8f1e0ea26f8a30026e85e0164c5c82e6c1f9fb909ea334781bf32f48cc5710
+  metadata.gz: 500a68ce669f879dd97620bb00eff11a50238f8065d74fb7538def6ccfa96de555b0b7dccba5af074906439561b12e00aae5693db35f08c91e848ab717c58749
+  data.tar.gz: f7954ff026b31d5ac06e4dd56251252c85f37bba6828249f2fb43fc351186f45c85d16cea443fe8ad4138bf4eb1cba918ebc2163da860a8004a91f5405a1d168

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

@@ -215,6 +215,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
@@ -446,6 +448,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
@@ -946,7 +950,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:

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

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Recommender
       module V1
-        VERSION = "0.5.3"
+        VERSION = "0.6.0"
       end
     end
   end

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

@@ -163,12 +163,12 @@ module Google
         #       "/versions/*/targetSize/percent": 20
         #      }
         #     * Example: {
-        #       "/bindings/*/role": "roles/admin"
+        #       "/bindings/*/role": "roles/owner"
         #       "/bindings/*/condition" : null
         #      }
         #     * Example: {
-        #       "/bindings/*/role": "roles/admin"
-        #       "/bindings/*/members/*" : ["x@google.com", "y@google.com"]
+        #       "/bindings/*/role": "roles/owner"
+        #       "/bindings/*/members/*" : ["x@example.com", "y@example.com"]
         #      }
         #     When both path_filters and path_value_matchers are set, an implicit AND
         #     must be performed.

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

@@ -32,6 +32,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.)
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of results to return from this request.  Non-positive
@@ -111,6 +113,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.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of results to return from this request.  Non-positive

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Recommender V1 API