google-cloud-recommender-v1 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbc6eb90c4dbaceb1a34310e189ad968213ba4399dab10d2b3a04483b74ae21
-  data.tar.gz: cc456df40e2987509f3b94134f425c8249864e7508bd23448cdae0d13357ee80
+  metadata.gz: b2f4ec20f58f080bc3edd58db464b84842d4b33a0cf5d231523c268ae1325c65
+  data.tar.gz: a0f058576ab4a146a15a811fe386a815123139d2f639ca6fbd465e8b138c6910
 SHA512:
-  metadata.gz: e308c4383e767085449ae835fdd62faf15761e4221f1f82a7fd2327333f00727cb6b14275e01c0a95d0a4f4264c029added016fdbedd436d58f2dd5a1b2a573d
-  data.tar.gz: 3873a0a480ff1d304ba0be2bd537b188b0ea0ff04769294c4da98cad9e847bb3efc79fd314975176833b603fa5e79b9851296d1b2337c0ca8bff764a9117826d
+  metadata.gz: c666188e0feb8cc7502bf7f58fc62da776643189a88e27cc78619eec2dc0b35e4e8ff704c71b2121920e931bb7db1427a0182153ad1d6b04337cfdc8cef6ab27
+  data.tar.gz: 5c2b8debf493cc0696c75ffe2a8dc0fcedd86cfded10c8bb883888e94b5ad0193a7e0708744fd7e40b5d73eef14b90c64ef3ec934f1209af43dc94fd691f3e9a

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Recommender V1 API
+--title="Recommender V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Recommender::V1::ListInsightsRequest.new # (request f
 response = client.list_insights request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-recommender-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/recommender)

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

@@ -19,6 +19,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       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 :severity, :enum, 15, "google.cloud.recommender.v1.Insight.Severity"
       optional :etag, :string, 11
       repeated :associated_recommendations, :message, 8, "google.cloud.recommender.v1.Insight.RecommendationReference"
     end
@@ -32,6 +33,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :PERFORMANCE, 3
       value :MANAGEABILITY, 4
     end
+    add_enum "google.cloud.recommender.v1.Insight.Severity" do
+      value :SEVERITY_UNSPECIFIED, 0
+      value :LOW, 1
+      value :MEDIUM, 2
+      value :HIGH, 3
+      value :CRITICAL, 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
@@ -52,6 +60,7 @@ module Google
         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
+        Insight::Severity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Insight.Severity").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

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

@@ -17,16 +17,26 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :last_refresh_time, :message, 4, "google.protobuf.Timestamp"
       optional :primary_impact, :message, 5, "google.cloud.recommender.v1.Impact"
       repeated :additional_impact, :message, 6, "google.cloud.recommender.v1.Impact"
+      optional :priority, :enum, 17, "google.cloud.recommender.v1.Recommendation.Priority"
       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"
+      optional :xor_group_id, :string, 18
     end
     add_message "google.cloud.recommender.v1.Recommendation.InsightReference" do
       optional :insight, :string, 1
     end
+    add_enum "google.cloud.recommender.v1.Recommendation.Priority" do
+      value :PRIORITY_UNSPECIFIED, 0
+      value :P4, 1
+      value :P3, 2
+      value :P2, 3
+      value :P1, 4
+    end
     add_message "google.cloud.recommender.v1.RecommendationContent" do
       repeated :operation_groups, :message, 2, "google.cloud.recommender.v1.OperationGroup"
+      optional :overview, :message, 3, "google.protobuf.Struct"
     end
     add_message "google.cloud.recommender.v1.OperationGroup" do
       repeated :operations, :message, 1, "google.cloud.recommender.v1.Operation"
@@ -54,10 +64,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :cost, :message, 1, "google.type.Money"
       optional :duration, :message, 2, "google.protobuf.Duration"
     end
+    add_message "google.cloud.recommender.v1.SecurityProjection" do
+      optional :details, :message, 2, "google.protobuf.Struct"
+    end
     add_message "google.cloud.recommender.v1.Impact" do
       optional :category, :enum, 1, "google.cloud.recommender.v1.Impact.Category"
       oneof :projection do
         optional :cost_projection, :message, 100, "google.cloud.recommender.v1.CostProjection"
+        optional :security_projection, :message, 101, "google.cloud.recommender.v1.SecurityProjection"
       end
     end
     add_enum "google.cloud.recommender.v1.Impact.Category" do
