insights

Creates, updates, deletes, gets or lists a insights resource.

Overview

Name	insights
Type	Resource
Id	google.recommender.insights

Fields

Name	Datatype	Description
name	string	Identifier. Name of the insight.
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
associatedRecommendations	array	Recommendations derived from this insight.
category	string	Category being targeted by the insight.
content	object	A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"
etag	string	Fingerprint of the Insight. Provides optimistic locking when updating states.
insightSubtype	string	Insight subtype. Insight content schema will be stable for a given subtype.
lastRefreshTime	string	Timestamp of the latest data used to generate the insight.
observationPeriod	string	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).
severity	string	Insight's severity.
stateInfo	object	Information related to insight state.
targetResources	array	Fully qualified resource names that this insight is targeting.

Methods

Name	Accessible by	Required Params	Description
billing_accounts_locations_insight_types_insights_get	SELECT	billingAccountsId, insightTypesId, insightsId, locationsId	Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
billing_accounts_locations_insight_types_insights_list	SELECT	billingAccountsId, insightTypesId, locationsId	Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
folders_locations_insight_types_insights_get	SELECT	foldersId, insightTypesId, insightsId, locationsId	Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
folders_locations_insight_types_insights_list	SELECT	foldersId, insightTypesId, locationsId	Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
organizations_locations_insight_types_insights_get	SELECT	insightTypesId, insightsId, locationsId, organizationsId	Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
organizations_locations_insight_types_insights_list	SELECT	insightTypesId, locationsId, organizationsId	Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
projects_locations_insight_types_insights_get	SELECT	insightTypesId, insightsId, locationsId, projectsId	Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
projects_locations_insight_types_insights_list	SELECT	insightTypesId, locationsId, projectsId	Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
billing_accounts_locations_insight_types_insights_mark_accepted	EXEC	billingAccountsId, insightTypesId, insightsId, locationsId	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.
folders_locations_insight_types_insights_mark_accepted	EXEC	foldersId, insightTypesId, insightsId, locationsId	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.
organizations_locations_insight_types_insights_mark_accepted	EXEC	insightTypesId, insightsId, locationsId, organizationsId	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.
projects_locations_insight_types_insights_mark_accepted	EXEC	insightTypesId, insightsId, locationsId, projectsId	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.

SELECT examples

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

SELECT
name,
description,
associatedRecommendations,
category,
content,
etag,
insightSubtype,
lastRefreshTime,
observationPeriod,
severity,
stateInfo,
targetResources
FROM google.recommender.insights
WHERE foldersId = '{{ foldersId }}'
AND insightTypesId = '{{ insightTypesId }}'
AND locationsId = '{{ locationsId }}';