insights

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

Overview

Name	insights
Type	Resource
Id	google.recommender.insights

Fields

The following fields are returned by SELECT queries:

projects_locations_insight_types_insights_get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

billing_accounts_locations_insight_types_insights_get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

folders_locations_insight_types_insights_get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

organizations_locations_insight_types_insights_get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

projects_locations_insight_types_insights_list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

billing_accounts_locations_insight_types_insights_list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

folders_locations_insight_types_insights_list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

organizations_locations_insight_types_insights_list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the insight.
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"
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
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 (google-datetime)	Timestamp of the latest data used to generate the insight.
observationPeriod	string (google-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).
severity	string	Insight's severity.
stateInfo	object	Information state and metadata. (id: GoogleCloudRecommenderV1InsightStateInfo)
targetResources	array	Fully qualified resource names that this insight is targeting.

Methods

The following methods are available for this resource:

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billingAccountsId	string
foldersId	string
insightTypesId	string
insightsId	string
locationsId	string
organizationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_insight_types_insights_get

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

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

billing_accounts_locations_insight_types_insights_get

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

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

folders_locations_insight_types_insights_get

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

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

organizations_locations_insight_types_insights_get

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

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

projects_locations_insight_types_insights_list

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

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

billing_accounts_locations_insight_types_insights_list

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

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

folders_locations_insight_types_insights_list

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

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

organizations_locations_insight_types_insights_list

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

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

Lifecycle Methods

projects_locations_insight_types_insights_mark_accepted

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.

EXEC google.recommender.insights.projects_locations_insight_types_insights_mark_accepted 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@insightTypesId='{{ insightTypesId }}' --required, 
@insightsId='{{ insightsId }}' --required 
@@json=
'{
"stateMetadata": "{{ stateMetadata }}", 
"etag": "{{ etag }}"
}';

billing_accounts_locations_insight_types_insights_mark_accepted

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.

EXEC google.recommender.insights.billing_accounts_locations_insight_types_insights_mark_accepted 
@billingAccountsId='{{ billingAccountsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@insightTypesId='{{ insightTypesId }}' --required, 
@insightsId='{{ insightsId }}' --required 
@@json=
'{
"stateMetadata": "{{ stateMetadata }}", 
"etag": "{{ etag }}"
}';

folders_locations_insight_types_insights_mark_accepted

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.

EXEC google.recommender.insights.folders_locations_insight_types_insights_mark_accepted 
@foldersId='{{ foldersId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@insightTypesId='{{ insightTypesId }}' --required, 
@insightsId='{{ insightsId }}' --required 
@@json=
'{
"stateMetadata": "{{ stateMetadata }}", 
"etag": "{{ etag }}"
}';

organizations_locations_insight_types_insights_mark_accepted

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.

EXEC google.recommender.insights.organizations_locations_insight_types_insights_mark_accepted 
@organizationsId='{{ organizationsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@insightTypesId='{{ insightTypesId }}' --required, 
@insightsId='{{ insightsId }}' --required 
@@json=
'{
"stateMetadata": "{{ stateMetadata }}", 
"etag": "{{ etag }}"
}';