1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="recommender_v1.html">Recommender API</a> . <a href="recommender_v1.projects.html">projects</a> . <a href="recommender_v1.projects.locations.html">locations</a> . <a href="recommender_v1.projects.locations.recommenders.html">recommenders</a> . <a href="recommender_v1.projects.locations.recommenders.recommendations.html">recommendations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#markClaimed">markClaimed(name, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">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.</p> 92<p class="toc_element"> 93 <code><a href="#markFailed">markFailed(name, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">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.</p> 95<p class="toc_element"> 96 <code><a href="#markSucceeded">markSucceeded(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">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.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="get">get(name, x__xgafv=None)</code> 106 <pre>Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. 107 108Args: 109 name: string, Required. Name of the recommendation. (required) 110 x__xgafv: string, V1 error format. 111 Allowed values 112 1 - v1 error format 113 2 - v2 error format 114 115Returns: 116 An object of the form: 117 118 { # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc 119 "additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. 120 { # Contains the impact a recommendation can have for a given category. 121 "category": "A String", # Category that is being targeted. 122 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 123 "cost": { # Represents an amount of money with its currency type. # 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. 124 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 125 "nanos": 42, # 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. 126 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 127 }, 128 "duration": "A String", # Duration for which this cost applies. 129 }, 130 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 131 "details": { # Additional security impact details that is provided by the recommender. 132 "a_key": "", # Properties of the object. 133 }, 134 }, 135 }, 136 ], 137 "associatedInsights": [ # Insights that led to this recommendation. 138 { # Reference to an associated insight. 139 "insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] 140 }, 141 ], 142 "content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources. 143 "operationGroups": [ # 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. 144 { # Group of operations that need to be performed atomically. 145 "operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. 146 { # 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. 147 "action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. 148 "path": "A String", # 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. 149 "pathFilters": { # 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/*" : ["[email protected]", "[email protected]"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed. 150 "a_key": "", 151 }, 152 "pathValueMatchers": { # 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. 153 "a_key": { # Contains various matching options for values for a GCP resource field. 154 "matchesPattern": "A String", # 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 155 }, 156 }, 157 "resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. 158 "resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance 159 "sourcePath": "A String", # 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. 160 "sourceResource": "A String", # 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`. 161 "value": "", # 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. 162 "valueMatcher": { # Contains various matching options for values for a GCP resource field. # 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. 163 "matchesPattern": "A String", # 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 164 }, 165 }, 166 ], 167 }, 168 ], 169 "overview": { # Condensed overview information about the recommendation. 170 "a_key": "", # Properties of the object. 171 }, 172 }, 173 "description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters. 174 "etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states. 175 "lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place. 176 "name": "A String", # Name of recommendation. 177 "primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category. 178 "category": "A String", # Category that is being targeted. 179 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 180 "cost": { # Represents an amount of money with its currency type. # 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. 181 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 182 "nanos": 42, # 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. 183 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 184 }, 185 "duration": "A String", # Duration for which this cost applies. 186 }, 187 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 188 "details": { # Additional security impact details that is provided by the recommender. 189 "a_key": "", # Properties of the object. 190 }, 191 }, 192 }, 193 "priority": "A String", # Recommendation's priority. 194 "recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" 195 "stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata. 196 "state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. 197 "stateMetadata": { # A map of metadata for the state, provided by user or automations systems. 198 "a_key": "A String", 199 }, 200 }, 201 "xorGroupId": "A String", # Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 207 <pre>Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. 208 209Args: 210 parent: string, 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) 211 filter: string, Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160) 212 pageSize: integer, 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. 213 pageToken: string, 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. 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # Response to the `ListRecommendations` method. 223 "nextPageToken": "A String", # A token that can be used to request the next page of results. This field is empty if there are no additional results. 224 "recommendations": [ # The set of recommendations for the `parent` resource. 225 { # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc 226 "additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. 227 { # Contains the impact a recommendation can have for a given category. 228 "category": "A String", # Category that is being targeted. 229 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 230 "cost": { # Represents an amount of money with its currency type. # 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. 231 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 232 "nanos": 42, # 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. 233 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 234 }, 235 "duration": "A String", # Duration for which this cost applies. 236 }, 237 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 238 "details": { # Additional security impact details that is provided by the recommender. 239 "a_key": "", # Properties of the object. 240 }, 241 }, 242 }, 243 ], 244 "associatedInsights": [ # Insights that led to this recommendation. 245 { # Reference to an associated insight. 246 "insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] 247 }, 248 ], 249 "content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources. 250 "operationGroups": [ # 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. 251 { # Group of operations that need to be performed atomically. 252 "operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. 253 { # 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. 254 "action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. 255 "path": "A String", # 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. 256 "pathFilters": { # 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/*" : ["[email protected]", "[email protected]"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed. 257 "a_key": "", 258 }, 259 "pathValueMatchers": { # 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. 260 "a_key": { # Contains various matching options for values for a GCP resource field. 261 "matchesPattern": "A String", # 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 262 }, 263 }, 264 "resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. 265 "resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance 266 "sourcePath": "A String", # 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. 267 "sourceResource": "A String", # 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`. 268 "value": "", # 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. 269 "valueMatcher": { # Contains various matching options for values for a GCP resource field. # 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. 270 "matchesPattern": "A String", # 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 271 }, 272 }, 273 ], 274 }, 275 ], 276 "overview": { # Condensed overview information about the recommendation. 277 "a_key": "", # Properties of the object. 278 }, 279 }, 280 "description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters. 281 "etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states. 282 "lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place. 283 "name": "A String", # Name of recommendation. 284 "primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category. 285 "category": "A String", # Category that is being targeted. 286 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 287 "cost": { # Represents an amount of money with its currency type. # 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. 288 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 289 "nanos": 42, # 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. 290 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 291 }, 292 "duration": "A String", # Duration for which this cost applies. 293 }, 294 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 295 "details": { # Additional security impact details that is provided by the recommender. 296 "a_key": "", # Properties of the object. 297 }, 298 }, 299 }, 300 "priority": "A String", # Recommendation's priority. 301 "recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" 302 "stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata. 303 "state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. 304 "stateMetadata": { # A map of metadata for the state, provided by user or automations systems. 305 "a_key": "A String", 306 }, 307 }, 308 "xorGroupId": "A String", # Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. 309 }, 310 ], 311}</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 316 <pre>Retrieves the next page of results. 317 318Args: 319 previous_request: The request for the previous page. (required) 320 previous_response: The response from the request for the previous page. (required) 321 322Returns: 323 A request object that you can call 'execute()' on to request the next 324 page. Returns None if there are no more items in the collection. 325 </pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="markClaimed">markClaimed(name, body=None, x__xgafv=None)</code> 330 <pre>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. 331 332Args: 333 name: string, Required. Name of the recommendation. (required) 334 body: object, The request body. 335 The object takes the form of: 336 337{ # Request for the `MarkRecommendationClaimed` Method. 338 "etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking. 339 "stateMetadata": { # 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}$/`. 340 "a_key": "A String", 341 }, 342} 343 344 x__xgafv: string, V1 error format. 345 Allowed values 346 1 - v1 error format 347 2 - v2 error format 348 349Returns: 350 An object of the form: 351 352 { # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc 353 "additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. 354 { # Contains the impact a recommendation can have for a given category. 355 "category": "A String", # Category that is being targeted. 356 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 357 "cost": { # Represents an amount of money with its currency type. # 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. 358 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 359 "nanos": 42, # 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. 360 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 361 }, 362 "duration": "A String", # Duration for which this cost applies. 363 }, 364 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 365 "details": { # Additional security impact details that is provided by the recommender. 366 "a_key": "", # Properties of the object. 367 }, 368 }, 369 }, 370 ], 371 "associatedInsights": [ # Insights that led to this recommendation. 372 { # Reference to an associated insight. 373 "insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] 374 }, 375 ], 376 "content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources. 377 "operationGroups": [ # 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. 378 { # Group of operations that need to be performed atomically. 379 "operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. 380 { # 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. 381 "action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. 382 "path": "A String", # 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. 383 "pathFilters": { # 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/*" : ["[email protected]", "[email protected]"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed. 384 "a_key": "", 385 }, 386 "pathValueMatchers": { # 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. 387 "a_key": { # Contains various matching options for values for a GCP resource field. 388 "matchesPattern": "A String", # 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 389 }, 390 }, 391 "resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. 392 "resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance 393 "sourcePath": "A String", # 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. 394 "sourceResource": "A String", # 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`. 395 "value": "", # 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. 396 "valueMatcher": { # Contains various matching options for values for a GCP resource field. # 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. 397 "matchesPattern": "A String", # 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 398 }, 399 }, 400 ], 401 }, 402 ], 403 "overview": { # Condensed overview information about the recommendation. 404 "a_key": "", # Properties of the object. 405 }, 406 }, 407 "description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters. 408 "etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states. 409 "lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place. 410 "name": "A String", # Name of recommendation. 411 "primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category. 412 "category": "A String", # Category that is being targeted. 413 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 414 "cost": { # Represents an amount of money with its currency type. # 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. 415 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 416 "nanos": 42, # 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. 417 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 418 }, 419 "duration": "A String", # Duration for which this cost applies. 420 }, 421 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 422 "details": { # Additional security impact details that is provided by the recommender. 423 "a_key": "", # Properties of the object. 424 }, 425 }, 426 }, 427 "priority": "A String", # Recommendation's priority. 428 "recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" 429 "stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata. 430 "state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. 431 "stateMetadata": { # A map of metadata for the state, provided by user or automations systems. 432 "a_key": "A String", 433 }, 434 }, 435 "xorGroupId": "A String", # Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. 436}</pre> 437</div> 438 439<div class="method"> 440 <code class="details" id="markFailed">markFailed(name, body=None, x__xgafv=None)</code> 441 <pre>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. 442 443Args: 444 name: string, Required. Name of the recommendation. (required) 445 body: object, The request body. 446 The object takes the form of: 447 448{ # Request for the `MarkRecommendationFailed` Method. 449 "etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking. 450 "stateMetadata": { # 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}$/`. 451 "a_key": "A String", 452 }, 453} 454 455 x__xgafv: string, V1 error format. 456 Allowed values 457 1 - v1 error format 458 2 - v2 error format 459 460Returns: 461 An object of the form: 462 463 { # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc 464 "additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. 465 { # Contains the impact a recommendation can have for a given category. 466 "category": "A String", # Category that is being targeted. 467 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 468 "cost": { # Represents an amount of money with its currency type. # 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. 469 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 470 "nanos": 42, # 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. 471 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 472 }, 473 "duration": "A String", # Duration for which this cost applies. 474 }, 475 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 476 "details": { # Additional security impact details that is provided by the recommender. 477 "a_key": "", # Properties of the object. 478 }, 479 }, 480 }, 481 ], 482 "associatedInsights": [ # Insights that led to this recommendation. 483 { # Reference to an associated insight. 484 "insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] 485 }, 486 ], 487 "content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources. 488 "operationGroups": [ # 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. 489 { # Group of operations that need to be performed atomically. 490 "operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. 491 { # 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. 492 "action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. 493 "path": "A String", # 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. 494 "pathFilters": { # 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/*" : ["[email protected]", "[email protected]"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed. 495 "a_key": "", 496 }, 497 "pathValueMatchers": { # 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. 498 "a_key": { # Contains various matching options for values for a GCP resource field. 499 "matchesPattern": "A String", # 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 500 }, 501 }, 502 "resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. 503 "resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance 504 "sourcePath": "A String", # 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. 505 "sourceResource": "A String", # 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`. 506 "value": "", # 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. 507 "valueMatcher": { # Contains various matching options for values for a GCP resource field. # 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. 508 "matchesPattern": "A String", # 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 509 }, 510 }, 511 ], 512 }, 513 ], 514 "overview": { # Condensed overview information about the recommendation. 515 "a_key": "", # Properties of the object. 516 }, 517 }, 518 "description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters. 519 "etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states. 520 "lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place. 521 "name": "A String", # Name of recommendation. 522 "primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category. 523 "category": "A String", # Category that is being targeted. 524 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 525 "cost": { # Represents an amount of money with its currency type. # 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. 526 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 527 "nanos": 42, # 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. 528 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 529 }, 530 "duration": "A String", # Duration for which this cost applies. 531 }, 532 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 533 "details": { # Additional security impact details that is provided by the recommender. 534 "a_key": "", # Properties of the object. 535 }, 536 }, 537 }, 538 "priority": "A String", # Recommendation's priority. 539 "recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" 540 "stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata. 541 "state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. 542 "stateMetadata": { # A map of metadata for the state, provided by user or automations systems. 543 "a_key": "A String", 544 }, 545 }, 546 "xorGroupId": "A String", # Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. 547}</pre> 548</div> 549 550<div class="method"> 551 <code class="details" id="markSucceeded">markSucceeded(name, body=None, x__xgafv=None)</code> 552 <pre>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. 553 554Args: 555 name: string, Required. Name of the recommendation. (required) 556 body: object, The request body. 557 The object takes the form of: 558 559{ # Request for the `MarkRecommendationSucceeded` Method. 560 "etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking. 561 "stateMetadata": { # 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}$/`. 562 "a_key": "A String", 563 }, 564} 565 566 x__xgafv: string, V1 error format. 567 Allowed values 568 1 - v1 error format 569 2 - v2 error format 570 571Returns: 572 An object of the form: 573 574 { # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc 575 "additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. 576 { # Contains the impact a recommendation can have for a given category. 577 "category": "A String", # Category that is being targeted. 578 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 579 "cost": { # Represents an amount of money with its currency type. # 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. 580 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 581 "nanos": 42, # 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. 582 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 583 }, 584 "duration": "A String", # Duration for which this cost applies. 585 }, 586 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 587 "details": { # Additional security impact details that is provided by the recommender. 588 "a_key": "", # Properties of the object. 589 }, 590 }, 591 }, 592 ], 593 "associatedInsights": [ # Insights that led to this recommendation. 594 { # Reference to an associated insight. 595 "insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] 596 }, 597 ], 598 "content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources. 599 "operationGroups": [ # 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. 600 { # Group of operations that need to be performed atomically. 601 "operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. 602 { # 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. 603 "action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. 604 "path": "A String", # 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. 605 "pathFilters": { # 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/*" : ["[email protected]", "[email protected]"] } ``` When both path_filters and path_value_matchers are set, an implicit AND must be performed. 606 "a_key": "", 607 }, 608 "pathValueMatchers": { # 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. 609 "a_key": { # Contains various matching options for values for a GCP resource field. 610 "matchesPattern": "A String", # 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 611 }, 612 }, 613 "resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. 614 "resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance 615 "sourcePath": "A String", # 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. 616 "sourceResource": "A String", # 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`. 617 "value": "", # 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. 618 "valueMatcher": { # Contains various matching options for values for a GCP resource field. # 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. 619 "matchesPattern": "A String", # 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 620 }, 621 }, 622 ], 623 }, 624 ], 625 "overview": { # Condensed overview information about the recommendation. 626 "a_key": "", # Properties of the object. 627 }, 628 }, 629 "description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters. 630 "etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states. 631 "lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place. 632 "name": "A String", # Name of recommendation. 633 "primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category. 634 "category": "A String", # Category that is being targeted. 635 "costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST 636 "cost": { # Represents an amount of money with its currency type. # 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. 637 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 638 "nanos": 42, # 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. 639 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 640 }, 641 "duration": "A String", # Duration for which this cost applies. 642 }, 643 "securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY 644 "details": { # Additional security impact details that is provided by the recommender. 645 "a_key": "", # Properties of the object. 646 }, 647 }, 648 }, 649 "priority": "A String", # Recommendation's priority. 650 "recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" 651 "stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata. 652 "state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. 653 "stateMetadata": { # A map of metadata for the state, provided by user or automations systems. 654 "a_key": "A String", 655 }, 656 }, 657 "xorGroupId": "A String", # Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. 658}</pre> 659</div> 660 661</body></html>