google-api-client 0.41.2 → 0.42.0

data/generated/google/apis/recommender_v1/classes.rb

@@ -72,6 +72,163 @@ module Google
         end
       end
       
+      # An insight along with the information used to derive the insight. The insight
+      # may have associated recomendations as well.
+      class GoogleCloudRecommenderV1Insight
+        include Google::Apis::Core::Hashable
+      
+        # Recommendations derived from this insight.
+        # Corresponds to the JSON property `associatedRecommendations`
+        # @return [Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightRecommendationReference>]
+        attr_accessor :associated_recommendations
+      
+        # Category being targeted by the insight.
+        # Corresponds to the JSON property `category`
+        # @return [String]
+        attr_accessor :category
+      
+        # A struct of custom fields to explain the insight.
+        # Example: "grantedPermissionsCount": "1000"
+        # Corresponds to the JSON property `content`
+        # @return [Hash<String,Object>]
+        attr_accessor :content
+      
+        # Free-form human readable summary in English. The maximum length is 500
+        # characters.
+        # Corresponds to the JSON property `description`
+        # @return [String]
+        attr_accessor :description
+      
+        # Fingerprint of the Insight. Provides optimistic locking when updating
+        # states.
+        # Corresponds to the JSON property `etag`
+        # @return [String]
+        attr_accessor :etag
+      
+        # Insight subtype. Insight content schema will be stable for a given subtype.
+        # Corresponds to the JSON property `insightSubtype`
+        # @return [String]
+        attr_accessor :insight_subtype
+      
+        # Timestamp of the latest data used to generate the insight.
+        # Corresponds to the JSON property `lastRefreshTime`
+        # @return [String]
+        attr_accessor :last_refresh_time
+      
+        # Name of the insight.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # 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).
+        # Corresponds to the JSON property `observationPeriod`
+        # @return [String]
+        attr_accessor :observation_period
+      
+        # Information related to insight state.
+        # Corresponds to the JSON property `stateInfo`
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightStateInfo]
+        attr_accessor :state_info
+      
+        # Fully qualified resource names that this insight is targeting.
+        # Corresponds to the JSON property `targetResources`
+        # @return [Array<String>]
+        attr_accessor :target_resources
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @associated_recommendations = args[:associated_recommendations] if args.key?(:associated_recommendations)
+          @category = args[:category] if args.key?(:category)
+          @content = args[:content] if args.key?(:content)
+          @description = args[:description] if args.key?(:description)
+          @etag = args[:etag] if args.key?(:etag)
+          @insight_subtype = args[:insight_subtype] if args.key?(:insight_subtype)
+          @last_refresh_time = args[:last_refresh_time] if args.key?(:last_refresh_time)
+          @name = args[:name] if args.key?(:name)
+          @observation_period = args[:observation_period] if args.key?(:observation_period)
+          @state_info = args[:state_info] if args.key?(:state_info)
+          @target_resources = args[:target_resources] if args.key?(:target_resources)
+        end
+      end
+      
+      # Reference to an associated recommendation.
+      class GoogleCloudRecommenderV1InsightRecommendationReference
+        include Google::Apis::Core::Hashable
+      
+        # Recommendation resource name, e.g.
+        # projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/
+        # recommendations/[RECOMMENDATION_ID]
+        # Corresponds to the JSON property `recommendation`
+        # @return [String]
+        attr_accessor :recommendation
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @recommendation = args[:recommendation] if args.key?(:recommendation)
+        end
+      end
+      
+      # Information related to insight state.
+      class GoogleCloudRecommenderV1InsightStateInfo
+        include Google::Apis::Core::Hashable
+      
+        # Insight state.
+        # Corresponds to the JSON property `state`
+        # @return [String]
+        attr_accessor :state
+      
+        # A map of metadata for the state, provided by user or automations systems.
+        # Corresponds to the JSON property `stateMetadata`
+        # @return [Hash<String,String>]
+        attr_accessor :state_metadata
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @state = args[:state] if args.key?(:state)
+          @state_metadata = args[:state_metadata] if args.key?(:state_metadata)
+        end
+      end
+      
+      # Response to the `ListInsights` method.
+      class GoogleCloudRecommenderV1ListInsightsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The set of insights for the `parent` resource.
+        # Corresponds to the JSON property `insights`
+        # @return [Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight>]
+        attr_accessor :insights
+      
+        # A token that can be used to request the next page of results. This field is
+        # empty if there are no additional results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @insights = args[:insights] if args.key?(:insights)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response to the `ListRecommendations` method.
       class GoogleCloudRecommenderV1ListRecommendationsResponse
         include Google::Apis::Core::Hashable
@@ -98,6 +255,33 @@ module Google
         end
       end
       
