{ "baseUrl": "https://recommender.googleapis.com/", "name": "recommender", "documentationLink": "https://cloud.google.com/recommender/docs/", "revision": "20260607", "basePath": "", "schemas": { "GoogleCloudRecommenderV1RecommenderGenerationConfig": { "properties": { "params": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.", "type": "object" } }, "id": "GoogleCloudRecommenderV1RecommenderGenerationConfig", "description": "A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.", "type": "object" }, "GoogleCloudRecommenderV1ListInsightsResponse": { "type": "object", "id": "GoogleCloudRecommenderV1ListInsightsResponse", "description": "Response to the `ListInsights` method.", "properties": { "insights": { "description": "The set of insights for the `parent` resource.", "items": { "$ref": "GoogleCloudRecommenderV1Insight" }, "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" } } }, "GoogleCloudRecommenderV1Recommendation": { "properties": { "associatedInsights": { "type": "array", "description": "Insights that led to this recommendation.", "items": { "$ref": "GoogleCloudRecommenderV1RecommendationInsightReference" } }, "description": { "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "content": { "$ref": "GoogleCloudRecommenderV1RecommendationContent", "description": "Content of the recommendation describing recommended changes to resources." }, "xorGroupId": { "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.", "type": "string" }, "priority": { "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)." ], "description": "Recommendation's priority.", "enum": [ "PRIORITY_UNSPECIFIED", "P4", "P3", "P2", "P1" ], "type": "string" }, "etag": { "description": "Fingerprint of the Recommendation. Provides optimistic locking when updating states.", "type": "string" }, "name": { "description": "Identifier. Name of recommendation.", "type": "string" }, "lastRefreshTime": { "description": "Last time this recommendation was refreshed by the system that created it in the first place.", "type": "string", "format": "google-datetime" }, "additionalImpact": { "type": "array", "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.", "items": { "$ref": "GoogleCloudRecommenderV1Impact" } }, "stateInfo": { "description": "Information for state. Contains state and metadata.", "$ref": "GoogleCloudRecommenderV1RecommendationStateInfo" }, "primaryImpact": { "description": "The primary impact that this recommendation can have while trying to optimize for one category.", "$ref": "GoogleCloudRecommenderV1Impact" }, "targetResources": { "type": "array", "description": "Fully qualified resource names that this recommendation is targeting.", "items": { "type": "string" } }, "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" } }, "id": "GoogleCloudRecommenderV1Recommendation", "description": "A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc", "type": "object" }, "GoogleCloudRecommenderV1ValueMatcher": { "id": "GoogleCloudRecommenderV1ValueMatcher", "description": "Contains various matching options for values for a GCP resource field.", "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" } }, "type": "object" }, "GoogleCloudRecommenderV1SecurityProjection": { "type": "object", "id": "GoogleCloudRecommenderV1SecurityProjection", "description": "Contains various ways of describing the impact on Security.", "properties": { "details": { "description": "Additional security impact details that is provided by the recommender.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } } }, "GoogleCloudRecommenderV1OperationGroup": { "type": "object", "properties": { "operations": { "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.", "items": { "$ref": "GoogleCloudRecommenderV1Operation" }, "type": "array" } }, "id": "GoogleCloudRecommenderV1OperationGroup", "description": "Group of operations that need to be performed atomically." }, "GoogleCloudRecommenderV1Insight": { "type": "object", "id": "GoogleCloudRecommenderV1Insight", "description": "An insight along with the information used to derive the insight. The insight may have associated recommendations as well.", "properties": { "targetResources": { "type": "array", "description": "Fully qualified resource names that this insight is targeting.", "items": { "type": "string" } }, "content": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "A struct of custom fields to explain the insight. Example: \"grantedPermissionsCount\": \"1000\"", "type": "object" }, "severity": { "type": "string", "description": "Insight's severity.", "enum": [ "SEVERITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "enumDescriptions": [ "Insight has unspecified severity.", "Insight has low severity.", "Insight has medium severity.", "Insight has high severity.", "Insight has critical severity." ] }, "insightSubtype": { "description": "Insight subtype. Insight content schema will be stable for a given subtype.", "type": "string" }, "etag": { "description": "Fingerprint of the Insight. Provides optimistic locking when updating states.", "type": "string" }, "lastRefreshTime": { "format": "google-datetime", "type": "string", "description": "Timestamp of the latest data used to generate the insight." }, "name": { "description": "Identifier. Name of the insight.", "type": "string" }, "associatedRecommendations": { "description": "Recommendations derived from this insight.", "items": { "$ref": "GoogleCloudRecommenderV1InsightRecommendationReference" }, "type": "array" }, "stateInfo": { "$ref": "GoogleCloudRecommenderV1InsightStateInfo", "description": "Information state and metadata." }, "category": { "type": "string", "description": "Category being targeted by the insight.", "enum": [ "CATEGORY_UNSPECIFIED", "COST", "SECURITY", "PERFORMANCE", "MANAGEABILITY", "SUSTAINABILITY", "RELIABILITY" ], "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.", "This insight is related to reliability." ] }, "description": { "description": "Free-form human readable summary in English. The maximum length is 500 characters.", "type": "string" }, "observationPeriod": { "format": "google-duration", "type": "string", "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)." } } }, "GoogleCloudRecommenderV1RecommendationStateInfo": { "properties": { "state": { "type": "string", "description": "The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CLAIMED", "SUCCEEDED", "FAILED", "DISMISSED" ], "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." ] }, "stateMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of metadata for the state, provided by user or automations systems." } }, "id": "GoogleCloudRecommenderV1RecommendationStateInfo", "description": "Information for state. Contains state and metadata.", "type": "object" }, "GoogleCloudRecommenderV1ListRecommendationsResponse": { "type": "object", "id": "GoogleCloudRecommenderV1ListRecommendationsResponse", "description": "Response to the `ListRecommendations` method.", "properties": { "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" }, "recommendations": { "description": "The set of recommendations for the `parent` resource.", "items": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "type": "array" } } }, "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest": { "type": "object", "properties": { "stateMetadata": { "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}$/`.", "type": "object" }, "etag": { "description": "Required. Fingerprint of the Recommendation. Provides optimistic locking.", "type": "string" } }, "id": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest", "description": "Request for the `MarkRecommendationSucceeded` Method." }, "GoogleCloudRecommenderV1MarkInsightAcceptedRequest": { "id": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest", "description": "Request for the `MarkInsightAccepted` method.", "properties": { "stateMetadata": { "type": "object", "description": "Optional. State properties user wish to include with this state. Full replace of the current state_metadata.", "additionalProperties": { "type": "string" } }, "etag": { "description": "Required. Fingerprint of the Insight. Provides optimistic locking.", "type": "string" } }, "type": "object" }, "GoogleTypeMoney": { "type": "object", "properties": { "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { "format": "int32", "type": "integer", "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." }, "units": { "format": "int64", "type": "string", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar." } }, "id": "GoogleTypeMoney", "description": "Represents an amount of money with its currency type." }, "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest": { "type": "object", "id": "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest", "description": "Request for the `MarkRecommendationDismissed` Method.", "properties": { "etag": { "description": "Fingerprint of the Recommendation. Provides optimistic locking.", "type": "string" } } }, "GoogleCloudRecommenderV1SustainabilityProjection": { "properties": { "kgCO2e": { "description": "Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e).", "type": "number", "format": "double" }, "duration": { "description": "Duration for which this sustainability applies.", "type": "string", "format": "google-duration" } }, "id": "GoogleCloudRecommenderV1SustainabilityProjection", "description": "Contains metadata about how much sustainability a recommendation can save or incur.", "type": "object" }, "GoogleCloudRecommenderV1RecommendationContent": { "type": "object", "properties": { "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": "GoogleCloudRecommenderV1OperationGroup" } }, "overview": { "type": "object", "description": "Condensed overview information about the recommendation.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "GoogleCloudRecommenderV1RecommendationContent", "description": "Contains what resources are changing and how they are changing." }, "GoogleCloudRecommenderV1CostProjection": { "properties": { "costInLocalCurrency": { "$ref": "GoogleTypeMoney", "description": "The approximate cost savings in the billing account's local currency." }, "cost": { "$ref": "GoogleTypeMoney", "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." }, "duration": { "format": "google-duration", "type": "string", "description": "Duration for which this cost applies." } }, "id": "GoogleCloudRecommenderV1CostProjection", "description": "Contains metadata about how much money a recommendation can save or incur.", "type": "object" }, "GoogleCloudRecommenderV1MarkRecommendationFailedRequest": { "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}$/`.", "additionalProperties": { "type": "string" }, "type": "object" }, "etag": { "description": "Required. Fingerprint of the Recommendation. Provides optimistic locking.", "type": "string" } }, "id": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest", "description": "Request for the `MarkRecommendationFailed` Method." }, "GoogleCloudRecommenderV1ReliabilityProjection": { "type": "object", "properties": { "risks": { "description": "Reliability risks mitigated by this recommendation.", "items": { "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": "string" }, "type": "array" }, "details": { "type": "object", "description": "Per-recommender projection.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "GoogleCloudRecommenderV1ReliabilityProjection", "description": "Contains information on the impact of a reliability recommendation." }, "GoogleCloudRecommenderV1InsightTypeGenerationConfig": { "type": "object", "properties": { "params": { "description": "Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "id": "GoogleCloudRecommenderV1InsightTypeGenerationConfig", "description": "A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight." }, "GoogleCloudRecommenderV1Impact": { "properties": { "service": { "description": "The service that this impact is associated with.", "type": "string" }, "costProjection": { "$ref": "GoogleCloudRecommenderV1CostProjection", "description": "Use with CategoryType.COST" }, "securityProjection": { "$ref": "GoogleCloudRecommenderV1SecurityProjection", "description": "Use with CategoryType.SECURITY" }, "sustainabilityProjection": { "description": "Use with CategoryType.SUSTAINABILITY", "$ref": "GoogleCloudRecommenderV1SustainabilityProjection" }, "category": { "type": "string", "description": "Category that is being targeted.", "enum": [ "CATEGORY_UNSPECIFIED", "COST", "SECURITY", "PERFORMANCE", "MANAGEABILITY", "SUSTAINABILITY", "RELIABILITY" ], "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." ] }, "reliabilityProjection": { "description": "Use with CategoryType.RELIABILITY", "$ref": "GoogleCloudRecommenderV1ReliabilityProjection" } }, "id": "GoogleCloudRecommenderV1Impact", "description": "Contains the impact a recommendation can have for a given category.", "type": "object" }, "GoogleCloudRecommenderV1Operation": { "type": "object", "properties": { "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" }, "sourcePath": { "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.", "type": "string" }, "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" }, "resourceType": { "description": "Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance", "type": "string" }, "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": "GoogleCloudRecommenderV1ValueMatcher" }, "path": { "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.", "type": "string" }, "action": { "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.", "type": "string" }, "pathValueMatchers": { "type": "object", "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.", "additionalProperties": { "$ref": "GoogleCloudRecommenderV1ValueMatcher" } }, "pathFilters": { "type": "object", "additionalProperties": { "type": "any" }, "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." }, "resource": { "description": "Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.", "type": "string" } }, "id": "GoogleCloudRecommenderV1Operation", "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." }, "GoogleCloudRecommenderV1RecommendationInsightReference": { "properties": { "insight": { "description": "Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]", "type": "string" } }, "id": "GoogleCloudRecommenderV1RecommendationInsightReference", "description": "Reference to an associated insight.", "type": "object" }, "GoogleCloudRecommenderV1InsightRecommendationReference": { "properties": { "recommendation": { "description": "Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]", "type": "string" } }, "id": "GoogleCloudRecommenderV1InsightRecommendationReference", "description": "Reference to an associated recommendation.", "type": "object" }, "GoogleCloudRecommenderV1InsightTypeConfig": { "id": "GoogleCloudRecommenderV1InsightTypeConfig", "description": "Configuration for an InsightType.", "properties": { "insightTypeGenerationConfig": { "$ref": "GoogleCloudRecommenderV1InsightTypeGenerationConfig", "description": "InsightTypeGenerationConfig which configures the generation of insights for this insight type." }, "name": { "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config", "type": "string" }, "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "etag": { "description": "Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.", "type": "string" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Last time when the config was updated." }, "revisionId": { "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, "type": "string" }, "displayName": { "description": "A user-settable field to provide a human-readable name to be used in user interfaces.", "type": "string" } }, "type": "object" }, "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest": { "id": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest", "description": "Request for the `MarkRecommendationClaimed` Method.", "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" } }, "type": "object" }, "GoogleCloudRecommenderV1RecommenderConfig": { "type": "object", "id": "GoogleCloudRecommenderV1RecommenderConfig", "description": "Configuration for a Recommender.", "properties": { "recommenderGenerationConfig": { "description": "RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.", "$ref": "GoogleCloudRecommenderV1RecommenderGenerationConfig" }, "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." }, "name": { "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config", "type": "string" }, "displayName": { "description": "A user-settable field to provide a human-readable name to be used in user interfaces.", "type": "string" }, "etag": { "description": "Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.", "type": "string" }, "updateTime": { "description": "Last time when the config was updated.", "format": "google-datetime", "type": "string" }, "revisionId": { "readOnly": true, "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.", "type": "string" } } }, "GoogleCloudRecommenderV1InsightStateInfo": { "type": "object", "properties": { "state": { "description": "Insight state.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "ACCEPTED", "DISMISSED" ], "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." ], "type": "string" }, "stateMetadata": { "description": "A map of metadata for the state, provided by user or automations systems.", "additionalProperties": { "type": "string" }, "type": "object" } }, "id": "GoogleCloudRecommenderV1InsightStateInfo", "description": "Information related to insight state." } }, "version_module": true, "description": "", "resources": { "folders": { "resources": { "locations": { "resources": { "recommenders": { "resources": { "recommendations": { "methods": { "markDismissed": { "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.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the recommendation.", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "id": "recommender.folders.locations.recommenders.recommendations.markDismissed", "path": "v1/{+name}:markDismissed" }, "markFailed": { "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.folders.locations.recommenders.recommendations.markFailed", "path": "v1/{+name}:markFailed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "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.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed" }, "get": { "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.folders.locations.recommenders.recommendations.get", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } } }, "markClaimed": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "description": "Required. Name of the recommendation." } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:markClaimed", "id": "recommender.folders.locations.recommenders.recommendations.markClaimed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" } }, "markSucceeded": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "path": "v1/{+name}:markSucceeded", "id": "recommender.folders.locations.recommenders.recommendations.markSucceeded", "parameters": { "name": { "description": "Required. Name of the recommendation.", "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" }, "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" }, "id": "recommender.folders.locations.recommenders.recommendations.list", "path": "v1/{+parent}/recommendations", "parameterOrder": [ "parent" ], "parameters": { "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." }, "parent": { "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string", "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, "location": "path" }, "pageSize": { "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", "type": "integer", "format": "int32" }, "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" } } } } } } }, "insightTypes": { "resources": { "insights": { "methods": { "get": { "path": "v1/{+name}", "id": "recommender.folders.locations.insightTypes.insights.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the insight.", "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "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." }, "parent": { "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.", "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "type": "string", "location": "path", "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.", "format": "int32", "type": "integer" }, "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" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/insights", "id": "recommender.folders.locations.insightTypes.insights.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type." }, "markAccepted": { "request": { "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" }, "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "description": "Required. Name of the insight.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:markAccepted", "id": "recommender.folders.locations.insightTypes.insights.markAccepted", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "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." } } } } } } } } }, "projects": { "resources": { "locations": { "resources": { "recommenders": { "methods": { "getConfig": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string", "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, "location": "path" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "id": "recommender.projects.locations.recommenders.getConfig", "path": "v1/{+name}", "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config" }, "updateConfig": { "description": "Updates a Recommender Config. This will create a new revision of the config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.projects.locations.recommenders.updateConfig", "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "request": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "parameterOrder": [ "name" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "The list of fields to be updated.", "location": "query" }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string", "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config" }, "validateOnly": { "type": "boolean", "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query" } } } }, "resources": { "recommendations": { "methods": { "list": { "parameterOrder": [ "parent" ], "parameters": { "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.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string", "location": "path", "required": true }, "pageSize": { "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", "type": "integer", "format": "int32" }, "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" }, "pageToken": { "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.", "type": "string" } }, "id": "recommender.projects.locations.recommenders.recommendations.list", "path": "v1/{+parent}/recommendations", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" }, "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations" }, "markDismissed": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "path": "v1/{+name}:markDismissed", "id": "recommender.projects.locations.recommenders.recommendations.markDismissed", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest" } }, "markFailed": { "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.projects.locations.recommenders.recommendations.markFailed", "path": "v1/{+name}:markFailed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" } }, "get": { "parameters": { "name": { "description": "Required. Name of the recommendation.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "recommender.projects.locations.recommenders.recommendations.get", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender." }, "markClaimed": { "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" }, "parameters": { "name": { "description": "Required. Name of the recommendation.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:markClaimed", "id": "recommender.projects.locations.recommenders.recommendations.markClaimed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender." }, "markSucceeded": { "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}:markSucceeded", "id": "recommender.projects.locations.recommenders.recommendations.markSucceeded", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "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": { "resources": { "insights": { "methods": { "list": { "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "parameterOrder": [ "parent" ], "parameters": { "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" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "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." }, "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.", "format": "int32", "type": "integer" }, "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" } }, "id": "recommender.projects.locations.insightTypes.insights.list", "path": "v1/{+parent}/insights", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" } }, "markAccepted": { "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.projects.locations.insightTypes.insights.markAccepted", "path": "v1/{+name}:markAccepted", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "request": { "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. Name of the insight.", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "location": "path", "required": true } } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "path": "v1/{+name}", "id": "recommender.projects.locations.insightTypes.insights.get", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the insight.", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ] } } } }, "methods": { "getConfig": { "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string", "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`" } }, "id": "recommender.projects.locations.insightTypes.getConfig", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config" }, "updateConfig": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "path": "v1/{+name}", "id": "recommender.projects.locations.insightTypes.updateConfig", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "The list of fields to be updated.", "location": "query" }, "name": { "location": "path", "required": true, "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config", "pattern": "^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string" }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "description": "Updates an InsightTypeConfig change. This will create a new revision of the config.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } }, "billingAccounts": { "resources": { "locations": { "resources": { "insightTypes": { "resources": { "insights": { "methods": { "get": { "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "id": "recommender.billingAccounts.locations.insightTypes.insights.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the insight.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string" } } }, "list": { "parameters": { "pageToken": { "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.", "type": "string" }, "parent": { "location": "path", "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.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "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" }, "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" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/insights", "id": "recommender.billingAccounts.locations.insightTypes.insights.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type." }, "markAccepted": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "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.", "parameters": { "name": { "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "description": "Required. Name of the insight.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "path": "v1/{+name}:markAccepted", "id": "recommender.billingAccounts.locations.insightTypes.insights.markAccepted" } } } }, "methods": { "getConfig": { "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.billingAccounts.locations.insightTypes.getConfig", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string", "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`" } } }, "updateConfig": { "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "description": "Updates an InsightTypeConfig change. This will create a new revision of the config.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "recommender.billingAccounts.locations.insightTypes.updateConfig", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "request": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "parameters": { "updateMask": { "location": "query", "description": "The list of fields to be updated.", "format": "google-fieldmask", "type": "string" }, "name": { "location": "path", "required": true, "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string" }, "validateOnly": { "type": "boolean", "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query" } }, "parameterOrder": [ "name" ] } } }, "recommenders": { "methods": { "getConfig": { "description": "Gets the requested Recommender Config. There is only one instance of the config for each Recommender.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.billingAccounts.locations.recommenders.getConfig", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "parameterOrder": [ "name" ], "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`", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string", "location": "path", "required": true } } }, "updateConfig": { "request": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "parameterOrder": [ "name" ], "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "The list of fields to be updated.", "location": "query" }, "name": { "location": "path", "required": true, "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string" }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" } }, "id": "recommender.billingAccounts.locations.recommenders.updateConfig", "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Recommender Config. This will create a new revision of the config.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config" } }, "resources": { "recommendations": { "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}" }, "markClaimed": { "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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.markClaimed", "path": "v1/{+name}:markClaimed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" } }, "markSucceeded": { "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "path": "v1/{+name}:markSucceeded", "id": "recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" } }, "markFailed": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.markFailed", "path": "v1/{+name}:markFailed", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" }, "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.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "markDismissed": { "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.", "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "id": "recommender.billingAccounts.locations.recommenders.recommendations.markDismissed", "path": "v1/{+name}:markDismissed", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest" } }, "list": { "flatPath": "v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" }, "path": "v1/{+parent}/recommendations", "id": "recommender.billingAccounts.locations.recommenders.recommendations.list", "parameters": { "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" }, "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.", "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string", "location": "path", "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.", "format": "int32", "type": "integer" }, "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)" } }, "parameterOrder": [ "parent" ] } } } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "insightTypes": { "methods": { "getConfig": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string", "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, "location": "path" } }, "id": "recommender.organizations.locations.insightTypes.getConfig", "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config" }, "updateConfig": { "description": "Updates an InsightTypeConfig change. This will create a new revision of the config.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "recommender.organizations.locations.insightTypes.updateConfig", "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "request": { "$ref": "GoogleCloudRecommenderV1InsightTypeConfig" }, "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "The list of fields to be updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$", "type": "string", "location": "path", "required": true }, "validateOnly": { "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query", "type": "boolean" } } } }, "resources": { "insights": { "methods": { "list": { "parameters": { "parent": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+$", "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." }, "pageSize": { "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", "type": "integer", "format": "int32" }, "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" }, "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" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" }, "path": "v1/{+parent}/insights", "id": "recommender.organizations.locations.insightTypes.insights.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights", "description": "Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type." }, "markAccepted": { "parameters": { "name": { "description": "Required. Name of the insight.", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "path": "v1/{+name}:markAccepted", "id": "recommender.organizations.locations.insightTypes.insights.markAccepted", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted", "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." }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Insight" }, "path": "v1/{+name}", "id": "recommender.organizations.locations.insightTypes.insights.get", "parameters": { "name": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", "type": "string", "description": "Required. Name of the insight." } }, "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}", "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "recommenders": { "methods": { "getConfig": { "parameters": { "name": { "location": "path", "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`", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "recommender.organizations.locations.recommenders.getConfig", "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config", "description": "Gets the requested Recommender Config. There is only one instance of the config for each Recommender." }, "updateConfig": { "parameterOrder": [ "name" ], "parameters": { "updateMask": { "location": "query", "description": "The list of fields to be updated.", "format": "google-fieldmask", "type": "string" }, "name": { "description": "Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$", "type": "string", "location": "path", "required": true }, "validateOnly": { "type": "boolean", "description": "If true, validate the request and preview the change, but do not actually update it.", "location": "query" } }, "request": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudRecommenderV1RecommenderConfig" }, "id": "recommender.organizations.locations.recommenders.updateConfig", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Recommender Config. This will create a new revision of the config.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config" } }, "resources": { "recommendations": { "methods": { "markDismissed": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:markDismissed", "id": "recommender.organizations.locations.recommenders.recommendations.markDismissed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationDismissedRequest" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "description": "Required. Name of the recommendation." } }, "parameterOrder": [ "name" ] }, "markFailed": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:markFailed", "id": "recommender.organizations.locations.recommenders.recommendations.markFailed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "description": "Required. Name of the recommendation." } }, "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}", "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "path": "v1/{+name}", "id": "recommender.organizations.locations.recommenders.recommendations.get", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "description": "Required. Name of the recommendation.", "required": true, "location": "path" } }, "parameterOrder": [ "name" ] }, "markClaimed": { "id": "recommender.organizations.locations.recommenders.recommendations.markClaimed", "path": "v1/{+name}:markClaimed", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string", "description": "Required. Name of the recommendation." } }, "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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "markSucceeded": { "request": { "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. Name of the recommendation.", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", "type": "string" } }, "id": "recommender.organizations.locations.recommenders.recommendations.markSucceeded", "path": "v1/{+name}:markSucceeded", "httpMethod": "POST", "response": { "$ref": "GoogleCloudRecommenderV1Recommendation" }, "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.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded" }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" }, "path": "v1/{+parent}/recommendations", "id": "recommender.organizations.locations.recommenders.recommendations.list", "parameters": { "pageToken": { "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.", "type": "string" }, "parent": { "location": "path", "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.", "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "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." }, "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)" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations", "description": "Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } } } }, "rootUrl": "https://recommender.googleapis.com/", "servicePath": "", "title": "Recommender API", "fullyEncodeReservedExpansion": true, "id": "recommender:v1", "canonicalName": "Recommender", "discoveryVersion": "v1", "protocol": "rest", "batchPath": "batch", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "parameters": { "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "location": "query", "default": "json", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "enum": [ "1", "2" ], "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "quotaUser": { "type": "string", "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." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "key": { "type": "string", "location": "query", "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." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "ownerDomain": "google.com", "version": "v1", "mtlsRootUrl": "https://recommender.mtls.googleapis.com/", "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." } } } }, "kind": "discovery#restDescription", "ownerName": "Google" }