{ "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "protocol": "rest", "fullyEncodeReservedExpansion": true, "discoveryVersion": "v1", "ownerName": "Google", "ownerDomain": "google.com", "parameters": { "callback": { "type": "string", "location": "query", "description": "JSONP" }, "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format." }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "type": "string", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" } }, "description": "", "version": "v1beta1", "version_module": true, "servicePath": "", "batchPath": "batch", "kind": "discovery#restDescription", "resources": { "billingAccounts": { "resources": { "locations": { "resources": { "recommenders": { "resources": { "recommendations": { "methods": { "get": { "id": "recommender.billingAccounts.locations.recommenders.recommendations.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path", "description": "Required. Name of the recommendation.", "required": true } }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "markClaimed": { "path": "v1beta1/{+name}:markClaimed", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest" }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.markClaimed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender." }, "list": { "id": "recommender.billingAccounts.locations.recommenders.recommendations.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "filter": { "type": "string", "description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "location": "query" }, "parent": { "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/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.", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+$", "location": "path", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query" } }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/recommendations" }, "markSucceeded": { "id": "recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$" } }, "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest" }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:markSucceeded" }, "markFailed": { "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest" }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:markFailed", "id": "recommender.billingAccounts.locations.recommenders.recommendations.markFailed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$" } } }, "markDismissed": { "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the recommendation.", "required": true, "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path", "type": "string" } }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.markDismissed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1beta1/{+name}:markDismissed", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest" }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "parameterOrder": [ "name" ] } } } }, "methods": { "updateConfig": { "httpMethod": "PATCH", "parameters": { "name": { "required": true, "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config", "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/config$" }, "validateOnly": { "type": "boolean", "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query" }, "updateMask": { "description": "The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "id": "recommender.billingAccounts.locations.recommenders.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Recommender Config. This will create a new revision of the config.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" } }, "getConfig": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`", "required": true, "type": "string", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "location": "path" } }, "id": "recommender.billingAccounts.locations.recommenders.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested Recommender Config. There is only one instance of the config for each Recommender." } } }, "insightTypes": { "methods": { "getConfig": { "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "recommender.billingAccounts.locations.insightTypes.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string" } } }, "updateConfig": { "id": "recommender.billingAccounts.locations.insightTypes.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an InsightTypeConfig change. This will create a new revision of the config.", "httpMethod": "PATCH", "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "description": "The list of fields to be updated.", "location": "query" }, "name": { "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string", "required": true, "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config" }, "validateOnly": { "location": "query", "description": "If true, validate the request and preview the change, but do not actually update it.", "type": "boolean" } }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "path": "v1beta1/{+name}" } }, "resources": { "insights": { "methods": { "list": { "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/insights", "id": "recommender.billingAccounts.locations.insightTypes.insights.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "parent": { "type": "string", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "location": "path", "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/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.", "required": true }, "pageSize": { "location": "query", "description": "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.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call." }, "filter": { "location": "query", "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "type": "string" } } }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the insight.", "required": true, "type": "string", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "location": "path" } }, "id": "recommender.billingAccounts.locations.insightTypes.insights.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type." }, "markAccepted": { "id": "recommender.billingAccounts.locations.insightTypes.insights.markAccepted", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the insight.", "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } }, "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest" }, "path": "v1beta1/{+name}:markAccepted" } } } } } }, "methods": { "list": { "path": "v1beta1/{+name}/locations", "flatPath": "v1beta1/billingAccounts/{billingAccountsId}/locations", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" }, "name": { "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+$", "required": true, "description": "The resource that owns the locations collection, if applicable." }, "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query" } }, "id": "recommender.billingAccounts.locations.list", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists locations with recommendations or insights." } } } } }, "insightTypes": { "methods": { "list": { "flatPath": "v1beta1/insightTypes", "parameterOrder": [], "path": "v1beta1/insightTypes", "id": "recommender.insightTypes.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListInsightTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists available InsightTypes. No IAM permissions are required.", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "description": "Optional. The number of InsightTypes to return per page. The service may return fewer than this value.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListRecommenders` call. Provide this to retrieve the subsequent page." } } } } }, "recommenders": { "methods": { "list": { "path": "v1beta1/recommenders", "flatPath": "v1beta1/recommenders", "parameterOrder": [], "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The number of RecommenderTypes to return per page. The service may return fewer than this value.", "location": "query" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListRecommenders` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "id": "recommender.recommenders.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListRecommendersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all available Recommenders. No IAM permissions are required." } } }, "organizations": { "resources": { "locations": { "methods": { "list": { "path": "v1beta1/{+name}/locations", "flatPath": "v1beta1/organizations/{organizationsId}/locations", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "The resource that owns the locations collection, if applicable.", "type": "string", "location": "path", "pattern": "^organizations/[^/]+$" }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "format": "int32" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query", "type": "string" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." } }, "id": "recommender.organizations.locations.list", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists locations with recommendations or insights." } }, "resources": { "recommenders": { "methods": { "updateConfig": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "required": true, "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config" }, "validateOnly": { "type": "boolean", "location": "query", "description": "If true, validate the request and preview the change, but do not actually update it." }, "updateMask": { "description": "The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "id": "recommender.organizations.locations.recommenders.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Recommender Config. This will create a new revision of the config." }, "getConfig": { "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$" } }, "id": "recommender.organizations.locations.recommenders.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested Recommender Config. There is only one instance of the config for each Recommender.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ] } }, "resources": { "recommendations": { "methods": { "list": { "httpMethod": "GET", "parameters": { "filter": { "type": "string", "location": "query", "description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)" }, "parent": { "required": true, "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/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.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "description": "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.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query" } }, "id": "recommender.organizations.locations.recommenders.recommendations.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "path": "v1beta1/{+parent}/recommendations", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "parameterOrder": [ "parent" ] }, "markSucceeded": { "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest" }, "path": "v1beta1/{+name}:markSucceeded", "id": "recommender.organizations.locations.recommenders.recommendations.markSucceeded", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the recommendation.", "required": true } } }, "markFailed": { "httpMethod": "POST", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "required": true, "description": "Required. Name of the recommendation." } }, "id": "recommender.organizations.locations.recommenders.recommendations.markFailed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1beta1/{+name}:markFailed", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest" } }, "markDismissed": { "id": "recommender.organizations.locations.recommenders.recommendations.markDismissed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path", "description": "Required. Name of the recommendation.", "required": true } }, "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest" }, "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:markDismissed" }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.organizations.locations.recommenders.recommendations.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender." }, "markClaimed": { "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the recommendation.", "required": true, "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path" } }, "id": "recommender.organizations.locations.recommenders.recommendations.markClaimed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "path": "v1beta1/{+name}:markClaimed", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest" }, "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "parameterOrder": [ "name" ] } } } } }, "insightTypes": { "resources": { "insights": { "methods": { "get": { "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "recommender.organizations.locations.insightTypes.insights.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the insight.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } } }, "markAccepted": { "path": "v1beta1/{+name}:markAccepted", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest" }, "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the insight.", "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$" } }, "id": "recommender.organizations.locations.insightTypes.insights.markAccepted", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." }, "list": { "id": "recommender.organizations.locations.insightTypes.insights.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "filter": { "location": "query", "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "type": "string" }, "parent": { "required": true, "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/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.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call." } }, "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/insights" } } } }, "methods": { "getConfig": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "location": "path", "type": "string" } }, "id": "recommender.organizations.locations.insightTypes.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType." }, "updateConfig": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "required": true, "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config" }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" } }, "id": "recommender.organizations.locations.insightTypes.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an InsightTypeConfig change. This will create a new revision of the config." } } } } } } }, "projects": { "resources": { "locations": { "resources": { "recommenders": { "methods": { "getConfig": { "id": "recommender.projects.locations.recommenders.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested Recommender Config. There is only one instance of the config for each Recommender.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "updateConfig": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "location": "path" }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "The list of fields to be updated.", "location": "query" } }, "id": "recommender.projects.locations.recommenders.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Recommender Config. This will create a new revision of the config." } }, "resources": { "recommendations": { "methods": { "get": { "id": "recommender.projects.locations.recommenders.recommendations.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the recommendation.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "markClaimed": { "path": "v1beta1/{+name}:markClaimed", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest" }, "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$" } }, "id": "recommender.projects.locations.recommenders.recommendations.markClaimed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender." }, "markFailed": { "id": "recommender.projects.locations.recommenders.recommendations.markFailed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the recommendation.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path" } }, "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:markFailed" }, "markDismissed": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.projects.locations.recommenders.recommendations.markDismissed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1beta1/{+name}:markDismissed", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest" } }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/recommendations", "id": "recommender.projects.locations.recommenders.recommendations.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "parent": { "required": true, "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "pageToken": { "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query", "type": "string" }, "filter": { "description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "location": "query", "type": "string" } } }, "markSucceeded": { "path": "v1beta1/{+name}:markSucceeded", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest" }, "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.projects.locations.recommenders.recommendations.markSucceeded", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." } } } } }, "insightTypes": { "methods": { "updateConfig": { "httpMethod": "PATCH", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "required": true, "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config" }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" }, "updateMask": { "description": "The list of fields to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "id": "recommender.projects.locations.insightTypes.updateConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an InsightTypeConfig change. This will create a new revision of the config.", "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ] }, "getConfig": { "id": "recommender.projects.locations.insightTypes.getConfig", "response": { "$ref": "GoogleCloudRecommenderV1beta1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" } }, "resources": { "insights": { "methods": { "list": { "id": "recommender.projects.locations.insightTypes.insights.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "filter": { "type": "string", "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "location": "query" }, "parent": { "required": true, "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "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." }, "pageToken": { "type": "string", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/insights" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "recommender.projects.locations.insightTypes.insights.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. Name of the insight.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } } }, "markAccepted": { "path": "v1beta1/{+name}:markAccepted", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest" }, "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "location": "path", "description": "Required. Name of the insight.", "required": true } }, "id": "recommender.projects.locations.insightTypes.insights.markAccepted", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." } } } } } }, "methods": { "list": { "path": "v1beta1/{+name}/locations", "flatPath": "v1beta1/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "extraLocationTypes": { "type": "string", "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "required": true, "pattern": "^projects/[^/]+$", "location": "path", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" } }, "id": "recommender.projects.locations.list", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists locations with recommendations or insights." } } } } }, "folders": { "resources": { "locations": { "resources": { "insightTypes": { "resources": { "insights": { "methods": { "get": { "id": "recommender.folders.locations.insightTypes.insights.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "required": true, "description": "Required. Name of the insight." } }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "markAccepted": { "path": "v1beta1/{+name}:markAccepted", "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest" }, "httpMethod": "POST", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the insight.", "required": true } }, "id": "recommender.folders.locations.insightTypes.insights.markAccepted", "response": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." }, "list": { "id": "recommender.folders.locations.insightTypes.insights.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "location": "path", "type": "string", "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` * `organizations/[ORGANIZATION_ID]/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.", "required": true }, "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query" }, "filter": { "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "location": "query", "type": "string" } }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/insights" } } } } }, "recommenders": { "resources": { "recommendations": { "methods": { "list": { "id": "recommender.folders.locations.recommenders.recommendations.list", "response": { "$ref": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "parent": { "required": true, "description": "Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/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.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", "location": "query" }, "filter": { "type": "string", "description": "Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)", "location": "query" } }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/recommendations" }, "markSucceeded": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.folders.locations.recommenders.recommendations.markSucceeded", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1beta1/{+name}:markSucceeded", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest" }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "parameterOrder": [ "name" ] }, "markFailed": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "Required. Name of the recommendation.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.folders.locations.recommenders.recommendations.markFailed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "path": "v1beta1/{+name}:markFailed", "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest" }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "parameterOrder": [ "name" ] }, "markDismissed": { "id": "recommender.folders.locations.recommenders.recommendations.markDismissed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the recommendation.", "required": true, "type": "string", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest" }, "path": "v1beta1/{+name}:markDismissed" }, "get": { "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "recommender.folders.locations.recommenders.recommendations.get", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "required": true, "description": "Required. Name of the recommendation." } } }, "markClaimed": { "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest" }, "path": "v1beta1/{+name}:markClaimed", "id": "recommender.folders.locations.recommenders.recommendations.markClaimed", "response": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "location": "path", "type": "string", "description": "Required. Name of the recommendation.", "required": true } } } } } } } }, "methods": { "list": { "id": "recommender.folders.locations.list", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists locations with recommendations or insights.", "httpMethod": "GET", "parameters": { "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "name": { "type": "string", "location": "path", "pattern": "^folders/[^/]+$", "required": true, "description": "The resource that owns the locations collection, if applicable." }, "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } }, "flatPath": "v1beta1/folders/{foldersId}/locations", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/locations" } } } } } }, "baseUrl": "https://recommender.googleapis.com/", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "schemas": { "GoogleCloudRecommenderV1beta1InsightRecommendationReference": { "id": "GoogleCloudRecommenderV1beta1InsightRecommendationReference", "description": "Reference to an associated recommendation.", "type": "object", "properties": { "recommendation": { "type": "string", "description": "Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]" } } }, "GoogleCloudLocationLocation": { "type": "object", "properties": { "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." } }, "id": "GoogleCloudLocationLocation", "description": "A resource that represents a Google Cloud location." }, "GoogleCloudRecommenderV1beta1ListInsightTypesResponse": { "type": "object", "properties": { "insightTypes": { "type": "array", "description": "The set of recommenders available", "items": { "$ref": "GoogleCloudRecommenderV1beta1InsightType" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudRecommenderV1beta1ListInsightTypesResponse", "description": "Response for the `ListInsightTypes` method. Next ID: 3" }, "GoogleCloudRecommenderV1beta1ListInsightsResponse": { "id": "GoogleCloudRecommenderV1beta1ListInsightsResponse", "description": "Response to the `ListInsights` method.", "type": "object", "properties": { "insights": { "items": { "$ref": "GoogleCloudRecommenderV1beta1Insight" }, "description": "The set of insights for the `parent` resource.", "type": "array" }, "nextPageToken": { "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" } } }, "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest": { "type": "object", "properties": { "stateMetadata": { "description": "Optional. State properties user wish to include with this state. Full replace of the current state_metadata.", "additionalProperties": { "type": "string" }, "type": "object" }, "etag": { "type": "string", "description": "Required. Fingerprint of the Insight. Provides optimistic locking." } }, "id": "GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest", "description": "Request for the `MarkInsightAccepted` method." }, "GoogleCloudRecommenderV1beta1RecommendationStateInfo": { "id": "GoogleCloudRecommenderV1beta1RecommendationStateInfo", "description": "Information for state. Contains state and metadata.", "type": "object", "properties": { "state": { "description": "The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.", "enumDescriptions": [ "Default state. Don't use directly.", "Recommendation is active and can be applied. Recommendations content can be updated by Google. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", "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.", "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or 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.", "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CLAIMED", "SUCCEEDED", "FAILED", "DISMISSED" ], "type": "string" }, "stateMetadata": { "description": "A map of metadata for the state, provided by user or automations systems.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudRecommenderV1beta1RecommenderConfig": { "id": "GoogleCloudRecommenderV1beta1RecommenderConfig", "description": "Configuration for a Recommender.", "type": "object", "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between." }, "recommenderGenerationConfig": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderGenerationConfig", "description": "RecommenderGenerationConfig which configures the Generation of recommendations for this recommender." }, "revisionId": { "type": "string", "description": "Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.", "readOnly": true }, "displayName": { "type": "string", "description": "A user-settable field to provide a human-readable name to be used in user interfaces." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Last time when the config was updated." }, "name": { "type": "string", "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config" }, "etag": { "description": "Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.", "type": "string" } } }, "GoogleCloudRecommenderV1beta1InsightTypeConfig": { "id": "GoogleCloudRecommenderV1beta1InsightTypeConfig", "description": "Configuration for an InsightType.", "type": "object", "properties": { "annotations": { "description": "Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.", "type": "object", "additionalProperties": { "type": "string" } }, "insightTypeGenerationConfig": { "description": "InsightTypeGenerationConfig which configures the generation of insights for this insight type.", "$ref": "GoogleCloudRecommenderV1beta1InsightTypeGenerationConfig" }, "revisionId": { "type": "string", "description": "Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.", "readOnly": true }, "displayName": { "description": "A user-settable field to provide a human-readable name to be used in user interfaces.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config" }, "etag": { "description": "Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.", "type": "string" }, "updateTime": { "description": "Last time when the config was updated.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudRecommenderV1beta1Insight": { "id": "GoogleCloudRecommenderV1beta1Insight", "description": "An insight along with the information used to derive the insight. The insight may have associated recommendations as well.", "type": "object", "properties": { "targetResources": { "type": "array", "items": { "type": "string" }, "description": "Fully qualified resource names that this insight is targeting." }, "severity": { "description": "Insight's severity.", "type": "string", "enumDescriptions": [ "Insight has unspecified severity.", "Insight has low severity.", "Insight has medium severity.", "Insight has high severity.", "Insight has critical severity." ], "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "observationPeriod": { "type": "string", "format": "google-duration", "description": "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)." }, "insightSubtype": { "description": "Insight subtype. Insight content schema will be stable for a given subtype.", "type": "string" }, "stateInfo": { "description": "Information state and metadata.", "$ref": "GoogleCloudRecommenderV1beta1InsightStateInfo" }, "etag": { "description": "Fingerprint of the Insight. Provides optimistic locking when updating states.", "type": "string" }, "content": { "description": "A struct of custom fields to explain the insight. Example: \"grantedPermissionsCount\": \"1000\"", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "lastRefreshTime": { "format": "google-datetime", "type": "string", "description": "Timestamp of the latest data used to generate the insight." }, "associatedRecommendations": { "items": { "$ref": "GoogleCloudRecommenderV1beta1InsightRecommendationReference" }, "description": "Recommendations derived from this insight.", "type": "array" }, "category": { "description": "Category being targeted by the insight.", "type": "string", "enumDescriptions": [ "Unspecified category.", "The insight is related to cost.", "The insight is related to security.", "The insight is related to performance.", "This insight is related to manageability.", "The insight is related to sustainability.", "The insight is related to reliability." ], "enum": [ "CATEGORY_UNSPECIFIED", "COST", "SECURITY", "PERFORMANCE", "MANAGEABILITY", "SUSTAINABILITY", "RELIABILITY" ] }, "name": { "description": "Identifier. Name of the insight.", "type": "string" }, "description": { "type": "string", "description": "Free-form human readable summary in English. The maximum length is 500 characters." } } }, "GoogleCloudLocationListLocationsResponse": { "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "id": "GoogleCloudLocationListLocationsResponse", "description": "The response message for Locations.ListLocations." }, "GoogleCloudRecommenderV1beta1InsightStateInfo": { "type": "object", "properties": { "state": { "description": "Insight state.", "type": "string", "enumDescriptions": [ "Unspecified state.", "Insight is active. Content for ACTIVE insights can be updated by Google. ACTIVE insights can be marked DISMISSED OR 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).", "Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "ACCEPTED", "DISMISSED" ] }, "stateMetadata": { "description": "A map of metadata for the state, provided by user or automations systems.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "GoogleCloudRecommenderV1beta1InsightStateInfo", "description": "Information related to insight state." }, "GoogleCloudRecommenderV1beta1ListRecommendationsResponse": { "type": "object", "properties": { "recommendations": { "type": "array", "description": "The set of recommendations for the `parent` resource.", "items": { "$ref": "GoogleCloudRecommenderV1beta1Recommendation" } }, "nextPageToken": { "description": "A token that can be used to request the next page of results. This field is empty if there are no additional results.", "type": "string" } }, "id": "GoogleCloudRecommenderV1beta1ListRecommendationsResponse", "description": "Response to the `ListRecommendations` method." }, "GoogleCloudRecommenderV1beta1ListRecommendersResponse": { "id": "GoogleCloudRecommenderV1beta1ListRecommendersResponse", "description": "Response for the `ListRecommender` method. Next ID: 3", "type": "object", "properties": { "recommenders": { "items": { "$ref": "GoogleCloudRecommenderV1beta1RecommenderType" }, "description": "The set of recommenders available", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest": { "type": "object", "properties": { "stateMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`." }, "etag": { "description": "Required. Fingerprint of the Recommendation. Provides optimistic locking.", "type": "string" } }, "id": "GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest", "description": "Request for the `MarkRecommendationClaimed` Method." }, "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest": { "id": "GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest", "description": "Request for the `MarkRecommendationSucceeded` Method.", "type": "object", "properties": { "stateMetadata": { "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.", "type": "object", "additionalProperties": { "type": "string" } }, "etag": { "type": "string", "description": "Required. Fingerprint of the Recommendation. Provides optimistic locking." } } }, "GoogleCloudRecommenderV1beta1RecommenderType": { "id": "GoogleCloudRecommenderV1beta1RecommenderType", "description": "The type of a recommender.", "type": "object", "properties": { "name": { "description": "The recommender's name in format RecommenderTypes/{recommender_type} eg: recommenderTypes/google.iam.policy.Recommender", "type": "string" } } }, "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest": { "id": "GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest", "description": "Request for the `MarkRecommendationFailed` Method.", "type": "object", "properties": { "stateMetadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`." }, "etag": { "description": "Required. Fingerprint of the Recommendation. Provides optimistic locking.", "type": "string" } } }, "GoogleCloudRecommenderV1beta1RecommenderGenerationConfig": { "id": "GoogleCloudRecommenderV1beta1RecommenderGenerationConfig", "description": "A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.", "type": "object", "properties": { "params": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes." } } }, "GoogleCloudRecommenderV1beta1RecommendationContent": { "id": "GoogleCloudRecommenderV1beta1RecommendationContent", "description": "Contains what resources are changing and how they are changing.", "type": "object", "properties": { "overview": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Condensed overview information about the recommendation." }, "operationGroups": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudRecommenderV1beta1OperationGroup" } } } }, "GoogleTypeMoney": { "id": "GoogleTypeMoney", "description": "Represents an amount of money with its currency type.", "type": "object", "properties": { "units": { "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "type": "string", "format": "int64" }, "currencyCode": { "type": "string", "description": "The three-letter currency code defined in ISO 4217." }, "nanos": { "type": "integer", "format": "int32", "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000." } } }, "GoogleCloudRecommenderV1beta1Recommendation": { "type": "object", "properties": { "recommenderSubtype": { "description": "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\"", "type": "string" }, "targetResources": { "description": "Fully qualified resource names that this recommendation is targeting.", "items": { "type": "string" }, "type": "array" }, "primaryImpact": { "$ref": "GoogleCloudRecommenderV1beta1Impact", "description": "The primary impact that this recommendation can have while trying to optimize for one category." }, "priority": { "type": "string", "enumDescriptions": [ "Recommendation has unspecified priority.", "Recommendation has P4 priority (lowest priority).", "Recommendation has P3 priority (second lowest priority).", "Recommendation has P2 priority (second highest priority).", "Recommendation has P1 priority (highest priority)." ], "enum": [ "PRIORITY_UNSPECIFIED", "P4", "P3", "P2", "P1" ], "description": "Recommendation's priority." }, "stateInfo": { "$ref": "GoogleCloudRecommenderV1beta1RecommendationStateInfo", "description": "Information for state. Contains state and metadata." }, "associatedInsights": { "type": "array", "description": "Insights that led to this recommendation.", "items": { "$ref": "GoogleCloudRecommenderV1beta1RecommendationInsightReference" } }, "etag": { "description": "Fingerprint of the Recommendation. Provides optimistic locking when updating states.", "type": "string" }, "description": { "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Name of recommendation." }, "additionalImpact": { "type": "array", "items": { "$ref": "GoogleCloudRecommenderV1beta1Impact" }, "description": "Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative." }, "xorGroupId": { "type": "string", "description": "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." }, "lastRefreshTime": { "type": "string", "format": "google-datetime", "description": "Last time this recommendation was refreshed by the system that created it in the first place." }, "content": { "description": "Content of the recommendation describing recommended changes to resources.", "$ref": "GoogleCloudRecommenderV1beta1RecommendationContent" } }, "id": "GoogleCloudRecommenderV1beta1Recommendation", "description": "A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc" }, "GoogleCloudRecommenderV1beta1ValueMatcher": { "type": "object", "properties": { "matchesPattern": { "description": "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", "type": "string" } }, "id": "GoogleCloudRecommenderV1beta1ValueMatcher", "description": "Contains various matching options for values for a GCP resource field." }, "GoogleCloudRecommenderV1beta1RecommendationInsightReference": { "id": "GoogleCloudRecommenderV1beta1RecommendationInsightReference", "description": "Reference to an associated insight.", "type": "object", "properties": { "insight": { "description": "Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", "type": "string" } } }, "GoogleCloudRecommenderV1beta1InsightTypeGenerationConfig": { "id": "GoogleCloudRecommenderV1beta1InsightTypeGenerationConfig", "description": "A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight.", "type": "object", "properties": { "params": { "description": "Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } }, "GoogleCloudRecommenderV1beta1SecurityProjection": { "id": "GoogleCloudRecommenderV1beta1SecurityProjection", "description": "Contains various ways of describing the impact on Security.", "type": "object", "properties": { "details": { "description": "This field can be used by the recommender to define details specific to security impact.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } } }, "GoogleCloudRecommenderV1beta1OperationGroup": { "type": "object", "properties": { "operations": { "type": "array", "items": { "$ref": "GoogleCloudRecommenderV1beta1Operation" }, "description": "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." } }, "id": "GoogleCloudRecommenderV1beta1OperationGroup", "description": "Group of operations that need to be performed atomically." }, "GoogleCloudRecommenderV1beta1InsightType": { "type": "object", "properties": { "name": { "type": "string", "description": "The insight_type's name in format insightTypes/{insight_type} eg: insightTypes/google.iam.policy.Insight" } }, "id": "GoogleCloudRecommenderV1beta1InsightType", "description": "The type of insight." }, "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest": { "type": "object", "properties": { "etag": { "type": "string", "description": "Fingerprint of the Recommendation. Provides optimistic locking." } }, "id": "GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest", "description": "Request for the `MarkRecommendationDismissed` Method." }, "GoogleCloudRecommenderV1beta1Operation": { "id": "GoogleCloudRecommenderV1beta1Operation", "description": "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.", "type": "object", "properties": { "sourcePath": { "type": "string", "description": "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." }, "action": { "type": "string", "description": "Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and 'custom' operations. This field is case-insensitive and always populated." }, "sourceResource": { "description": "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 = and resource_name = . This field is empty for all other values of `action`.", "type": "string" }, "pathFilters": { "description": "Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: ``` { \"/versions/*/name\" : \"it-123\" \"/versions/*/targetSize/percent\": 20 } ``` * Example: ``` { \"/bindings/*/role\": \"roles/owner\" \"/bindings/*/condition\" : null } ``` * Example: ``` { \"/bindings/*/role\": \"roles/owner\" \"/bindings/*/members/*\" : [\"x@example.com\", \"y@example.com\"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "additionalProperties": { "type": "any" }, "type": "object" }, "pathValueMatchers": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudRecommenderV1beta1ValueMatcher" }, "description": "Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed." }, "resource": { "description": "Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.", "type": "string" }, "resourceType": { "type": "string", "description": "Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance" }, "value": { "description": "Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.", "type": "any" }, "valueMatcher": { "description": "Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.", "$ref": "GoogleCloudRecommenderV1beta1ValueMatcher" }, "path": { "type": "string", "description": "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." } } }, "GoogleCloudRecommenderV1beta1SustainabilityProjection": { "id": "GoogleCloudRecommenderV1beta1SustainabilityProjection", "description": "Contains metadata about how much sustainability a recommendation can save or incur.", "type": "object", "properties": { "kgCO2e": { "type": "number", "format": "double", "description": "Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e)." }, "duration": { "description": "Duration for which this sustanability applies.", "format": "google-duration", "type": "string" } } }, "GoogleCloudRecommenderV1beta1Impact": { "id": "GoogleCloudRecommenderV1beta1Impact", "description": "Contains the impact a recommendation can have for a given category.", "type": "object", "properties": { "costProjection": { "$ref": "GoogleCloudRecommenderV1beta1CostProjection", "description": "Use with CategoryType.COST" }, "sustainabilityProjection": { "$ref": "GoogleCloudRecommenderV1beta1SustainabilityProjection", "description": "Use with CategoryType.SUSTAINABILITY" }, "securityProjection": { "$ref": "GoogleCloudRecommenderV1beta1SecurityProjection", "description": "Use with CategoryType.SECURITY" }, "category": { "description": "Category that is being targeted.", "enumDescriptions": [ "Default unspecified category. Don't use directly.", "Indicates a potential increase or decrease in cost.", "Indicates a potential increase or decrease in security.", "Indicates a potential increase or decrease in performance.", "Indicates a potential increase or decrease in manageability.", "Indicates a potential increase or decrease in sustainability.", "Indicates a potential increase or decrease in reliability." ], "enum": [ "CATEGORY_UNSPECIFIED", "COST", "SECURITY", "PERFORMANCE", "MANAGEABILITY", "SUSTAINABILITY", "RELIABILITY" ], "type": "string" }, "reliabilityProjection": { "description": "Use with CategoryType.RELIABILITY", "$ref": "GoogleCloudRecommenderV1beta1ReliabilityProjection" }, "service": { "type": "string", "description": "The service that this impact is associated with." } } }, "GoogleCloudRecommenderV1beta1ReliabilityProjection": { "id": "GoogleCloudRecommenderV1beta1ReliabilityProjection", "description": "Contains information on the impact of a reliability recommendation.", "type": "object", "properties": { "risks": { "description": "Reliability risks mitigated by this recommendation.", "items": { "type": "string", "enumDescriptions": [ "Default unspecified risk. Don't use directly.", "Potential service downtime.", "Potential data loss.", "Potential access denial. The service is still up but some or all clients can't access it." ], "enum": [ "RISK_TYPE_UNSPECIFIED", "SERVICE_DISRUPTION", "DATA_LOSS", "ACCESS_DENY" ] }, "type": "array" }, "details": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Per-recommender projection." } } }, "GoogleCloudRecommenderV1beta1CostProjection": { "id": "GoogleCloudRecommenderV1beta1CostProjection", "description": "Contains metadata about how much money a recommendation can save or incur.", "type": "object", "properties": { "pricingType": { "type": "string", "enumDescriptions": [ "Default pricing type.", "The price listed by GCP for all customers.", "A price derived from past usage and billing." ], "enum": [ "PRICING_TYPE_UNSPECIFIED", "LIST_PRICE", "CUSTOM_PRICE" ], "description": "How the cost is calculated." }, "cost": { "description": "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. A user's permissions may affect whether the cost is computed using list prices or custom contract prices.", "$ref": "GoogleTypeMoney" }, "costInLocalCurrency": { "description": "The approximate cost savings in the billing account's local currency.", "$ref": "GoogleTypeMoney" }, "duration": { "description": "Duration for which this cost applies.", "format": "google-duration", "type": "string" } } } }, "basePath": "", "canonicalName": "Recommender", "title": "Recommender API", "id": "recommender:v1beta1", "rootUrl": "https://recommender.googleapis.com/", "mtlsRootUrl": "https://recommender.mtls.googleapis.com/", "documentationLink": "https://cloud.google.com/recommender/docs/", "name": "recommender", "revision": "20260607" }