@@ -88,11 +102,13 @@ module Google
       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
+        Recommendation::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Recommendation.Priority").enummodule
         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
         ValueMatcher = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ValueMatcher").msgclass
         CostProjection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.CostProjection").msgclass
+        SecurityProjection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.SecurityProjection").msgclass
         Impact = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Impact").msgclass
         Impact::Category = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.Impact.Category").enummodule
         RecommendationStateInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.RecommendationStateInfo").msgclass

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

@@ -176,8 +176,8 @@ module Google
             # Service calls
 
             ##
-            # Lists insights for a Cloud project. Requires the recommender.*.list IAM
-            # permission for the specified insight type.
+            # Lists insights for the specified Cloud Resource. 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
@@ -198,13 +198,20 @@ module Google
             #     Required. The container resource on which to execute the request.
             #     Acceptable formats:
             #
-            #     1.
-            #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
+            #     * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+            #
+            #     * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+            #
+            #     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+            #
+            #     * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+            #
+            #     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
             #
             #     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.)
+            #     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
@@ -216,8 +223,26 @@ module Google
             #     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"
+            #     filter fields:
+            #
+            #     * `stateInfo.state`
+            #
+            #     * `insightSubtype`
+            #
+            #     * `severity`
+            #
+            #     Examples:
+            #
+            #     * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
+            #
+            #     * `insightSubtype = PERMISSIONS_USAGE`
+            #
+            #     * `severity = CRITICAL OR severity = HIGH`
+            #
+            #     * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
+            #
+            #     (These expressions are based on the filter language described at
+            #     https://google.aip.dev/160)
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Insight>]
@@ -227,6 +252,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::ListInsightsRequest.new
+            #
+            #   # Call the list_insights method.
+            #   result = client.list_insights request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Recommender::V1::Insight.
+            #     p response
+            #   end
+            #
             def list_insights request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -299,6 +345,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::GetInsightRequest.new
+            #
+            #   # Call the get_insight method.
+            #   result = client.get_insight request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Insight.
+            #   p result
+            #
             def get_insight request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -379,6 +440,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest.new
+            #
+            #   # Call the mark_insight_accepted method.
+            #   result = client.mark_insight_accepted request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Insight.
+            #   p result
+            #
             def mark_insight_accepted request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -421,8 +497,8 @@ module Google
             end
 
             ##
-            # Lists recommendations for a Cloud project. Requires the recommender.*.list
-            # IAM permission for the specified recommender.
+            # Lists recommendations for the specified Cloud Resource. Requires the
+            # recommender.*.list IAM permission for the specified recommender.
             #
             # @overload list_recommendations(request, options = nil)
             #   Pass arguments to `list_recommendations` via a request object, either of type
@@ -443,8 +519,15 @@ module Google
             #     Required. The container resource on which to execute the request.
             #     Acceptable formats:
             #
-            #     1.
-            #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
+            #     * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+            #
+            #     * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+            #
+            #     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+            #
+            #     * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+            #
+            #     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
             #
             #     LOCATION here refers to GCP Locations:
             #     https://cloud.google.com/about/locations/
@@ -461,8 +544,26 @@ module Google
             #     to those in the previous call.
             #   @param filter [::String]
             #     Filter expression to restrict the recommendations returned. Supported
-            #     filter fields: state_info.state
-            #     Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
+            #     filter fields:
+            #
+            #     * `state_info.state`
+            #
+            #     * `recommenderSubtype`
+            #
+            #     * `priority`
+            #
+            #     Examples:
+            #
+            #     * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
+            #
+            #     * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
+            #
+            #     * `priority = P1 OR priority = P2`
+            #
+            #     * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
+            #
+            #     (These expressions are based on the filter language described at
+            #     https://google.aip.dev/160)
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Recommendation>]
@@ -472,6 +573,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::ListRecommendationsRequest.new
+            #
+            #   # Call the list_recommendations method.
+            #   result = client.list_recommendations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Recommender::V1::Recommendation.
+            #     p response
+            #   end
+            #
             def list_recommendations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -544,6 +666,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::GetRecommendationRequest.new
+            #
+            #   # Call the get_recommendation method.
+            #   result = client.get_recommendation request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Recommendation.
+            #   p result
+            #
             def get_recommendation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -630,6 +767,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest.new
