google-cloud-recommender-v1 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa6709702cbfa76e63fc80af13987becad8f6a02a251a867ffb38be92678419
-  data.tar.gz: 4b94202ff71a5d024df9e63eaa60afd34166b955e4dad6c571c488839b46c48c
+  metadata.gz: beae71e611f6079030b92e7b99760bc720dcc40ea73de75cf327f94476eb10d9
+  data.tar.gz: 9f6b442b44b2d755d6221655b0f3e443442a045fc9b7b6105d449099221706e1
 SHA512:
-  metadata.gz: 4357f1e257fd83e1d6dd908ccd2566243f7131cc0c92e1022e14cfe0a6d00a163dd30f6e4f39f807ecf852c6c8cdb9be50492253be3d5618a3879d76f77a5022
-  data.tar.gz: e2f75c28174c6fa73715ef818ea5d98543012c080922a8010053ee6ce9a2fcad242ca13848cc063bb1b4cc4f9499f1cebb6d978904c4a882fc7337c641100cb7
+  metadata.gz: d27b855b1b9f8af0b6a1c65372343c991cb809bf8780df4b179a0aaad8291e38e268af02177876da04ff833896d3c31da0b244690fb050c2f2945dd0349fa1af
+  data.tar.gz: 81b7ecdc10976e822addb75a78877cdb5b514d1a71674c0d0c7f35eea7a9334ca940272040d18356ad96bc51a13cc5d38c72cf924158d848b312b2bb6b243a82

data/README.md

@@ -28,7 +28,7 @@ require "google/cloud/recommender/v1"
 
 client = ::Google::Cloud::Recommender::V1::Recommender::Client.new
 request = my_create_request
