google-cloud-recommender-v1 0.4.3 → 0.6.0

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.6.0"
       end
     end
   end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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.
@@ -150,12 +163,12 @@ module Google
         #       "/versions/*/targetSize/percent": 20
         #      }
         #     * Example: {
-        #       "/bindings/*/role": "roles/admin"
+        #       "/bindings/*/role": "roles/owner"
         #       "/bindings/*/condition" : null
         #      }
         #     * Example: {
-        #       "/bindings/*/role": "roles/admin"
-        #       "/bindings/*/members/*" : ["x@google.com", "y@google.com"]
+        #       "/bindings/*/role": "roles/owner"
+        #       "/bindings/*/members/*" : ["x@example.com", "y@example.com"]
         #      }
         #     When both path_filters and path_value_matchers are set, an implicit AND
         #     must be performed.
@@ -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,87 @@ 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/
+        #     INSIGHT_TYPE_ID refers to supported insight types:
+        #     https://cloud.google.com/recommender/docs/insights/insight-types.)
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of results to return from this request.  Non-positive
+        #     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]
@@ -32,6 +113,8 @@ module Google
         #
         #     LOCATION here refers to GCP Locations:
         #     https://cloud.google.com/about/locations/
+        #     RECOMMENDER_ID refers to supported recommenders:
+        #     https://cloud.google.com/recommender/docs/recommenders.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The maximum number of results to return from this request.  Non-positive

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2021-01-26 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
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Recommender V1 API