+            #
+            #   # Call the mark_recommendation_claimed method.
+            #   result = client.mark_recommendation_claimed request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Recommendation.
+            #   p result
+            #
             def mark_recommendation_claimed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -717,6 +869,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest.new
+            #
+            #   # Call the mark_recommendation_succeeded method.
+            #   result = client.mark_recommendation_succeeded request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Recommendation.
+            #   p result
+            #
             def mark_recommendation_succeeded request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -804,6 +971,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/recommender/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Recommender::V1::Recommender::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest.new
+            #
+            #   # Call the mark_recommendation_failed method.
+            #   result = client.mark_recommendation_failed request
+            #
+            #   # The returned object is of type Google::Cloud::Recommender::V1::Recommendation.
+            #   p result
+            #
             def mark_recommendation_failed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -36,8 +36,8 @@ 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.
+            # Lists insights for the specified Cloud Resource. 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.
@@ -49,8 +49,8 @@ module Google
             # 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.
+            # Lists recommendations for the specified Cloud Resource. Requires the
+            # recommender.*.list IAM permission for the specified recommender.
             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.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Recommender
       module V1
-        VERSION = "0.8.4"
+        VERSION = "0.9.0"
       end
     end
   end

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

@@ -25,6 +25,8 @@ module Google
       ##
       # To load this package, including all its services, and instantiate a client:
       #
+      # @example
+      #
       #     require "google/cloud/recommender/v1"
       #     client = ::Google::Cloud::Recommender::V1::Recommender::Client.new
       #

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

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

@@ -54,6 +54,9 @@ module Google
         # @!attribute [rw] category
         #   @return [::Google::Cloud::Recommender::V1::Insight::Category]
         #     Category being targeted by the insight.
+        # @!attribute [rw] severity
+        #   @return [::Google::Cloud::Recommender::V1::Insight::Severity]
+        #     Insight's severity.
         # @!attribute [rw] etag
         #   @return [::String]
         #     Fingerprint of the Insight. Provides optimistic locking when updating
@@ -92,6 +95,24 @@ module Google
             # This insight is related to manageability.
             MANAGEABILITY = 4
           end
+
+          # Insight severity levels.
+          module Severity
+            # Insight has unspecified severity.
+            SEVERITY_UNSPECIFIED = 0
+
+            # Insight has low severity.
+            LOW = 1
+
+            # Insight has medium severity.
+            MEDIUM = 2
+
+            # Insight has high severity.
+            HIGH = 3
+
+            # Insight has critical severity.
+            CRITICAL = 4
+          end
         end
 
         # Information related to insight state.

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

@@ -54,6 +54,9 @@ module Google
         #     Optional set of additional impact that this recommendation may have when
         #     trying to optimize for the primary category. These may be positive
         #     or negative.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::Recommender::V1::Recommendation::Priority]
+        #     Recommendation's priority.
         # @!attribute [rw] content
         #   @return [::Google::Cloud::Recommender::V1::RecommendationContent]
         #     Content of the recommendation describing recommended changes to resources.
@@ -67,6 +70,12 @@ module Google
         # @!attribute [rw] associated_insights
         #   @return [::Array<::Google::Cloud::Recommender::V1::Recommendation::InsightReference>]
         #     Insights that led to this recommendation.
+        # @!attribute [rw] xor_group_id
+        #   @return [::String]
+        #     Corresponds to a mutually exclusive group ID within a recommender.
+        #     A non-empty ID indicates that the recommendation belongs to a mutually
+        #     exclusive group. This means that only one recommendation within the group
+        #     is suggested to be applied.
         class Recommendation
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -80,6 +89,24 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Recommendation priority levels.
+          module Priority
+            # Recommendation has unspecified priority.
+            PRIORITY_UNSPECIFIED = 0
+
+            # Recommendation has P4 priority (lowest priority).
+            P4 = 1
+
+            # Recommendation has P3 priority (second lowest priority).
+            P3 = 2
+
+            # Recommendation has P2 priority (second highest priority).
+            P2 = 3
+
+            # Recommendation has P1 priority (highest priority).
+            P1 = 4
+          end
         end
 
         # Contains what resources are changing and how they are changing.
@@ -88,6 +115,9 @@ module Google
         #     Operations to one or more Google Cloud resources grouped in such a way
         #     that, all operations within one group are expected to be performed
         #     atomically and in an order.
