Index
Recommender
(interface)CostProjection
(message)GetInsightRequest
(message)GetRecommendationRequest
(message)Impact
(message)Impact.Category
(enum)Insight
(message)Insight.Category
(enum)Insight.RecommendationReference
(message)InsightStateInfo
(message)InsightStateInfo.State
(enum)ListInsightsRequest
(message)ListInsightsResponse
(message)ListRecommendationsRequest
(message)ListRecommendationsResponse
(message)MarkInsightAcceptedRequest
(message)MarkRecommendationClaimedRequest
(message)MarkRecommendationFailedRequest
(message)MarkRecommendationSucceededRequest
(message)Operation
(message)OperationGroup
(message)Recommendation
(message)Recommendation.InsightReference
(message)RecommendationContent
(message)RecommendationStateInfo
(message)RecommendationStateInfo.State
(enum)ValueMatcher
(message)
Recommender
Provides insights and recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.
GetInsight | |
---|---|
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
|
GetRecommendation | |
---|---|
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
|
ListInsights | |
---|---|
Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
|
ListRecommendations | |
---|---|
Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.
|
MarkInsightAccepted | |
---|---|
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.
|
MarkRecommendationClaimed | |
---|---|
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.
|
MarkRecommendationFailed | |
---|---|
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.
|
MarkRecommendationSucceeded | |
---|---|
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.
|
CostProjection
Contains metadata about how much money a recommendation can save or incur.
Fields | |
---|---|
cost |
An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units. |
duration |
Duration for which this cost applies. |
GetInsightRequest
Request to the GetInsight
method.
Fields | |
---|---|
name |
Required. Name of the insight. |
GetRecommendationRequest
Request to the GetRecommendation
method.
Fields | |
---|---|
name |
Required. Name of the recommendation. |
Impact
Contains the impact a recommendation can have for a given category.
Fields | |
---|---|
category |
Category that is being targeted. |
cost_projection |
Use with CategoryType.COST |
Category
The category of the impact.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Default unspecified category. Don't use directly. |
COST |
Indicates a potential increase or decrease in cost. |
SECURITY |
Indicates a potential increase or decrease in security. |
PERFORMANCE |
Indicates a potential increase or decrease in performance. |
MANAGEABILITY |
Indicates a potential increase or decrease in manageability. |
Insight
An insight along with the information used to derive the insight. The insight may have associated recomendations as well.
Fields | |
---|---|
name |
Name of the insight. |
description |
Free-form human readable summary in English. The maximum length is 500 characters. |
target_resources[] |
Fully qualified resource names that this insight is targeting. |
insight_subtype |
Insight subtype. Insight content schema will be stable for a given subtype. |
content |
A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" |
last_refresh_time |
Timestamp of the latest data used to generate the insight. |
observation_period |
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). |
state_info |
Information state and metadata. |
category |
Category being targeted by the insight. |
etag |
Fingerprint of the Insight. Provides optimistic locking when updating states. |
associated_recommendations[] |
Recommendations derived from this insight. |
Category
Insight category.
Enums | |
---|---|
CATEGORY_UNSPECIFIED |
Unspecified category. |
COST |
The insight is related to cost. |
SECURITY |
The insight is related to security. |
PERFORMANCE |
The insight is related to performance. |
MANAGEABILITY |
This insight is related to manageability. |
RecommendationReference
Reference to an associated recommendation.
Fields | |
---|---|
recommendation |
Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] |
InsightStateInfo
Information related to insight state.
Fields | |
---|---|
state |
Insight state. |
state_metadata |
A map of metadata for the state, provided by user or automations systems. |
State
Represents insight state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
ACTIVE |
Insight is active. Content for ACTIVE insights can be updated by Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. |
ACCEPTED |
Some action has been taken based on this insight. Insights become accepted when a recommendation derived from the insight has been marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED insights can only be marked ACCEPTED (which may update state metadata). |
DISMISSED |
Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE. |
ListInsightsRequest
Request for the ListInsights
method.
Fields | |
---|---|
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/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.) |
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. |
page_token |
Optional. If present, retrieves the next batch of results from the preceding call to this method. |
filter |
Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" |
ListInsightsResponse
Response to the ListInsights
method.
Fields | |
---|---|
insights[] |
The set of insights for the |
next_page_token |
A token that can be used to request the next page of results. This field is empty if there are no additional results. |
ListRecommendationsRequest
Request for the ListRecommendations
method.
Fields | |
---|---|
parent |
Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders. |
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. |
page_token |
Optional. If present, retrieves the next batch of results from the preceding call to this method. |
filter |
Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" |
ListRecommendationsResponse
Response to the ListRecommendations
method.
Fields | |
---|---|
recommendations[] |
The set of recommendations for the |
next_page_token |
A token that can be used to request the next page of results. This field is empty if there are no additional results. |
MarkInsightAcceptedRequest
Request for the MarkInsightAccepted
method.
Fields | |
---|---|
name |
Required. Name of the insight. |
state_metadata |
Optional. State properties user wish to include with this state. Full replace of the current state_metadata. |
etag |
Required. Fingerprint of the Insight. Provides optimistic locking. |
MarkRecommendationClaimedRequest
Request for the MarkRecommendationClaimed
Method.
Fields | |
---|---|
name |
Required. Name of the recommendation. |
state_metadata |
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. |
MarkRecommendationFailedRequest
Request for the MarkRecommendationFailed
Method.
Fields | |
---|---|
name |
Required. Name of the recommendation. |
state_metadata |
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. |
MarkRecommendationSucceededRequest
Request for the MarkRecommendationSucceeded
Method.
Fields | |
---|---|
name |
Required. Name of the recommendation. |
state_metadata |
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. |
Operation
Contains an operation for a resource loosely based on the JSON-PATCH format with support for:
- Custom filters for describing partial array patch.
- Extended path values for describing nested arrays.
- Custom fields for describing the resource for which the operation is being described.
- Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
Fields | ||
---|---|---|
action |
Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. |
|
resource_type |
Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance |
|
resource |
Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. |
|
path |
Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated. |
|
source_resource |
Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = |
|
source_path |
Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types. |
|
path_filters |
Set of filters to apply if
|
|
path_value_matchers |
Similar to path_filters, this contains set of filters to apply if |
|
Union field path_value . One of the fields in the following block will be set and intend to describe a value for 'path' field. path_value can be only one of the following: |
||
value |
Value for the |
|
value_matcher |
Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or |
OperationGroup
Group of operations that need to be performed atomically.
Fields | |
---|---|
operations[] |
List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. |
Recommendation
A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc
Fields | |
---|---|
name |
Name of recommendation. |
description |
Free-form human readable summary in English. The maximum length is 500 characters. |
recommender_subtype |
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 Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" |
last_refresh_time |
Last time this recommendation was refreshed by the system that created it in the first place. |
primary_impact |
The primary impact that this recommendation can have while trying to optimize for one category. |
additional_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. |
content |
Content of the recommendation describing recommended changes to resources. |
state_info |
Information for state. Contains state and metadata. |
etag |
Fingerprint of the Recommendation. Provides optimistic locking when updating states. |
associated_insights[] |
Insights that led to this recommendation. |
InsightReference
Reference to an associated insight.
Fields | |
---|---|
insight |
Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] |
RecommendationContent
Contains what resources are changing and how they are changing.
Fields | |
---|---|
operation_groups[] |
Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order. |
RecommendationStateInfo
Information for state. Contains state and metadata.
Fields | |
---|---|
state |
The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. |
state_metadata |
A map of metadata for the state, provided by user or automations systems. |
State
Represents Recommendation State.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default state. Don't use directly. |
ACTIVE |
Recommendation is active and can be applied. Recommendations content can be updated by Google. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED. |
CLAIMED |
Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED. |
SUCCEEDED |
Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED. |
FAILED |
Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED. |
DISMISSED |
Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE. |
ValueMatcher
Contains various matching options for values for a GCP resource field.
Fields | |
---|---|
matches_pattern |
To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch |