# REST Resource: projects.locations.recommenders.recommendations

- [Resource: Recommendation](https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations#Recommendation)
  - [JSON representation](https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations#Recommendation.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations#METHODS_SUMMARY)

## Resource: Recommendation

A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

| JSON representation |
|---|
| ``` { "name": string, "description": string, "recommenderSubtype": string, "lastRefreshTime": string, "primaryImpact": { object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Impact`) }, "additionalImpact": [ { object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Impact`) } ], "priority": enum (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Priority`), "content": { object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.RecommendationContent`) }, "stateInfo": { object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.RecommendationStateInfo`) }, "etag": string, "associatedInsights": [ { object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.InsightReference`) } ], "xorGroupId": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Name of recommendation. |
| `description` | `string` Free-form human readable summary in English. The maximum length is 500 characters. |
| `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 `primaryImpact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommenderSubtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" |
| `lastRefreshTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Last time this recommendation was refreshed by the system that created it in the first place. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `primaryImpact` | ``object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Impact`)`` The primary impact that this recommendation can have while trying to optimize for one category. |
| `additionalImpact[]` | ``object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Impact`)`` Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. |
| `priority` | ``enum (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.Priority`)`` Recommendation's priority. |
| `content` | ``object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.RecommendationContent`)`` Content of the recommendation describing recommended changes to resources. |
| `stateInfo` | ``object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.RecommendationStateInfo`)`` Information for state. Contains state and metadata. |
| `etag` | `string` Fingerprint of the Recommendation. Provides optimistic locking when updating states. |
| `associatedInsights[]` | ``object (`https://docs.cloud.google.com/recommender/docs/reference/rest/v1/billingAccounts.locations.recommenders.recommendations#Recommendation.InsightReference`)`` Insights that led to this recommendation. |
| `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 ||
|---|---|
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/get` | Gets the requested recommendation. |
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/list` | Lists recommendations for the specified Cloud Resource. |
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/markClaimed` | Marks the Recommendation State as Claimed. |
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/markDismissed` | Mark the Recommendation State as Dismissed. |
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/markFailed` | Marks the Recommendation State as Failed. |
| ### `https://docs.cloud.google.com/recommender/docs/reference/rest/v1/projects.locations.recommenders.recommendations/markSucceeded` | Marks the Recommendation State as Succeeded. |