google-cloud-recommender-v1 0.4.3 → 0.6.0

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

@@ -24,44 +24,312 @@ module Google
         module Recommender
           # Path helper methods for the Recommender API.
           module Paths
+            ##
+            # Create a fully-qualified Insight resource string.
+            #
+            # @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}`
+            #
+            #   @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 **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)
+              }
+
+              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.
+            #
+            # @overload insight_type_path(project:, location:, insight_type:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/insightTypes/{insight_type}`
+            #
+            #   @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 **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)
+              }
+
+              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}`
+            #
+            #   @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:
             #
-            # `projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
+            #   `organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
             #
-            # @param project [String]
-            # @param location [String]
-            # @param recommender [String]
-            # @param recommendation [String]
+            #   @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}"
+                  "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)
+              }
+
+              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}`
+            #
+            #   @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]
             #
-            # `projects/{project}/locations/{location}/recommenders/{recommender}`
+            # @overload recommender_path(folder:, location:, recommender:)
+            #   The resource will be in the following format:
             #
-            # @param project [String]
-            # @param location [String]
-            # @param recommender [String]
+            #   `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/recommender_service_pb.rb

@@ -7,9 +7,28 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/cloud/recommender/v1/insight_pb'
 require 'google/cloud/recommender/v1/recommendation_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/recommender/v1/recommender_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.recommender.v1.ListInsightsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :filter, :string, 4
+    end
+    add_message "google.cloud.recommender.v1.ListInsightsResponse" do
+      repeated :insights, :message, 1, "google.cloud.recommender.v1.Insight"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.recommender.v1.GetInsightRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.recommender.v1.MarkInsightAcceptedRequest" do
+      optional :name, :string, 1
+      map :state_metadata, :string, :string, 2
+      optional :etag, :string, 3
+    end
     add_message "google.cloud.recommender.v1.ListRecommendationsRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -45,6 +64,10 @@ module Google
   module Cloud
     module Recommender
       module V1
+        ListInsightsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListInsightsRequest").msgclass
+        ListInsightsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListInsightsResponse").msgclass
+        GetInsightRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.GetInsightRequest").msgclass
+        MarkInsightAcceptedRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.MarkInsightAcceptedRequest").msgclass
         ListRecommendationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListRecommendationsRequest").msgclass
         ListRecommendationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListRecommendationsResponse").msgclass
         GetRecommendationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.GetRecommendationRequest").msgclass

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/recommender/v1/recommender_service.proto for package 'google.cloud.recommender.v1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/cloud/recommender/v1/recommender_service_pb'
@@ -25,10 +24,10 @@ module Google
     module Recommender
       module V1
         module Recommender
-          # Provides recommendations for cloud customers for various categories like
-          # performance optimization, cost savings, reliability, feature discovery, etc.
-          # These recommendations are generated automatically based on analysis of user
-          # resources, configuration and monitoring metrics.
+          # Provides insights and recommendations for cloud customers for various
+          # categories like performance optimization, cost savings, reliability, feature
+          # discovery, etc. Insights and recommendations are generated automatically
+          # based on analysis of user resources, configuration and monitoring metrics.
           class Service
 
             include GRPC::GenericService
@@ -37,45 +36,60 @@ module Google
             self.unmarshal_class_method = :decode
             self.service_name = 'google.cloud.recommender.v1.Recommender'
 
+            # Lists insights for a Cloud project. Requires the recommender.*.list IAM
+            # permission for the specified insight type.
+            rpc :ListInsights, ::Google::Cloud::Recommender::V1::ListInsightsRequest, ::Google::Cloud::Recommender::V1::ListInsightsResponse
+            # Gets the requested insight. Requires the recommender.*.get IAM permission
+            # for the specified insight type.
+            rpc :GetInsight, ::Google::Cloud::Recommender::V1::GetInsightRequest, ::Google::Cloud::Recommender::V1::Insight
+            # Marks the Insight State as Accepted. Users can use this method to
+            # indicate to the Recommender API that they have applied some action based
+            # on the insight. This stops the insight content from being updated.
+            #
+            # MarkInsightAccepted can be applied to insights in ACTIVE state. Requires
+            # the recommender.*.update IAM permission for the specified insight.
+            rpc :MarkInsightAccepted, ::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest, ::Google::Cloud::Recommender::V1::Insight
             # Lists recommendations for a Cloud project. Requires the recommender.*.list
             # IAM permission for the specified recommender.
-            rpc :ListRecommendations, ListRecommendationsRequest, ListRecommendationsResponse
+            rpc :ListRecommendations, ::Google::Cloud::Recommender::V1::ListRecommendationsRequest, ::Google::Cloud::Recommender::V1::ListRecommendationsResponse
             # Gets the requested recommendation. Requires the recommender.*.get
             # IAM permission for the specified recommender.
-            rpc :GetRecommendation, GetRecommendationRequest, Recommendation
-            # Mark the Recommendation State as Claimed. Users can use this method to
+            rpc :GetRecommendation, ::Google::Cloud::Recommender::V1::GetRecommendationRequest, ::Google::Cloud::Recommender::V1::Recommendation
+            # Marks the Recommendation State as Claimed. Users can use this method to
             # indicate to the Recommender API that they are starting to apply the
             # recommendation themselves. This stops the recommendation content from being
-            # updated.
+            # updated. Associated insights are frozen and placed in the ACCEPTED state.
             #
             # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
             # SUCCEEDED, FAILED, or ACTIVE state.
             #
             # Requires the recommender.*.update IAM permission for the specified
             # recommender.
-            rpc :MarkRecommendationClaimed, MarkRecommendationClaimedRequest, Recommendation
-            # Mark the Recommendation State as Succeeded. Users can use this method to
+            rpc :MarkRecommendationClaimed, ::Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest, ::Google::Cloud::Recommender::V1::Recommendation
+            # Marks the Recommendation State as Succeeded. Users can use this method to
             # indicate to the Recommender API that they have applied the recommendation
             # themselves, and the operation was successful. This stops the recommendation
-            # content from being updated.
+            # content from being updated. Associated insights are frozen and placed in
+            # the ACCEPTED state.
             #
             # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,
             # CLAIMED, SUCCEEDED, or FAILED state.
             #
             # Requires the recommender.*.update IAM permission for the specified
             # recommender.
-            rpc :MarkRecommendationSucceeded, MarkRecommendationSucceededRequest, Recommendation
-            # Mark the Recommendation State as Failed. Users can use this method to
+            rpc :MarkRecommendationSucceeded, ::Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest, ::Google::Cloud::Recommender::V1::Recommendation
+            # Marks the Recommendation State as Failed. Users can use this method to
             # indicate to the Recommender API that they have applied the recommendation
             # themselves, and the operation failed. This stops the recommendation content
-            # from being updated.
+            # from being updated. Associated insights are frozen and placed in the
+            # ACCEPTED state.
             #
             # MarkRecommendationFailed can be applied to recommendations in ACTIVE,
             # CLAIMED, SUCCEEDED, or FAILED state.
             #
             # Requires the recommender.*.update IAM permission for the specified
             # recommender.
-            rpc :MarkRecommendationFailed, MarkRecommendationFailedRequest, Recommendation
+            rpc :MarkRecommendationFailed, ::Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest, ::Google::Cloud::Recommender::V1::Recommendation
           end
 
           Stub = Service.rpc_stub_class