recommendations

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

Overview

Name	recommendations
Type	Resource
Id	google.recommender.recommendations

Fields

Name	Datatype	Description
name	string	Identifier. Name of recommendation.
description	string	Free-form human readable summary in English. The maximum length is 500 characters.
additionalImpact	array	Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.
associatedInsights	array	Insights that led to this recommendation.
content	object	Contains what resources are changing and how they are changing.
etag	string	Fingerprint of the Recommendation. Provides optimistic locking when updating states.
lastRefreshTime	string	Last time this recommendation was refreshed by the system that created it in the first place.
primaryImpact	object	Contains the impact a recommendation can have for a given category.
priority	string	Recommendation's priority.
recommenderSubtype	string	Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to content or primary_impact.category are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"
stateInfo	object	Information for state. Contains state and metadata.
targetResources	array	Fully qualified resource names that this recommendation is targeting.
xorGroupId	string	Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied.

Methods

Name	Accessible by	Required Params	Description
billing_accounts_locations_recommenders_recommendations_get	SELECT	billingAccountsId, locationsId, recommendationsId, recommendersId	Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
billing_accounts_locations_recommenders_recommendations_list	SELECT	billingAccountsId, locationsId, recommendersId	Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_get	SELECT	foldersId, locationsId, recommendationsId, recommendersId	Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_list	SELECT	foldersId, locationsId, recommendersId	Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_get	SELECT	locationsId, organizationsId, recommendationsId, recommendersId	Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_list	SELECT	locationsId, organizationsId, recommendersId	Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_get	SELECT	locationsId, projectsId, recommendationsId, recommendersId	Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_list	SELECT	locationsId, projectsId, recommendersId	Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
billing_accounts_locations_recommenders_recommendations_mark_claimed	EXEC	billingAccountsId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
billing_accounts_locations_recommenders_recommendations_mark_dismissed	EXEC	billingAccountsId, locationsId, recommendationsId, recommendersId	Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
billing_accounts_locations_recommenders_recommendations_mark_failed	EXEC	billingAccountsId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
billing_accounts_locations_recommenders_recommendations_mark_succeeded	EXEC	billingAccountsId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_mark_claimed	EXEC	foldersId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_mark_dismissed	EXEC	foldersId, locationsId, recommendationsId, recommendersId	Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_mark_failed	EXEC	foldersId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
folders_locations_recommenders_recommendations_mark_succeeded	EXEC	foldersId, locationsId, recommendationsId, recommendersId	Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_mark_claimed	EXEC	locationsId, organizationsId, recommendationsId, recommendersId	Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_mark_dismissed	EXEC	locationsId, organizationsId, recommendationsId, recommendersId	Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_mark_failed	EXEC	locationsId, organizationsId, recommendationsId, recommendersId	Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
organizations_locations_recommenders_recommendations_mark_succeeded	EXEC	locationsId, organizationsId, recommendationsId, recommendersId	Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_mark_claimed	EXEC	locationsId, projectsId, recommendationsId, recommendersId	Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_mark_dismissed	EXEC	locationsId, projectsId, recommendationsId, recommendersId	Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_mark_failed	EXEC	locationsId, projectsId, recommendationsId, recommendersId	Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.
projects_locations_recommenders_recommendations_mark_succeeded	EXEC	locationsId, projectsId, recommendationsId, recommendersId	Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

SELECT examples

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

SELECT
name,
description,
additionalImpact,
associatedInsights,
content,
etag,
lastRefreshTime,
primaryImpact,
priority,
recommenderSubtype,
stateInfo,
targetResources,
xorGroupId
FROM google.recommender.recommendations
WHERE foldersId = '{{ foldersId }}'
AND locationsId = '{{ locationsId }}'
AND recommendersId = '{{ recommendersId }}';