+        # @!attribute [rw] overview
+        #   @return [::Google::Protobuf::Struct]
+        #     Condensed overview information about the recommendation.
         class RecommendationContent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -114,7 +144,7 @@ module Google
         # See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
         # @!attribute [rw] action
         #   @return [::String]
-        #     Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',
+        #     Type of this operation. Contains one of 'add', 'remove', 'replace', 'move',
         #     'copy', 'test' and custom operations. This field is case-insensitive and
         #     always populated.
         # @!attribute [rw] resource_type
@@ -184,7 +214,7 @@ module Google
         # @!attribute [rw] path_value_matchers
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Recommender::V1::ValueMatcher}]
         #     Similar to path_filters, this contains set of filters to apply if `path`
-        #     field referes to array elements. This is meant to support value matching
+        #     field refers to array elements. This is meant to support value matching
         #     beyond exact match. To perform exact match, use path_filters.
         #     When both path_filters and path_value_matchers are set, an implicit AND
         #     must be performed.
@@ -228,6 +258,9 @@ module Google
         #     An approximate projection on amount saved or amount incurred. Negative cost
         #     units indicate cost savings and positive cost units indicate increase.
         #     See google.type.Money documentation for positive/negative units.
+        #
+        #     A user's permissions may affect whether the cost is computed using list
+        #     prices or custom contract prices.
         # @!attribute [rw] duration
         #   @return [::Google::Protobuf::Duration]
         #     Duration for which this cost applies.
@@ -236,6 +269,15 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Contains various ways of describing the impact on Security.
+        # @!attribute [rw] details
+        #   @return [::Google::Protobuf::Struct]
+        #     Additional security impact details that is provided by the recommender.
+        class SecurityProjection
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Contains the impact a recommendation can have for a given category.
         # @!attribute [rw] category
         #   @return [::Google::Cloud::Recommender::V1::Impact::Category]
@@ -243,6 +285,9 @@ module Google
         # @!attribute [rw] cost_projection
         #   @return [::Google::Cloud::Recommender::V1::CostProjection]
         #     Use with CategoryType.COST
+        # @!attribute [rw] security_projection
+        #   @return [::Google::Cloud::Recommender::V1::SecurityProjection]
+        #     Use with CategoryType.SECURITY
         class Impact
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -27,13 +27,20 @@ module Google
         #     Required. The container resource on which to execute the request.
         #     Acceptable formats:
         #
-        #     1.
-        #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
+        #     * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+        #
+        #     * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+        #
+        #     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+        #
+        #     * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
+        #
+        #     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
         #
         #     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.)
+        #     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
@@ -48,8 +55,26 @@ module Google
         # @!attribute [rw] filter
         #   @return [::String]
         #     Optional. Filter expression to restrict the insights returned. Supported
-        #     filter fields: state
-        #     Eg: `state:"DISMISSED" or state:"ACTIVE"
+        #     filter fields:
+        #
+        #     * `stateInfo.state`
+        #
+        #     * `insightSubtype`
+        #
+        #     * `severity`
+        #
+        #     Examples:
+        #
+        #     * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
+        #
+        #     * `insightSubtype = PERMISSIONS_USAGE`
+        #
+        #     * `severity = CRITICAL OR severity = HIGH`
+        #
+        #     * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
+        #
+        #     (These expressions are based on the filter language described at
+        #     https://google.aip.dev/160)
         class ListInsightsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -108,8 +133,15 @@ module Google
         #     Required. The container resource on which to execute the request.
         #     Acceptable formats:
         #
-        #     1.
-        #     "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
+        #     * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+        #
+        #     * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+        #
+        #     * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+        #
+        #     * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
+        #
+        #     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
         #
         #     LOCATION here refers to GCP Locations:
         #     https://cloud.google.com/about/locations/
@@ -129,8 +161,26 @@ module Google
         # @!attribute [rw] filter
         #   @return [::String]
         #     Filter expression to restrict the recommendations returned. Supported
-        #     filter fields: state_info.state
-        #     Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
+        #     filter fields:
+        #
+        #     * `state_info.state`
+        #
+        #     * `recommenderSubtype`
+        #
+        #     * `priority`
+        #
+        #     Examples:
+        #
+        #     * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
+        #
+        #     * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
+        #
+        #     * `priority = P1 OR priority = P2`
+        #
+        #     * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
+        #
+        #     (These expressions are based on the filter language described at
+        #     https://google.aip.dev/160)
         class ListRecommendationsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Recommender V1 API