-response = client.list_recommendations request
+response = client.list_insights request
 ```
 
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest)

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

@@ -0,0 +1,60 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recommender/v1/insight.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/struct_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recommender/v1/insight.proto", :syntax => :proto3) do
+    add_message "google.cloud.recommender.v1.Insight" do
+      optional :name, :string, 1
+      optional :description, :string, 2
+      repeated :target_resources, :string, 9
+      optional :insight_subtype, :string, 10
+      optional :content, :message, 3, "google.protobuf.Struct"
+      optional :last_refresh_time, :message, 4, "google.protobuf.Timestamp"
+      optional :observation_period, :message, 5, "google.protobuf.Duration"
+      optional :state_info, :message, 6, "google.cloud.recommender.v1.InsightStateInfo"
+      optional :category, :enum, 7, "google.cloud.recommender.v1.Insight.Category"
+      optional :etag, :string, 11
+      repeated :associated_recommendations, :message, 8, "google.cloud.recommender.v1.Insight.RecommendationReference"
+    end
+    add_message "google.cloud.recommender.v1.Insight.RecommendationReference" do
+      optional :recommendation, :string, 1
+    end
+    add_enum "google.cloud.recommender.v1.Insight.Category" do
+      value :CATEGORY_UNSPECIFIED, 0
+      value :COST, 1
+      value :SECURITY, 2
+      value :PERFORMANCE, 3
+      value :MANAGEABILITY, 4
+    end
+    add_message "google.cloud.recommender.v1.InsightStateInfo" do
+      optional :state, :enum, 1, "google.cloud.recommender.v1.InsightStateInfo.State"
+      map :state_metadata, :string, :string, 2
+    end
+    add_enum "google.cloud.recommender.v1.InsightStateInfo.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :ACTIVE, 1
+      value :ACCEPTED, 2
+      value :DISMISSED, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Recommender
+      module V1
+        Insight = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Insight").msgclass
+        Insight::RecommendationReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Insight.RecommendationReference").msgclass
+        Insight::Category = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Insight.Category").enummodule
+        InsightStateInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.InsightStateInfo").msgclass
+        InsightStateInfo::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.InsightStateInfo.State").enummodule
+      end
+    end
+  end
+end

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

@@ -20,6 +20,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :content, :message, 7, "google.cloud.recommender.v1.RecommendationContent"
       optional :state_info, :message, 10, "google.cloud.recommender.v1.RecommendationStateInfo"
       optional :etag, :string, 11
+      repeated :associated_insights, :message, 14, "google.cloud.recommender.v1.Recommendation.InsightReference"
+    end
+    add_message "google.cloud.recommender.v1.Recommendation.InsightReference" do
+      optional :insight, :string, 1
     end
     add_message "google.cloud.recommender.v1.RecommendationContent" do
       repeated :operation_groups, :message, 2, "google.cloud.recommender.v1.OperationGroup"
@@ -83,6 +87,7 @@ module Google
     module Recommender
       module V1
         Recommendation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Recommendation").msgclass
+        Recommendation::InsightReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Recommendation.InsightReference").msgclass
         RecommendationContent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.RecommendationContent").msgclass
         OperationGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.OperationGroup").msgclass
         Operation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Operation").msgclass

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

@@ -31,10 +31,10 @@ module Google
     module Recommender
       module V1
         ##
-        # 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.
         #
         # To load this service and instantiate a client:
         #

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

@@ -27,10 +27,10 @@ module Google
           ##
           # Client for the Recommender service.
           #
-          # 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 Client
             include Paths
@@ -169,6 +169,237 @@ module Google
 
             # Service calls
 
+            ##
+            # Lists insights for a Cloud project. Requires the recommender.*.list IAM
+            # permission for the specified insight type.
+            #
+            # @overload list_insights(request, options = nil)
+            #   Pass arguments to `list_insights` via a request object, either of type
+            #   {::Google::Cloud::Recommender::V1::ListInsightsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Recommender::V1::ListInsightsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload list_insights(parent: nil, page_size: nil, page_token: nil, filter: nil)
+            #   Pass arguments to `list_insights` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The container resource on which to execute the request.
+            #     Acceptable formats:
+            #
+            #     1.
+            #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
+            #
+            #     LOCATION here refers to GCP Locations:
+            #     https://cloud.google.com/about/locations/
+            #   @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
+            #     of results to return.
+            #   @param page_token [::String]
+            #     Optional. If present, retrieves the next batch of results from the preceding call to
+            #     this method. `page_token` must be the value of `next_page_token` from the
+            #     previous response. The values of other method parameters must be identical
+            #     to those in the previous call.
+            #   @param filter [::String]
+            #     Optional. Filter expression to restrict the insights returned. Supported
+            #     filter fields: state
+            #     Eg: `state:"DISMISSED" or state:"ACTIVE"
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Insight>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Insight>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def list_insights request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::ListInsightsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.list_insights.metadata.to_h
+
+              # 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
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.list_insights.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_insights.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @recommender_stub.call_rpc :list_insights, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @recommender_stub, :list_insights, request, response, operation, options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Gets the requested insight. Requires the recommender.*.get IAM permission
+            # for the specified insight type.
+            #
+            # @overload get_insight(request, options = nil)
+            #   Pass arguments to `get_insight` via a request object, either of type
+            #   {::Google::Cloud::Recommender::V1::GetInsightRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Recommender::V1::GetInsightRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload get_insight(name: nil)
+            #   Pass arguments to `get_insight` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. Name of the insight.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Recommender::V1::Insight]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Recommender::V1::Insight]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def get_insight request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::GetInsightRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.get_insight.metadata.to_h
+
+              # 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
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.get_insight.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_insight.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @recommender_stub.call_rpc :get_insight, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # 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.
+            #
+            # @overload mark_insight_accepted(request, options = nil)
+            #   Pass arguments to `mark_insight_accepted` via a request object, either of type
+            #   {::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload mark_insight_accepted(name: nil, state_metadata: nil, etag: nil)
+            #   Pass arguments to `mark_insight_accepted` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. Name of the insight.
+            #   @param state_metadata [::Hash{::String => ::String}]
+            #     Optional. State properties user wish to include with this state.  Full replace of the
+            #     current state_metadata.
+            #   @param etag [::String]
+            #     Required. Fingerprint of the Insight. Provides optimistic locking.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Recommender::V1::Insight]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Recommender::V1::Insight]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def mark_insight_accepted request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.mark_insight_accepted.metadata.to_h
+
+              # 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
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.mark_insight_accepted.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.mark_insight_accepted.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @recommender_stub.call_rpc :mark_insight_accepted, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Lists recommendations for a Cloud project. Requires the recommender.*.list
             # IAM permission for the specified recommender.
@@ -325,10 +556,10 @@ module Google
             end
 
             ##
-            # Mark the Recommendation State as Claimed. Users can use this method to
+            # 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.
@@ -407,10 +638,11 @@ module Google
             end
 
             ##
-            # Mark the Recommendation State as Succeeded. Users can use this method to
+            # 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.
@@ -489,10 +721,11 @@ module Google
             end
 
             ##
-            # Mark the Recommendation State as Failed. Users can use this method to
+            # 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.
@@ -585,19 +818,19 @@ module Google
             #
             # # Examples
             #