+      # Request for the `MarkInsightAccepted` method.
+      class GoogleCloudRecommenderV1MarkInsightAcceptedRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Fingerprint of the Insight. Provides optimistic locking.
+        # Corresponds to the JSON property `etag`
+        # @return [String]
+        attr_accessor :etag
+      
+        # Optional. State properties user wish to include with this state.  Full replace
+        # of the
+        # current state_metadata.
+        # Corresponds to the JSON property `stateMetadata`
+        # @return [Hash<String,String>]
+        attr_accessor :state_metadata
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @etag = args[:etag] if args.key?(:etag)
+          @state_metadata = args[:state_metadata] if args.key?(:state_metadata)
+        end
+      end
+      
       # Request for the `MarkRecommendationClaimed` Method.
       class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
         include Google::Apis::Core::Hashable
@@ -329,6 +513,11 @@ module Google
         # @return [Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact>]
         attr_accessor :additional_impact
       
+        # Insights that led to this recommendation.
+        # Corresponds to the JSON property `associatedInsights`
+        # @return [Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationInsightReference>]
+        attr_accessor :associated_insights
+      
         # Contains what resources are changing and how they are changing.
         # Corresponds to the JSON property `content`
         # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent]
@@ -386,6 +575,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @additional_impact = args[:additional_impact] if args.key?(:additional_impact)
+          @associated_insights = args[:associated_insights] if args.key?(:associated_insights)
           @content = args[:content] if args.key?(:content)
           @description = args[:description] if args.key?(:description)
           @etag = args[:etag] if args.key?(:etag)
@@ -418,6 +608,27 @@ module Google
         end
       end
       
+      # Reference to an associated insight.
+      class GoogleCloudRecommenderV1RecommendationInsightReference
+        include Google::Apis::Core::Hashable
+      
+        # Insight resource name, e.g.
+        # projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/
+        # insights/[INSIGHT_ID]
+        # Corresponds to the JSON property `insight`
+        # @return [String]
+        attr_accessor :insight
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @insight = args[:insight] if args.key?(:insight)
+        end
+      end
+      
       # Information for state. Contains state and metadata.
       class GoogleCloudRecommenderV1RecommendationStateInfo
         include Google::Apis::Core::Hashable

data/generated/google/apis/recommender_v1/representations.rb

@@ -34,12 +34,42 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRecommenderV1Insight
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1InsightRecommendationReference
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1InsightStateInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1ListInsightsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRecommenderV1ListRecommendationsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRecommenderV1MarkInsightAcceptedRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -82,6 +112,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRecommenderV1RecommendationInsightReference
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRecommenderV1RecommendationStateInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -118,6 +154,49 @@ module Google
         end
       end
       
+      class GoogleCloudRecommenderV1Insight
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :associated_recommendations, as: 'associatedRecommendations', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightRecommendationReference, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightRecommendationReference::Representation
+      
+          property :category, as: 'category'
+          hash :content, as: 'content'
+          property :description, as: 'description'
+          property :etag, as: 'etag'
+          property :insight_subtype, as: 'insightSubtype'
+          property :last_refresh_time, as: 'lastRefreshTime'
+          property :name, as: 'name'
+          property :observation_period, as: 'observationPeriod'
+          property :state_info, as: 'stateInfo', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightStateInfo, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightStateInfo::Representation
+      
+          collection :target_resources, as: 'targetResources'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1InsightRecommendationReference
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :recommendation, as: 'recommendation'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1InsightStateInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :state, as: 'state'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1ListInsightsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :insights, as: 'insights', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleCloudRecommenderV1ListRecommendationsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -127,6 +206,14 @@ module Google
         end
       end
       
+      class GoogleCloudRecommenderV1MarkInsightAcceptedRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
       class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -182,6 +269,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           collection :additional_impact, as: 'additionalImpact', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact::Representation
       
+          collection :associated_insights, as: 'associatedInsights', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationInsightReference, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationInsightReference::Representation
+      
           property :content, as: 'content', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent::Representation
       
           property :description, as: 'description'
@@ -204,6 +293,13 @@ module Google
         end
       end
       
+      class GoogleCloudRecommenderV1RecommendationInsightReference
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :insight, as: 'insight'
+        end
+      end
+      
       class GoogleCloudRecommenderV1RecommendationStateInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/generated/google/apis/recommender_v1/service.rb

@@ -47,6 +47,129 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Gets the requested insight. Requires the recommender.*.get IAM permission
+        # for the specified insight type.
+        # @param [String] name
+        #   Required. Name of the insight.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists insights for a Cloud project. Requires the recommender.*.list IAM
+        # permission for the specified insight type.
+        # @param [String] parent
+        #   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 [String] filter
+        #   Optional. Filter expression to restrict the insights returned. Supported
+        #   filter fields: state
+        #   Eg: `state:"DISMISSED" or state:"ACTIVE"
+        # @param [Fixnum] page_size
+        #   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 [String] page_token
+        #   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 [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/insights', options)
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        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.
+        # @param [String] name
+        #   Required. Name of the insight.
+        # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest] google_cloud_recommender_v1_mark_insight_accepted_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def mark_project_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
+          command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
+          command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the requested recommendation. Requires the recommender.*.get
         # IAM permission for the specified recommender.
         # @param [String] name