google-cloud-recommender-v1 0.8.5 → 0.10.0

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+        # Configuration for a Recommender.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Name of recommender config.
+        #     Eg,
+        #     projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
+        # @!attribute [rw] recommender_generation_config
+        #   @return [::Google::Cloud::Recommender::V1::RecommenderGenerationConfig]
+        #     RecommenderGenerationConfig which configures the Generation of
+        #     recommendations for this recommender.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Fingerprint of the RecommenderConfig. Provides optimistic locking when
+        #     updating.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Last time when the config was updated.
+        # @!attribute [r] revision_id
+        #   @return [::String]
+        #     Output only. Immutable. The revision ID of the config.
+        #     A new revision is committed whenever the config is changed in any way.
+        #     The format is an 8-character hexadecimal string.
+        # @!attribute [rw] annotations
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Allows clients to store small amounts of arbitrary data. Annotations must
+        #     follow the Kubernetes syntax.
+        #     The total size of all keys and values combined is limited to 256k.
+        #     Key can have 2 segments: prefix (optional) and name (required),
+        #     separated by a slash (/).
+        #     Prefix must be a DNS subdomain.
+        #     Name must be 63 characters or less, begin and end with alphanumerics,
+        #     with dashes (-), underscores (_), dots (.), and alphanumerics between.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     A user-settable field to provide a human-readable name to be used in user
+        #     interfaces.
+        class RecommenderConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AnnotationsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A Configuration to customize the generation of recommendations.
+        # Eg, customizing the lookback period considered when generating a
+        # recommendation.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Struct]
+        #     Parameters for this RecommenderGenerationConfig. These configs can be used
+        #     by or are applied to all subtypes.
+        class RecommenderGenerationConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -27,29 +27,54 @@ 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
-        #     values are ignored. If not specified, the server will determine the number
-        #     of results to return.
+        #     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.
+        #     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"
+        #     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
@@ -83,8 +108,8 @@ module Google
         #     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.
+        #     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.
@@ -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/
@@ -117,20 +149,38 @@ module Google
         #     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
-        #     values are ignored. If not specified, the server will determine the number
-        #     of results to return.
+        #     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.
+        #     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]
         #     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
@@ -238,6 +288,72 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # Request for the GetRecommenderConfig` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the Recommendation Config to get.
+        #
+        #     Acceptable formats:
+        #
+        #     * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
+        #
+        #     * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
+        #
+        #     * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
+        class GetRecommenderConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `UpdateRecommenderConfig` method.
+        # @!attribute [rw] recommender_config
+        #   @return [::Google::Cloud::Recommender::V1::RecommenderConfig]
+        #     Required. The RecommenderConfig to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The list of fields to be updated.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     If true, validate the request and preview the change, but do not actually
+        #     update it.
+        class UpdateRecommenderConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the GetInsightTypeConfig` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the InsightTypeConfig to get.
+        #
+        #     Acceptable formats:
+        #
+        #     * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`
+        #
+        #     * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`
+        #
+        #     * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`
+        class GetInsightTypeConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the `UpdateInsightTypeConfig` method.
+        # @!attribute [rw] insight_type_config
+        #   @return [::Google::Cloud::Recommender::V1::InsightTypeConfig]
+        #     Required. The InsightTypeConfig to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The list of fields to be updated.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     If true, validate the request and preview the change, but do not actually
+        #     update it.
+        class UpdateInsightTypeConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/struct.rb

@@ -46,8 +46,8 @@ module Google
 
     # `Value` represents a dynamically typed value which can be either
     # null, a number, a string, a boolean, a recursive struct value, or a
-    # list of values. A producer of value is expected to set one of that
-    # variants, absence of any variant indicates an error.
+    # list of values. A producer of value is expected to set one of these
+    # variants. Absence of any variant indicates an error.
     #
     # The JSON representation for `Value` is JSON value.
     # @!attribute [rw] null_value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender-v1
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -172,11 +172,13 @@ files:
 - 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/insight_type_config_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
 - lib/google/cloud/recommender/v1/recommender/credentials.rb
 - lib/google/cloud/recommender/v1/recommender/paths.rb
+- lib/google/cloud/recommender/v1/recommender_config_pb.rb
 - lib/google/cloud/recommender/v1/recommender_service_pb.rb
 - lib/google/cloud/recommender/v1/recommender_service_services_pb.rb
 - lib/google/cloud/recommender/v1/version.rb
@@ -184,9 +186,12 @@ files:
 - 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/insight_type_config.rb
 - proto_docs/google/cloud/recommender/v1/recommendation.rb
+- proto_docs/google/cloud/recommender/v1/recommender_config.rb
 - proto_docs/google/cloud/recommender/v1/recommender_service.rb
 - proto_docs/google/protobuf/duration.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/struct.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/type/money.rb
@@ -209,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Recommender V1 API