-            # To modify the global config, setting the timeout for list_recommendations
+            # To modify the global config, setting the timeout for list_insights
             # to 20 seconds, and all remaining timeouts to 10 seconds:
             #
             #     ::Google::Cloud::Recommender::V1::Recommender::Client.configure do |config|
             #       config.timeout = 10.0
-            #       config.rpcs.list_recommendations.timeout = 20.0
+            #       config.rpcs.list_insights.timeout = 20.0
             #     end
             #
             # To apply the above configuration only to a new client:
             #
             #     client = ::Google::Cloud::Recommender::V1::Recommender::Client.new do |config|
             #       config.timeout = 10.0
-            #       config.rpcs.list_recommendations.timeout = 20.0
+            #       config.rpcs.list_insights.timeout = 20.0
             #     end
             #
             # @!attribute [rw] endpoint
@@ -706,6 +939,21 @@ module Google
               #         trigger a retry.
               #
               class Rpcs
+                ##
+                # RPC-specific configuration for `list_insights`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_insights
+                ##
+                # RPC-specific configuration for `get_insight`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_insight
+                ##
+                # RPC-specific configuration for `mark_insight_accepted`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :mark_insight_accepted
                 ##
                 # RPC-specific configuration for `list_recommendations`
                 # @return [::Gapic::Config::Method]
@@ -734,6 +982,12 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
+                  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 = ::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 = ::Gapic::Config::Method.new mark_insight_accepted_config
                   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

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

@@ -24,6 +24,46 @@ module Google
         module Recommender
           # Path helper methods for the Recommender API.
           module Paths
+            ##
+            # Create a fully-qualified Insight resource string.
+            #
+            # 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]
+            #
+            # @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? "/"
+
+              "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
+            end
+
+            ##
+            # Create a fully-qualified InsightType resource string.
+            #
+            # 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]
+            #
+            # @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? "/"
+
+              "projects/#{project}/locations/#{location}/insightTypes/#{insight_type}"
+            end
+
             ##
             # Create a fully-qualified Recommendation resource string.
             #

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,16 +36,29 @@ 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, ListInsightsRequest, ListInsightsResponse
+            # Gets the requested insight. Requires the recommender.*.get IAM permission
+            # for the specified insight type.
+            rpc :GetInsight, GetInsightRequest, 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, MarkInsightAcceptedRequest, Insight
             # Lists recommendations for a Cloud project. Requires the recommender.*.list
             # IAM permission for the specified recommender.
             rpc :ListRecommendations, ListRecommendationsRequest, 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
+            # 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.
@@ -54,10 +66,11 @@ module Google
             # 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
+            # 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.
@@ -65,10 +78,11 @@ module Google
             # 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
+            # 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.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Recommender
       module V1
-        VERSION = "0.4.3"
+        VERSION = "0.5.0"
       end
     end
   end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# 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.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Recommender
+      module V1
+        # An insight along with the information used to derive the insight. The insight
+        # may have associated recomendations as well.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Name of the insight.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Free-form human readable summary in English. The maximum length is 500
+        #     characters.
+        # @!attribute [rw] target_resources
+        #   @return [::Array<::String>]
+        #     Fully qualified resource names that this insight is targeting.
+        # @!attribute [rw] insight_subtype
+        #   @return [::String]
+        #     Insight subtype. Insight content schema will be stable for a given subtype.
+        # @!attribute [rw] content
+        #   @return [::Google::Protobuf::Struct]
+        #     A struct of custom fields to explain the insight.
+        #     Example: "grantedPermissionsCount": "1000"
+        # @!attribute [rw] last_refresh_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp of the latest data used to generate the insight.
+        # @!attribute [rw] observation_period
+        #   @return [::Google::Protobuf::Duration]
+        #     Observation period that led to the insight. The source data used to
+        #     generate the insight ends at last_refresh_time and begins at
+        #     (last_refresh_time - observation_period).
+        # @!attribute [rw] state_info
+        #   @return [::Google::Cloud::Recommender::V1::InsightStateInfo]
+        #     Information state and metadata.
+        # @!attribute [rw] category
+        #   @return [::Google::Cloud::Recommender::V1::Insight::Category]
+        #     Category being targeted by the insight.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Fingerprint of the Insight. Provides optimistic locking when updating
+        #     states.
+        # @!attribute [rw] associated_recommendations
+        #   @return [::Array<::Google::Cloud::Recommender::V1::Insight::RecommendationReference>]
+        #     Recommendations derived from this insight.
+        class Insight
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Reference to an associated recommendation.
+          # @!attribute [rw] recommendation
+          #   @return [::String]
+          #     Recommendation resource name, e.g.
+          #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]
+          class RecommendationReference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Insight category.
+          module Category
+            # Unspecified category.
+            CATEGORY_UNSPECIFIED = 0
+
+            # The insight is related to cost.
+            COST = 1
+
+            # The insight is related to security.
+            SECURITY = 2
+
+            # The insight is related to performance.
+            PERFORMANCE = 3
+
+            # This insight is related to manageability.
+            MANAGEABILITY = 4
+          end
+        end
+
+        # Information related to insight state.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Recommender::V1::InsightStateInfo::State]
+        #     Insight state.
+        # @!attribute [rw] state_metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A map of metadata for the state, provided by user or automations systems.
+        class InsightStateInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class StateMetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents insight state.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # Insight is active. Content for ACTIVE insights can be updated by Google.
+            # ACTIVE insights can be marked DISMISSED OR ACCEPTED.
+            ACTIVE = 1
+
+            # Some action has been taken based on this insight. Insights become
+            # accepted when a recommendation derived from the insight has been marked
+            # CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked
+            # ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED
+            # insights can only be marked ACCEPTED (which may update state metadata).
+            ACCEPTED = 2
+
+            # Insight is dismissed. Content for DISMISSED insights can be updated by
+            # Google. DISMISSED insights can be marked as ACTIVE.
+            DISMISSED = 3
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -64,9 +64,22 @@ module Google
         #   @return [::String]
         #     Fingerprint of the Recommendation. Provides optimistic locking when
         #     updating states.
+        # @!attribute [rw] associated_insights
+        #   @return [::Array<::Google::Cloud::Recommender::V1::Recommendation::InsightReference>]
+        #     Insights that led to this recommendation.
         class Recommendation
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Reference to an associated insight.
+          # @!attribute [rw] insight
+          #   @return [::String]
+          #     Insight resource name, e.g.
+          #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]
+          class InsightReference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Contains what resources are changing and how they are changing.
@@ -264,7 +277,7 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Represents Recommendation State
+          # Represents Recommendation State.
           module State
             # Default state. Don't use directly.
             STATE_UNSPECIFIED = 0

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

@@ -21,6 +21,85 @@ module Google
   module Cloud
     module Recommender
       module V1
+        # Request for the `ListInsights` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The container resource on which to execute the request.
+        #     Acceptable formats:
+        #
+        #     1.
+        #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
+        #
+        #     LOCATION here refers to GCP Locations:
+        #     https://cloud.google.com/about/locations/
+        # @!attribute [rw] page_size
+        #   @return [::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
+        #     of results to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. If present, retrieves the next batch of results from the preceding call to
+        #     this method. `page_token` must be the value of `next_page_token` from the
+        #     previous response. The values of other method parameters must be identical
+        #     to those in the previous call.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression to restrict the insights returned. Supported
+        #     filter fields: state
+        #     Eg: `state:"DISMISSED" or state:"ACTIVE"
+        class ListInsightsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response to the `ListInsights` method.
+        # @!attribute [rw] insights
+        #   @return [::Array<::Google::Cloud::Recommender::V1::Insight>]
+        #     The set of insights for the `parent` resource.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be used to request the next page of results. This field is
+        #     empty if there are no additional results.
+        class ListInsightsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to the `GetInsight` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the insight.
+        class GetInsightRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `MarkInsightAccepted` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the insight.
+        # @!attribute [rw] state_metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. State properties user wish to include with this state.  Full replace of the
+        #     current state_metadata.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Required. Fingerprint of the Insight. Provides optimistic locking.
+        class MarkInsightAcceptedRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class StateMetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request for the `ListRecommendations` method.
         # @!attribute [rw] parent
         #   @return [::String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-07-16 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.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - README.md
 - lib/google-cloud-recommender-v1.rb
 - lib/google/cloud/recommender/v1.rb
+- lib/google/cloud/recommender/v1/insight_pb.rb
 - lib/google/cloud/recommender/v1/recommendation_pb.rb
 - lib/google/cloud/recommender/v1/recommender.rb
 - lib/google/cloud/recommender/v1/recommender/client.rb
@@ -174,6 +175,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/recommender/v1/insight.rb
 - proto_docs/google/cloud/recommender/v1/recommendation.rb
 - proto_docs/google/cloud/recommender/v1/recommender_service.rb
 - proto_docs/google/protobuf/duration.rb