Debian Codegraph @

docs/dyn/compute_alpha.folderGlobalVmExtensionPolicies.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.folderGlobalVmExtensionPolicies.html">folderGlobalVmExtensionPolicies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(folder, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves the list of all folder level VM Extension Policy resources</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(folder, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Purge scoped resources (zonal policies) from a folder level global</p>
89 <p class="toc_element">
90 <code><a href="#get">get(folder, globalVmExtensionPolicy, x__xgafv=None)</a></code></p>
91 <p class="firstline">Gets details of a folder level GlobalVmExtensionPolicy.</p>
92 <p class="toc_element">
93 <code><a href="#getVmExtension">getVmExtension(folder, extensionName, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves details of a specific VM extension.</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(folder, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a new folder level GlobalVmExtensionPolicy.</p>
98 <p class="toc_element">
99 <code><a href="#list">list(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Lists folder level GlobalVmExtensionPolicies.</p>
101 <p class="toc_element">
102 <code><a href="#listVmExtensions">listVmExtensions(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Lists all VM extensions within a folder.</p>
104 <p class="toc_element">
105 <code><a href="#listVmExtensions_next">listVmExtensions_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#list_next">list_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#update">update(folder, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Updates a folder level GlobalVmExtensionPolicy.</p>
113 <h3>Method Details</h3>
114 <div class="method">
115 <code class="details" id="aggregatedList">aggregatedList(folder, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
116 <pre>Retrieves the list of all folder level VM Extension Policy resources
117 available to the specified folder.
118
119 To prevent failure, it&#x27;s recommended that you set the
120 `returnPartialSuccess` parameter to `true`.
121
122 Args:
123 folder: string, Folder ID for this request. (required)
124 filter: string, A filter expression that filters resources listed in the response. Most
125 Compute resources support two types of filter expressions:
126 expressions that support regular expressions and expressions that follow
127 API improvement proposal AIP-160.
128 These two types of filter expressions cannot be mixed in one request.
129
130 If you want to use AIP-160, your expression must specify the field name, an
131 operator, and the value that you want to use for filtering. The value
132 must be a string, a number, or a boolean. The operator
133 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
134
135 For example, if you are filtering Compute Engine instances, you can
136 exclude instances named `example-instance` by specifying
137 `name != example-instance`.
138
139 The `:*` comparison can be used to test whether a key has been defined.
140 For example, to find all objects with `owner` label use:
141 ```
142 labels.owner:*
143 ```
144
145 You can also filter nested fields. For example, you could specify
146 `scheduling.automaticRestart = false` to include instances only
147 if they are not scheduled for automatic restarts. You can use filtering
148 on nested fields to filter based onresource labels.
149
150 To filter on multiple expressions, provide each separate expression within
151 parentheses. For example:
152 ```
153 (scheduling.automaticRestart = true)
154 (cpuPlatform = &quot;Intel Skylake&quot;)
155 ```
156 By default, each expression is an `AND` expression. However, you
157 can include `AND` and `OR` expressions explicitly.
158 For example:
159 ```
160 (cpuPlatform = &quot;Intel Skylake&quot;) OR
161 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
162 (scheduling.automaticRestart = true)
163 ```
164
165 If you want to use a regular expression, use the `eq` (equal) or `ne`
166 (not equal) operator against a single un-parenthesized expression with or
167 without quotes or against multiple parenthesized expressions. Examples:
168
169 `fieldname eq unquoted literal`
170 `fieldname eq &#x27;single quoted literal&#x27;`
171 `fieldname eq &quot;double quoted literal&quot;`
172 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
173
174 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
175 The literal value must match the entire field.
176
177 For example, to filter for instances that do not end with name &quot;instance&quot;,
178 you would use `name ne .*instance`.
179
180 You cannot combine constraints on multiple fields using regular
181 expressions.
182 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
183 global) should be included in the response. For new resource types added
184 after this field, the flag has no effect as new resource types will always
185 include every visible scope for each scope type in response. For resource
186 types which predate this field, if this flag is omitted or false, only
187 scopes of the scope types where the resource type is expected to be found
188 will be included.
189 maxResults: integer, The maximum number of results per page that should be returned.
190 If the number of available results is larger than `maxResults`,
191 Compute Engine returns a `nextPageToken` that can be used to get
192 the next page of results in subsequent list requests. Acceptable values are
193 `0` to `500`, inclusive. (Default: `500`)
194 orderBy: string, Sorts list results by a certain order. By default, results
195 are returned in alphanumerical order based on the resource name.
196
197 You can also sort results in descending order based on the creation
198 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
199 results based on the `creationTimestamp` field in
200 reverse chronological order (newest result first). Use this to sort
201 resources like operations so that the newest operation is returned first.
202
203 Currently, only sorting by `name` or
204 `creationTimestamp desc` is supported.
205 pageToken: string, Specifies a page token to use. Set `pageToken` to the
206 `nextPageToken` returned by a previous list request to get
207 the next page of results.
208 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
209 of failure. The default value is false.
210
211 For example, when partial success behavior is enabled, aggregatedList for a
212 single zone scope either returns all resources in the zone or no resources,
213 with an error code.
214 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
215 aggregated list request is invoked for subnetworks list-usable api.
216 x__xgafv: string, V1 error format.
217 Allowed values
218 1 - v1 error format
219 2 - v2 error format
220
221 Returns:
222 An object of the form:
223
224 {
225 &quot;etag&quot;: &quot;A String&quot;,
226 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
227 &quot;items&quot;: { # A list of VmExtensionPoliciesScopedList resources.
228 &quot;a_key&quot;: { # Name of the scope containing this set of VmExtensionPolicies.
229 &quot;vmExtensionPolicies&quot;: [ # List of VmExtensionPolicy resources contained in this scope.
230 { # Represents a VM extension policy.
231 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
232 # text format.
233 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
234 &quot;extensionPolicies&quot;: { # Required. A map of extension names (for example, &quot;ops-agent&quot;) to their corresponding
235 # policy configurations.
236 &quot;a_key&quot;: { # Configuration for a specific VM extension.
237 &quot;pinnedVersion&quot;: &quot;A String&quot;, # Optional. The specific version of the extension to install. If not set, the latest
238 # version is used.
239 &quot;stringConfig&quot;: &quot;A String&quot;, # Optional. String-based configuration data for the extension.
240 },
241 },
242 &quot;globalResourceLink&quot;: &quot;A String&quot;, # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
243 # applicable.
244 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
245 # defined by the server.
246 &quot;instanceSelectors&quot;: [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
247 # *any* of the provided selectors (logical OR). If this list is empty, the
248 # policy applies to all VMs.
249 { # Defines how to select VMs to apply a zone VM extension policy.
250 &quot;labelSelector&quot;: { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
251 # labels.
252 &quot;inclusionLabels&quot;: { # Optional. A map of key-value pairs representing VM labels.
253 # VMs must have all of the labels specified in this map to be selected
254 # (logical AND).
255 #
256 # e.g. If the `inclusion_labels` are {(&quot;key1&quot;, &quot;value1&quot;), (&quot;key2&quot;,
257 # &quot;value2&quot;)}, the VM labels must contain both (&quot;key1&quot;, &quot;value1&quot;) and
258 # (&quot;key2&quot;, &quot;value2&quot;) to be selected. If the VM labels are (&quot;key1&quot;,
259 # &quot;value1&quot;) and (&quot;something&quot;, &quot;else&quot;), it will not be selected.
260 #
261 # If the map is empty, it&#x27;s considered a match.
262 &quot;a_key&quot;: &quot;A String&quot;,
263 },
264 },
265 },
266 ],
267 &quot;kind&quot;: &quot;compute#vmExtensionPolicy&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
268 &quot;managedByGlobal&quot;: True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
269 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
270 # The name must be 1-63 characters long, and comply withRFC1035.
271 # Specifically, the name must be 1-63 characters long and match the regular
272 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
273 # which means the first character must be a lowercase letter, and all
274 # following characters must be a dash, lowercase letter, or digit, except
275 # the last character, which cannot be a dash.
276 &quot;priority&quot;: 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
277 # apply to the same extension.
278 # The policy priority is an integer from 0 to 65535, inclusive. Lower
279 # integers indicate higher priorities. If you do not specify a priority when
280 # creating a rule, it is assigned a priority of 1000. If priorities are
281 # equal, the policy with the most recent creation timestamp takes precedence.
282 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
283 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
284 &quot;state&quot;: &quot;A String&quot;, # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
285 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Update timestamp inRFC3339
286 # text format.
287 },
288 ],
289 &quot;warning&quot;: { # Informational warning which replaces the list of
290 # backend services when the list is empty.
291 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
292 # Engine returns NO_RESULTS_ON_PAGE if there
293 # are no results in the response.
294 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
295 # value format. For example:
296 #
297 # &quot;data&quot;: [
298 # {
299 # &quot;key&quot;: &quot;scope&quot;,
300 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
301 # }
302 {
303 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
304 # returned. For example, for warnings where there are no results in a list
305 # request for a particular zone, this key might be scope and
306 # the key value might be the zone name. Other examples might be a key
307 # indicating a deprecated resource and a suggested replacement, or a
308 # warning about invalid network settings (for example, if an instance
309 # attempts to perform IP forwarding but is not enabled for IP forwarding).
310 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
311 },
312 ],
313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
314 },
315 },
316 },
317 &quot;kind&quot;: &quot;compute#FolderVmExtensionPolicyAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#FolderVmExtensionPolicyAggregatedList for lists of
318 # VmExtensionPolicies.
319 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
320 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
321 # the query parameter pageToken in the next list request.
322 # Subsequent list requests will have their own nextPageToken to
323 # continue paging through the results.
324 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
325 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
326 &quot;A String&quot;,
327 ],
328 &quot;warning&quot;: { # [Output Only] Informational warning message.
329 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
330 # Engine returns NO_RESULTS_ON_PAGE if there
331 # are no results in the response.
332 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
333 # value format. For example:
334 #
335 # &quot;data&quot;: [
336 # {
337 # &quot;key&quot;: &quot;scope&quot;,
338 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
339 # }
340 {
341 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
342 # returned. For example, for warnings where there are no results in a list
343 # request for a particular zone, this key might be scope and
344 # the key value might be the zone name. Other examples might be a key
345 # indicating a deprecated resource and a suggested replacement, or a
346 # warning about invalid network settings (for example, if an instance
347 # attempts to perform IP forwarding but is not enabled for IP forwarding).
348 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
349 },
350 ],
351 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
352 },
353 }</pre>
354 </div>
355
356 <div class="method">
357 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
358 <pre>Retrieves the next page of results.
359
360 Args:
361 previous_request: The request for the previous page. (required)
362 previous_response: The response from the request for the previous page. (required)
363
364 Returns:
365 A request object that you can call &#x27;execute()&#x27; on to request the next
366 page. Returns None if there are no more items in the collection.
367 </pre>
368 </div>
369
370 <div class="method">
371 <code class="details" id="close">close()</code>
372 <pre>Close httplib2 connections.</pre>
373 </div>
374
375 <div class="method">
376 <code class="details" id="delete">delete(folder, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)</code>
377 <pre>Purge scoped resources (zonal policies) from a folder level global
378 VM extension policy, and then delete the global VM extension policy. Purge
379 of the scoped resources is a pre-condition of the global VM extension
380 policy deletion. The deletion of the global VM extension policy happens
381 after the purge rollout is done, so it&#x27;s not a part of the LRO. It&#x27;s an
382 automatic process that triggers in the backend.
383
384 Args:
385 folder: string, Folder ID for this request. (required)
386 globalVmExtensionPolicy: string, Name of the global VM extension policy to purge scoped resources for. (required)
387 body: object, The request body.
388 The object takes the form of:
389
390 {
391 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Optional. Specifies the behavior of the rollout if a conflict is detected in a
392 # project during a rollout. This only applies to `insert` and `update`
393 # methods.
394 #
395 # A conflict occurs in the following cases:
396 #
397 # * `insert` method: If the zonal policy already exists when the insert
398 # happens.
399 # * `update` method: If the zonal policy was modified by a zonal API call
400 # outside of this rollout.
401 #
402 # Possible values are the following:
403 #
404 # * `&quot;&quot;` (empty string): If a conflict occurs, the local value is not
405 # overwritten. This is the default behavior.
406 # * `&quot;overwrite&quot;`: If a conflict occurs, the local value is overwritten
407 # with the rollout value.
408 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the rollout plan.
409 # Ex.
410 # projects//locations/global/rolloutPlans/.
411 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Optional. Specifies the predefined rollout plan for the policy. Valid values
412 # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is
413 # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout
414 # plans for global policies.
415 &quot;retryUuid&quot;: &quot;A String&quot;, # Optional. The UUID that identifies a policy rollout retry attempt for update and
416 # delete operations. Set this field only when retrying a rollout for an
417 # existing extension policy.
418 #
419 # * `update` method: Lets you retry policy rollout without changes.
420 # An error occurs if you set retry_uuid but the policy is modified.
421 # * `delete` method: Lets you retry policy deletion rollout if the
422 # previous deletion rollout is not finished and the policy is in the
423 # DELETING state. If you set this field when the policy is not in the
424 # DELETING state, an error occurs.
425 }
426
427 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
428 that if you must retry your request, the server will know to ignore the
429 request if it has already been completed.
430
431 For example, consider a situation where you make an initial request and
432 the request times out. If you make the request again with the same
433 request ID, the server can check if original operation with the same
434 request ID was received, and if so, will ignore the second request. This
435 prevents clients from accidentally creating duplicate commitments.
436
437 The request ID must be
438 a valid UUID with the exception that zero UUID is not supported
439 (00000000-0000-0000-0000-000000000000).
440 x__xgafv: string, V1 error format.
441 Allowed values
442 1 - v1 error format
443 2 - v2 error format
444
445 Returns:
446 An object of the form:
447
448 { # Represents an Operation resource.
449 #
450 # Google Compute Engine has three Operation resources:
451 #
452 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
453 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
454 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
455 #
456 # You can use an operation resource to manage asynchronous API requests.
457 # For more information, readHandling
458 # API responses.
459 #
460 # Operations can be global, regional or zonal.
461 #
462 # - For global operations, use the `globalOperations`
463 # resource.
464 # - For regional operations, use the
465 # `regionOperations` resource.
466 # - For zonal operations, use
467 # the `zoneOperations` resource.
468 #
469 #
470 #
471 # For more information, read
472 # Global, Regional, and Zonal Resources.
473 #
474 # Note that completed Operation resources have a limited
475 # retention period.
476 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
477 # Not present otherwise.
478 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
479 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
480 # set when the operation is created.
481 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
482 # text format.
483 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
484 # this field will be populated.
485 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
486 # operation.
487 {
488 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
489 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
490 # details. There is a set of defined message types to use for providing
491 # details.The syntax depends on the error code. For example,
492 # QuotaExceededInfo will have details when the error code is
493 # QUOTA_EXCEEDED.
494 {
495 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
496 #
497 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
498 # is not enabled:
499 #
500 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
501 # &quot;domain&quot;: &quot;googleapis.com&quot;
502 # &quot;metadata&quot;: {
503 # &quot;resource&quot;: &quot;projects/123&quot;,
504 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
505 # }
506 # }
507 #
508 # This response indicates that the pubsub.googleapis.com API is not enabled.
509 #
510 # Example of an error that is returned when attempting to create a Spanner
511 # instance in a region that is out of stock:
512 #
513 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
514 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
515 # &quot;metadata&quot;: {
516 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
517 # }
518 # }
519 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
520 # is typically the registered service name of the tool or product that
521 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
522 # generated by some common infrastructure, the error domain must be a
523 # globally unique value that identifies the infrastructure. For Google API
524 # infrastructure, the error domain is &quot;googleapis.com&quot;.
525 &quot;metadatas&quot;: { # Additional structured details about this error.
526 #
527 # Keys must match a regular expression of `a-z+` but should
528 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
529 # length. When identifying the current value of an exceeded limit, the units
530 # should be contained in the key, not the value. For example, rather than
531 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
532 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
533 # instances that can be created in a single (batch) request.
534 &quot;a_key&quot;: &quot;A String&quot;,
535 },
536 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
537 # proximate cause of the error. Error reasons are unique within a particular
538 # domain of errors. This should be at most 63 characters and match a
539 # regular expression of `A-Z+[A-Z0-9]`, which represents
540 # UPPER_SNAKE_CASE.
541 },
542 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
543 #
544 # For example, if a quota check failed with an error indicating the calling
545 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
546 # directly to the right place in the developer console to flip the bit.
547 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
548 { # Describes a URL link.
549 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
550 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
551 },
552 ],
553 },
554 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
555 # which can be attached to an RPC error.
556 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
557 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
558 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
559 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
560 },
561 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
562 &quot;dimensions&quot;: { # The map holding related quota dimensions.
563 &quot;a_key&quot;: &quot;A String&quot;,
564 },
565 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
566 # type or metric.
567 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
568 # or metric.
569 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
570 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
571 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
572 },
573 },
574 ],
575 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
576 # This property is optional.
577 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
578 },
579 ],
580 },
581 &quot;getVersionOperationMetadata&quot;: {
582 &quot;inlineSbomInfo&quot;: {
583 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
584 # appropriate identifiers.
585 &quot;a_key&quot;: &quot;A String&quot;,
586 },
587 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
588 # identifiers.
589 &quot;a_key&quot;: &quot;A String&quot;,
590 },
591 },
592 },
593 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
594 # message that was returned, such as `NOT FOUND`.
595 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
596 # status code that was returned. For example, a `404` means the
597 # resource was not found.
598 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
599 # defined by the server.
600 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
601 # This value is inRFC3339
602 # text format.
603 &quot;instancesBulkInsertOperationMetadata&quot;: {
604 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
605 # Example key: zones/us-central1-a
606 &quot;a_key&quot;: {
607 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
608 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
609 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
610 # error.
611 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
612 # if the flow is rolling forward or rolling back.
613 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
614 },
615 },
616 },
617 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
618 # Operation resources.
619 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
620 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
621 # group of operations results from a `bulkInsert` API request.
622 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
623 # `update`, or `delete`, and so on.
624 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
625 # There is no requirement that this be linear or support any granularity of
626 # operations. This should not be used to guess when the operation will be
627 # complete. This number should monotonically increase as the operation
628 # progresses.
629 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
630 # applicable when performing regional operations.
631 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
632 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
633 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
634 # this field will contain information on all underlying zonal actions and
635 # their state.
636 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
637 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
638 # Example key: zones/us-central1-a
639 &quot;a_key&quot;: {
640 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
641 # populated.
642 # different programming environments, including REST APIs and RPC APIs. It is
643 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
644 # three pieces of data: error code, error message, and error details.
645 #
646 # You can find out more about this error model and how to work with it in the
647 # [API Design Guide](https://cloud.google.com/apis/design/errors).
648 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
649 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
650 # message types for APIs to use.
651 {
652 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
653 },
654 ],
655 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
656 # user-facing error message should be localized and sent in the
657 # google.rpc.Status.details field, or localized by the client.
658 },
659 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
660 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
661 },
662 },
663 },
664 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
665 # This value is inRFC3339
666 # text format.
667 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
668 # following:
669 # `PENDING`, `RUNNING`, or `DONE`.
670 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
671 # operation.
672 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
673 # of the target resource.
674 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
675 # operations related to creating a snapshot, this points to the disk
676 # that the snapshot was created from.
677 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
678 # `[email protected]` or
679 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
680 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
681 # operation, this field will be populated.
682 {
683 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
684 # Engine returns NO_RESULTS_ON_PAGE if there
685 # are no results in the response.
686 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
687 # value format. For example:
688 #
689 # &quot;data&quot;: [
690 # {
691 # &quot;key&quot;: &quot;scope&quot;,
692 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
693 # }
694 {
695 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
696 # returned. For example, for warnings where there are no results in a list
697 # request for a particular zone, this key might be scope and
698 # the key value might be the zone name. Other examples might be a key
699 # indicating a deprecated resource and a suggested replacement, or a
700 # warning about invalid network settings (for example, if an instance
701 # attempts to perform IP forwarding but is not enabled for IP forwarding).
702 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
703 },
704 ],
705 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
706 },
707 ],
708 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
709 # applicable when performing per-zone operations.
710 }</pre>
711 </div>
712
713 <div class="method">
714 <code class="details" id="get">get(folder, globalVmExtensionPolicy, x__xgafv=None)</code>
715 <pre>Gets details of a folder level GlobalVmExtensionPolicy.
716
717 Args:
718 folder: string, Folder ID for this request. (required)
719 globalVmExtensionPolicy: string, Name of the GlobalVmExtensionPolicy resource to return. (required)
720 x__xgafv: string, V1 error format.
721 Allowed values
722 1 - v1 error format
723 2 - v2 error format
724
725 Returns:
726 An object of the form:
727
728 { # Message describing GlobalVmExtensionPolicy object.
729 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
730 # text format.
731 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
732 # create the resource.
733 &quot;extensionPolicies&quot;: { # Required. Map from extension (eg: &quot;cloudops&quot;) to its policy configuration.
734 # The key is the name of the extension.
735 &quot;a_key&quot;: { # Policy for a single extension.
736 &quot;pinnedVersion&quot;: &quot;A String&quot;, # Optional. The version pinning for the extension.
737 # If empty, the extension will be installed with the latest version
738 # released by the extension producer.
739 &quot;stringConfig&quot;: &quot;A String&quot;, # Optional. String configuration. Any string payload that the extension
740 # understands.
741 },
742 },
743 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
744 # defined by the server.
745 &quot;instanceSelectors&quot;: [ # Optional. Selector to target VMs for a policy.
746 # There is a logical &quot;AND&quot; between instance_selectors.
747 { # Selector to target VMs for a zone VM extension policy.
748 &quot;labelSelector&quot;: { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR&#x27;d.
749 # the LabelSelector.
750 &quot;inclusionLabels&quot;: { # Optional. Labels as key value pairs.
751 # A VM should contain all the pairs specified in this map to be selected;
752 # Labels within the LabelSelector are OR&#x27;ed.
753 &quot;a_key&quot;: &quot;A String&quot;,
754 },
755 },
756 },
757 ],
758 &quot;kind&quot;: &quot;compute#globalVmExtensionPolicy&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
759 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
760 # The name must be 1-63 characters long, and comply withRFC1035.
761 # Specifically, the name must be 1-63 characters long and match the regular
762 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
763 # which means the first character must be a lowercase letter, and all
764 # following characters must be a dash, lowercase letter, or digit, except
765 # the last character, which cannot be a dash.
766 &quot;priority&quot;: 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
767 # extension. Defaults to 0.
768 #
769 # Larger the number, higher the priority. When the priority is the same,
770 # the policy with the newer create time has higher priority.
771 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Required. The rollout strategy and status.
772 &quot;rolloutInput&quot;: { # Required. The rollout input which defines the rollout plan.
773 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Optional. Specifies the behavior of the rollout if a conflict is detected in a
774 # project during a rollout. This only applies to `insert` and `update`
775 # methods.
776 #
777 # A conflict occurs in the following cases:
778 #
779 # * `insert` method: If the zonal policy already exists when the insert
780 # happens.
781 # * `update` method: If the zonal policy was modified by a zonal API call
782 # outside of this rollout.
783 #
784 # Possible values are the following:
785 #
786 # * `&quot;&quot;` (empty string): If a conflict occurs, the local value is not
787 # overwritten. This is the default behavior.
788 # * `&quot;overwrite&quot;`: If a conflict occurs, the local value is overwritten
789 # with the rollout value.
790 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the rollout plan.
791 # Ex.
792 # projects//locations/global/rolloutPlans/.
793 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Optional. Specifies the predefined rollout plan for the policy. Valid values
794 # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is
795 # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout
796 # plans for global policies.
797 &quot;retryUuid&quot;: &quot;A String&quot;, # Optional. The UUID that identifies a policy rollout retry attempt for update and
798 # delete operations. Set this field only when retrying a rollout for an
799 # existing extension policy.
800 #
801 # * `update` method: Lets you retry policy rollout without changes.
802 # An error occurs if you set retry_uuid but the policy is modified.
803 # * `delete` method: Lets you retry policy deletion rollout if the
804 # previous deletion rollout is not finished and the policy is in the
805 # DELETING state. If you set this field when the policy is not in the
806 # DELETING state, an error occurs.
807 },
808 &quot;rolloutStatus&quot;: { # Output only. [Output Only] The rollout status of the policy.
809 &quot;currentRollouts&quot;: [ # Output only. [Output Only] The current rollouts for the latest version of the
810 # resource. There should be only one current rollout, but for
811 # scalability, we make it repeated.
812 {
813 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
814 # locations is the same as the list of locations in the rollout plan.
815 &quot;a_key&quot;: {
816 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
817 },
818 },
819 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
820 # Ex. projects//locations/global/rollouts/.
821 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
822 # Ex.
823 # projects//locations/global/rolloutPlans/.
824 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
825 },
826 ],
827 &quot;previousRollout&quot;: { # Output only. [Output Only] The last completed rollout resource. This field will not
828 # be populated until the first rollout is completed.
829 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
830 # locations is the same as the list of locations in the rollout plan.
831 &quot;a_key&quot;: {
832 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
833 },
834 },
835 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
836 # Ex. projects//locations/global/rollouts/.
837 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
838 # Ex.
839 # projects//locations/global/rolloutPlans/.
840 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
841 },
842 },
843 },
844 &quot;scopedResourceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The scoped resource status. It&#x27;s only for tracking the
845 # purging status of the policy.
846 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
847 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
848 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Update timestamp inRFC3339
849 # text format.
850 }</pre>
851 </div>
852
853 <div class="method">
854 <code class="details" id="getVmExtension">getVmExtension(folder, extensionName, x__xgafv=None)</code>
855 <pre>Retrieves details of a specific VM extension.
856
857 Args:
858 folder: string, Folder ID for this request. (required)
859 extensionName: string, A parameter (required)
860 x__xgafv: string, V1 error format.
861 Allowed values
862 1 - v1 error format
863 2 - v2 error format
864
865 Returns:
866 An object of the form:
867
868 {
869 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
870 # text format.
871 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional textual description of the resource.
872 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
873 # defined by the server.
874 &quot;kind&quot;: &quot;compute#globalVmExtension&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtension.
875 &quot;name&quot;: &quot;A String&quot;,
876 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
877 &quot;versions&quot;: [
878 &quot;A String&quot;,
879 ],
880 }</pre>
881 </div>
882
883 <div class="method">
884 <code class="details" id="insert">insert(folder, body=None, requestId=None, x__xgafv=None)</code>
885 <pre>Creates a new folder level GlobalVmExtensionPolicy.
886
887 Args:
888 folder: string, Folder ID for this request. (required)
889 body: object, The request body.
890 The object takes the form of:
891
892 { # Message describing GlobalVmExtensionPolicy object.
893 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
894 # text format.
895 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
896 # create the resource.
897 &quot;extensionPolicies&quot;: { # Required. Map from extension (eg: &quot;cloudops&quot;) to its policy configuration.
898 # The key is the name of the extension.
899 &quot;a_key&quot;: { # Policy for a single extension.
900 &quot;pinnedVersion&quot;: &quot;A String&quot;, # Optional. The version pinning for the extension.
901 # If empty, the extension will be installed with the latest version
902 # released by the extension producer.
903 &quot;stringConfig&quot;: &quot;A String&quot;, # Optional. String configuration. Any string payload that the extension
904 # understands.
905 },
906 },
907 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
908 # defined by the server.
909 &quot;instanceSelectors&quot;: [ # Optional. Selector to target VMs for a policy.
910 # There is a logical &quot;AND&quot; between instance_selectors.
911 { # Selector to target VMs for a zone VM extension policy.
912 &quot;labelSelector&quot;: { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR&#x27;d.
913 # the LabelSelector.
914 &quot;inclusionLabels&quot;: { # Optional. Labels as key value pairs.
915 # A VM should contain all the pairs specified in this map to be selected;
916 # Labels within the LabelSelector are OR&#x27;ed.
917 &quot;a_key&quot;: &quot;A String&quot;,
918 },
919 },
920 },
921 ],
922 &quot;kind&quot;: &quot;compute#globalVmExtensionPolicy&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
923 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
924 # The name must be 1-63 characters long, and comply withRFC1035.
925 # Specifically, the name must be 1-63 characters long and match the regular
926 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
927 # which means the first character must be a lowercase letter, and all
928 # following characters must be a dash, lowercase letter, or digit, except
929 # the last character, which cannot be a dash.
930 &quot;priority&quot;: 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
931 # extension. Defaults to 0.
932 #
933 # Larger the number, higher the priority. When the priority is the same,
934 # the policy with the newer create time has higher priority.
935 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Required. The rollout strategy and status.
936 &quot;rolloutInput&quot;: { # Required. The rollout input which defines the rollout plan.
937 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Optional. Specifies the behavior of the rollout if a conflict is detected in a
938 # project during a rollout. This only applies to `insert` and `update`
939 # methods.
940 #
941 # A conflict occurs in the following cases:
942 #
943 # * `insert` method: If the zonal policy already exists when the insert
944 # happens.
945 # * `update` method: If the zonal policy was modified by a zonal API call
946 # outside of this rollout.
947 #
948 # Possible values are the following:
949 #
950 # * `&quot;&quot;` (empty string): If a conflict occurs, the local value is not
951 # overwritten. This is the default behavior.
952 # * `&quot;overwrite&quot;`: If a conflict occurs, the local value is overwritten
953 # with the rollout value.
954 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the rollout plan.
955 # Ex.
956 # projects//locations/global/rolloutPlans/.
957 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Optional. Specifies the predefined rollout plan for the policy. Valid values
958 # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is
959 # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout
960 # plans for global policies.
961 &quot;retryUuid&quot;: &quot;A String&quot;, # Optional. The UUID that identifies a policy rollout retry attempt for update and
962 # delete operations. Set this field only when retrying a rollout for an
963 # existing extension policy.
964 #
965 # * `update` method: Lets you retry policy rollout without changes.
966 # An error occurs if you set retry_uuid but the policy is modified.
967 # * `delete` method: Lets you retry policy deletion rollout if the
968 # previous deletion rollout is not finished and the policy is in the
969 # DELETING state. If you set this field when the policy is not in the
970 # DELETING state, an error occurs.
971 },
972 &quot;rolloutStatus&quot;: { # Output only. [Output Only] The rollout status of the policy.
973 &quot;currentRollouts&quot;: [ # Output only. [Output Only] The current rollouts for the latest version of the
974 # resource. There should be only one current rollout, but for
975 # scalability, we make it repeated.
976 {
977 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
978 # locations is the same as the list of locations in the rollout plan.
979 &quot;a_key&quot;: {
980 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
981 },
982 },
983 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
984 # Ex. projects//locations/global/rollouts/.
985 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
986 # Ex.
987 # projects//locations/global/rolloutPlans/.
988 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
989 },
990 ],
991 &quot;previousRollout&quot;: { # Output only. [Output Only] The last completed rollout resource. This field will not
992 # be populated until the first rollout is completed.
993 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
994 # locations is the same as the list of locations in the rollout plan.
995 &quot;a_key&quot;: {
996 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
997 },
998 },
999 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
1000 # Ex. projects//locations/global/rollouts/.
1001 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
1002 # Ex.
1003 # projects//locations/global/rolloutPlans/.
1004 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
1005 },
1006 },
1007 },
1008 &quot;scopedResourceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The scoped resource status. It&#x27;s only for tracking the
1009 # purging status of the policy.
1010 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1011 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1012 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Update timestamp inRFC3339
1013 # text format.
1014 }
1015
1016 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1017 that if you must retry your request, the server will know to ignore the
1018 request if it has already been completed.
1019
1020 For example, consider a situation where you make an initial request and
1021 the request times out. If you make the request again with the same
1022 request ID, the server can check if original operation with the same
1023 request ID was received, and if so, will ignore the second request. This
1024 prevents clients from accidentally creating duplicate commitments.
1025
1026 The request ID must be
1027 a valid UUID with the exception that zero UUID is not supported
1028 (00000000-0000-0000-0000-000000000000).
1029 x__xgafv: string, V1 error format.
1030 Allowed values
1031 1 - v1 error format
1032 2 - v2 error format
1033
1034 Returns:
1035 An object of the form:
1036
1037 { # Represents an Operation resource.
1038 #
1039 # Google Compute Engine has three Operation resources:
1040 #
1041 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1042 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1043 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1044 #
1045 # You can use an operation resource to manage asynchronous API requests.
1046 # For more information, readHandling
1047 # API responses.
1048 #
1049 # Operations can be global, regional or zonal.
1050 #
1051 # - For global operations, use the `globalOperations`
1052 # resource.
1053 # - For regional operations, use the
1054 # `regionOperations` resource.
1055 # - For zonal operations, use
1056 # the `zoneOperations` resource.
1057 #
1058 #
1059 #
1060 # For more information, read
1061 # Global, Regional, and Zonal Resources.
1062 #
1063 # Note that completed Operation resources have a limited
1064 # retention period.
1065 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1066 # Not present otherwise.
1067 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1068 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1069 # set when the operation is created.
1070 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1071 # text format.
1072 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1073 # this field will be populated.
1074 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1075 # operation.
1076 {
1077 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1078 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1079 # details. There is a set of defined message types to use for providing
1080 # details.The syntax depends on the error code. For example,
1081 # QuotaExceededInfo will have details when the error code is
1082 # QUOTA_EXCEEDED.
1083 {
1084 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1085 #
1086 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1087 # is not enabled:
1088 #
1089 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1090 # &quot;domain&quot;: &quot;googleapis.com&quot;
1091 # &quot;metadata&quot;: {
1092 # &quot;resource&quot;: &quot;projects/123&quot;,
1093 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1094 # }
1095 # }
1096 #
1097 # This response indicates that the pubsub.googleapis.com API is not enabled.
1098 #
1099 # Example of an error that is returned when attempting to create a Spanner
1100 # instance in a region that is out of stock:
1101 #
1102 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1103 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1104 # &quot;metadata&quot;: {
1105 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1106 # }
1107 # }
1108 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1109 # is typically the registered service name of the tool or product that
1110 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1111 # generated by some common infrastructure, the error domain must be a
1112 # globally unique value that identifies the infrastructure. For Google API
1113 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1114 &quot;metadatas&quot;: { # Additional structured details about this error.
1115 #
1116 # Keys must match a regular expression of `a-z+` but should
1117 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1118 # length. When identifying the current value of an exceeded limit, the units
1119 # should be contained in the key, not the value. For example, rather than
1120 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1121 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1122 # instances that can be created in a single (batch) request.
1123 &quot;a_key&quot;: &quot;A String&quot;,
1124 },
1125 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1126 # proximate cause of the error. Error reasons are unique within a particular
1127 # domain of errors. This should be at most 63 characters and match a
1128 # regular expression of `A-Z+[A-Z0-9]`, which represents
1129 # UPPER_SNAKE_CASE.
1130 },
1131 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1132 #
1133 # For example, if a quota check failed with an error indicating the calling
1134 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1135 # directly to the right place in the developer console to flip the bit.
1136 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1137 { # Describes a URL link.
1138 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1139 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1140 },
1141 ],
1142 },
1143 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1144 # which can be attached to an RPC error.
1145 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1146 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1147 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1148 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1149 },
1150 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1151 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1152 &quot;a_key&quot;: &quot;A String&quot;,
1153 },
1154 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1155 # type or metric.
1156 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1157 # or metric.
1158 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1159 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1160 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1161 },
1162 },
1163 ],
1164 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1165 # This property is optional.
1166 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1167 },
1168 ],
1169 },
1170 &quot;getVersionOperationMetadata&quot;: {
1171 &quot;inlineSbomInfo&quot;: {
1172 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1173 # appropriate identifiers.
1174 &quot;a_key&quot;: &quot;A String&quot;,
1175 },
1176 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1177 # identifiers.
1178 &quot;a_key&quot;: &quot;A String&quot;,
1179 },
1180 },
1181 },
1182 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1183 # message that was returned, such as `NOT FOUND`.
1184 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1185 # status code that was returned. For example, a `404` means the
1186 # resource was not found.
1187 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1188 # defined by the server.
1189 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1190 # This value is inRFC3339
1191 # text format.
1192 &quot;instancesBulkInsertOperationMetadata&quot;: {
1193 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1194 # Example key: zones/us-central1-a
1195 &quot;a_key&quot;: {
1196 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1197 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1198 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1199 # error.
1200 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1201 # if the flow is rolling forward or rolling back.
1202 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1203 },
1204 },
1205 },
1206 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1207 # Operation resources.
1208 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1209 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1210 # group of operations results from a `bulkInsert` API request.
1211 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1212 # `update`, or `delete`, and so on.
1213 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1214 # There is no requirement that this be linear or support any granularity of
1215 # operations. This should not be used to guess when the operation will be
1216 # complete. This number should monotonically increase as the operation
1217 # progresses.
1218 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1219 # applicable when performing regional operations.
1220 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1221 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1222 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1223 # this field will contain information on all underlying zonal actions and
1224 # their state.
1225 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1226 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1227 # Example key: zones/us-central1-a
1228 &quot;a_key&quot;: {
1229 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1230 # populated.
1231 # different programming environments, including REST APIs and RPC APIs. It is
1232 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1233 # three pieces of data: error code, error message, and error details.
1234 #
1235 # You can find out more about this error model and how to work with it in the
1236 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1237 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1238 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1239 # message types for APIs to use.
1240 {
1241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1242 },
1243 ],
1244 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1245 # user-facing error message should be localized and sent in the
1246 # google.rpc.Status.details field, or localized by the client.
1247 },
1248 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1249 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1250 },
1251 },
1252 },
1253 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1254 # This value is inRFC3339
1255 # text format.
1256 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1257 # following:
1258 # `PENDING`, `RUNNING`, or `DONE`.
1259 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1260 # operation.
1261 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1262 # of the target resource.
1263 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1264 # operations related to creating a snapshot, this points to the disk
1265 # that the snapshot was created from.
1266 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1267 # `[email protected]` or
1268 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1269 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1270 # operation, this field will be populated.
1271 {
1272 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1273 # Engine returns NO_RESULTS_ON_PAGE if there
1274 # are no results in the response.
1275 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1276 # value format. For example:
1277 #
1278 # &quot;data&quot;: [
1279 # {
1280 # &quot;key&quot;: &quot;scope&quot;,
1281 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1282 # }
1283 {
1284 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1285 # returned. For example, for warnings where there are no results in a list
1286 # request for a particular zone, this key might be scope and
1287 # the key value might be the zone name. Other examples might be a key
1288 # indicating a deprecated resource and a suggested replacement, or a
1289 # warning about invalid network settings (for example, if an instance
1290 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1291 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1292 },
1293 ],
1294 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1295 },
1296 ],
1297 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1298 # applicable when performing per-zone operations.
1299 }</pre>
1300 </div>
1301
1302 <div class="method">
1303 <code class="details" id="list">list(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1304 <pre>Lists folder level GlobalVmExtensionPolicies.
1305
1306 Args:
1307 folder: string, Folder ID for this request. (required)
1308 filter: string, A filter expression that filters resources listed in the response. Most
1309 Compute resources support two types of filter expressions:
1310 expressions that support regular expressions and expressions that follow
1311 API improvement proposal AIP-160.
1312 These two types of filter expressions cannot be mixed in one request.
1313
1314 If you want to use AIP-160, your expression must specify the field name, an
1315 operator, and the value that you want to use for filtering. The value
1316 must be a string, a number, or a boolean. The operator
1317 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1318
1319 For example, if you are filtering Compute Engine instances, you can
1320 exclude instances named `example-instance` by specifying
1321 `name != example-instance`.
1322
1323 The `:*` comparison can be used to test whether a key has been defined.
1324 For example, to find all objects with `owner` label use:
1325 ```
1326 labels.owner:*
1327 ```
1328
1329 You can also filter nested fields. For example, you could specify
1330 `scheduling.automaticRestart = false` to include instances only
1331 if they are not scheduled for automatic restarts. You can use filtering
1332 on nested fields to filter based onresource labels.
1333
1334 To filter on multiple expressions, provide each separate expression within
1335 parentheses. For example:
1336 ```
1337 (scheduling.automaticRestart = true)
1338 (cpuPlatform = &quot;Intel Skylake&quot;)
1339 ```
1340 By default, each expression is an `AND` expression. However, you
1341 can include `AND` and `OR` expressions explicitly.
1342 For example:
1343 ```
1344 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1345 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1346 (scheduling.automaticRestart = true)
1347 ```
1348
1349 If you want to use a regular expression, use the `eq` (equal) or `ne`
1350 (not equal) operator against a single un-parenthesized expression with or
1351 without quotes or against multiple parenthesized expressions. Examples:
1352
1353 `fieldname eq unquoted literal`
1354 `fieldname eq &#x27;single quoted literal&#x27;`
1355 `fieldname eq &quot;double quoted literal&quot;`
1356 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1357
1358 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1359 The literal value must match the entire field.
1360
1361 For example, to filter for instances that do not end with name &quot;instance&quot;,
1362 you would use `name ne .*instance`.
1363
1364 You cannot combine constraints on multiple fields using regular
1365 expressions.
1366 maxResults: integer, The maximum number of results per page that should be returned.
1367 If the number of available results is larger than `maxResults`,
1368 Compute Engine returns a `nextPageToken` that can be used to get
1369 the next page of results in subsequent list requests. Acceptable values are
1370 `0` to `500`, inclusive. (Default: `500`)
1371 orderBy: string, Sorts list results by a certain order. By default, results
1372 are returned in alphanumerical order based on the resource name.
1373
1374 You can also sort results in descending order based on the creation
1375 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1376 results based on the `creationTimestamp` field in
1377 reverse chronological order (newest result first). Use this to sort
1378 resources like operations so that the newest operation is returned first.
1379
1380 Currently, only sorting by `name` or
1381 `creationTimestamp desc` is supported.
1382 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1383 `nextPageToken` returned by a previous list request to get
1384 the next page of results.
1385 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1386 of failure. The default value is false.
1387
1388 For example, when partial success behavior is enabled, aggregatedList for a
1389 single zone scope either returns all resources in the zone or no resources,
1390 with an error code.
1391 x__xgafv: string, V1 error format.
1392 Allowed values
1393 1 - v1 error format
1394 2 - v2 error format
1395
1396 Returns:
1397 An object of the form:
1398
1399 { # Response to list global VM extension policy resources.
1400 &quot;etag&quot;: &quot;A String&quot;,
1401 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1402 &quot;items&quot;: [ # A list of GlobalVmExtensionPolicy resources.
1403 { # Message describing GlobalVmExtensionPolicy object.
1404 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1405 # text format.
1406 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1407 # create the resource.
1408 &quot;extensionPolicies&quot;: { # Required. Map from extension (eg: &quot;cloudops&quot;) to its policy configuration.
1409 # The key is the name of the extension.
1410 &quot;a_key&quot;: { # Policy for a single extension.
1411 &quot;pinnedVersion&quot;: &quot;A String&quot;, # Optional. The version pinning for the extension.
1412 # If empty, the extension will be installed with the latest version
1413 # released by the extension producer.
1414 &quot;stringConfig&quot;: &quot;A String&quot;, # Optional. String configuration. Any string payload that the extension
1415 # understands.
1416 },
1417 },
1418 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1419 # defined by the server.
1420 &quot;instanceSelectors&quot;: [ # Optional. Selector to target VMs for a policy.
1421 # There is a logical &quot;AND&quot; between instance_selectors.
1422 { # Selector to target VMs for a zone VM extension policy.
1423 &quot;labelSelector&quot;: { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR&#x27;d.
1424 # the LabelSelector.
1425 &quot;inclusionLabels&quot;: { # Optional. Labels as key value pairs.
1426 # A VM should contain all the pairs specified in this map to be selected;
1427 # Labels within the LabelSelector are OR&#x27;ed.
1428 &quot;a_key&quot;: &quot;A String&quot;,
1429 },
1430 },
1431 },
1432 ],
1433 &quot;kind&quot;: &quot;compute#globalVmExtensionPolicy&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
1434 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1435 # The name must be 1-63 characters long, and comply withRFC1035.
1436 # Specifically, the name must be 1-63 characters long and match the regular
1437 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
1438 # which means the first character must be a lowercase letter, and all
1439 # following characters must be a dash, lowercase letter, or digit, except
1440 # the last character, which cannot be a dash.
1441 &quot;priority&quot;: 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
1442 # extension. Defaults to 0.
1443 #
1444 # Larger the number, higher the priority. When the priority is the same,
1445 # the policy with the newer create time has higher priority.
1446 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Required. The rollout strategy and status.
1447 &quot;rolloutInput&quot;: { # Required. The rollout input which defines the rollout plan.
1448 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Optional. Specifies the behavior of the rollout if a conflict is detected in a
1449 # project during a rollout. This only applies to `insert` and `update`
1450 # methods.
1451 #
1452 # A conflict occurs in the following cases:
1453 #
1454 # * `insert` method: If the zonal policy already exists when the insert
1455 # happens.
1456 # * `update` method: If the zonal policy was modified by a zonal API call
1457 # outside of this rollout.
1458 #
1459 # Possible values are the following:
1460 #
1461 # * `&quot;&quot;` (empty string): If a conflict occurs, the local value is not
1462 # overwritten. This is the default behavior.
1463 # * `&quot;overwrite&quot;`: If a conflict occurs, the local value is overwritten
1464 # with the rollout value.
1465 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the rollout plan.
1466 # Ex.
1467 # projects//locations/global/rolloutPlans/.
1468 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Optional. Specifies the predefined rollout plan for the policy. Valid values
1469 # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is
1470 # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout
1471 # plans for global policies.
1472 &quot;retryUuid&quot;: &quot;A String&quot;, # Optional. The UUID that identifies a policy rollout retry attempt for update and
1473 # delete operations. Set this field only when retrying a rollout for an
1474 # existing extension policy.
1475 #
1476 # * `update` method: Lets you retry policy rollout without changes.
1477 # An error occurs if you set retry_uuid but the policy is modified.
1478 # * `delete` method: Lets you retry policy deletion rollout if the
1479 # previous deletion rollout is not finished and the policy is in the
1480 # DELETING state. If you set this field when the policy is not in the
1481 # DELETING state, an error occurs.
1482 },
1483 &quot;rolloutStatus&quot;: { # Output only. [Output Only] The rollout status of the policy.
1484 &quot;currentRollouts&quot;: [ # Output only. [Output Only] The current rollouts for the latest version of the
1485 # resource. There should be only one current rollout, but for
1486 # scalability, we make it repeated.
1487 {
1488 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
1489 # locations is the same as the list of locations in the rollout plan.
1490 &quot;a_key&quot;: {
1491 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
1492 },
1493 },
1494 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
1495 # Ex. projects//locations/global/rollouts/.
1496 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
1497 # Ex.
1498 # projects//locations/global/rolloutPlans/.
1499 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
1500 },
1501 ],
1502 &quot;previousRollout&quot;: { # Output only. [Output Only] The last completed rollout resource. This field will not
1503 # be populated until the first rollout is completed.
1504 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
1505 # locations is the same as the list of locations in the rollout plan.
1506 &quot;a_key&quot;: {
1507 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
1508 },
1509 },
1510 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
1511 # Ex. projects//locations/global/rollouts/.
1512 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
1513 # Ex.
1514 # projects//locations/global/rolloutPlans/.
1515 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
1516 },
1517 },
1518 },
1519 &quot;scopedResourceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The scoped resource status. It&#x27;s only for tracking the
1520 # purging status of the policy.
1521 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1522 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1523 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Update timestamp inRFC3339
1524 # text format.
1525 },
1526 ],
1527 &quot;kind&quot;: &quot;compute#globalVmExtensionPolicyList&quot;, # Output only. Type of resource.
1528 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1529 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1530 # the query parameter pageToken in the next list request.
1531 # Subsequent list requests will have their own nextPageToken to
1532 # continue paging through the results.
1533 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1534 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1535 &quot;A String&quot;,
1536 ],
1537 &quot;warning&quot;: { # [Output Only] Informational warning message.
1538 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1539 # Engine returns NO_RESULTS_ON_PAGE if there
1540 # are no results in the response.
1541 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1542 # value format. For example:
1543 #
1544 # &quot;data&quot;: [
1545 # {
1546 # &quot;key&quot;: &quot;scope&quot;,
1547 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1548 # }
1549 {
1550 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1551 # returned. For example, for warnings where there are no results in a list
1552 # request for a particular zone, this key might be scope and
1553 # the key value might be the zone name. Other examples might be a key
1554 # indicating a deprecated resource and a suggested replacement, or a
1555 # warning about invalid network settings (for example, if an instance
1556 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1557 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1558 },
1559 ],
1560 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1561 },
1562 }</pre>
1563 </div>
1564
1565 <div class="method">
1566 <code class="details" id="listVmExtensions">listVmExtensions(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1567 <pre>Lists all VM extensions within a folder.
1568 This is a read-only API.
1569
1570 Args:
1571 folder: string, Required. Folder ID for this request. (required)
1572 filter: string, A filter expression that filters resources listed in the response. Most
1573 Compute resources support two types of filter expressions:
1574 expressions that support regular expressions and expressions that follow
1575 API improvement proposal AIP-160.
1576 These two types of filter expressions cannot be mixed in one request.
1577
1578 If you want to use AIP-160, your expression must specify the field name, an
1579 operator, and the value that you want to use for filtering. The value
1580 must be a string, a number, or a boolean. The operator
1581 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1582
1583 For example, if you are filtering Compute Engine instances, you can
1584 exclude instances named `example-instance` by specifying
1585 `name != example-instance`.
1586
1587 The `:*` comparison can be used to test whether a key has been defined.
1588 For example, to find all objects with `owner` label use:
1589 ```
1590 labels.owner:*
1591 ```
1592
1593 You can also filter nested fields. For example, you could specify
1594 `scheduling.automaticRestart = false` to include instances only
1595 if they are not scheduled for automatic restarts. You can use filtering
1596 on nested fields to filter based onresource labels.
1597
1598 To filter on multiple expressions, provide each separate expression within
1599 parentheses. For example:
1600 ```
1601 (scheduling.automaticRestart = true)
1602 (cpuPlatform = &quot;Intel Skylake&quot;)
1603 ```
1604 By default, each expression is an `AND` expression. However, you
1605 can include `AND` and `OR` expressions explicitly.
1606 For example:
1607 ```
1608 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1609 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1610 (scheduling.automaticRestart = true)
1611 ```
1612
1613 If you want to use a regular expression, use the `eq` (equal) or `ne`
1614 (not equal) operator against a single un-parenthesized expression with or
1615 without quotes or against multiple parenthesized expressions. Examples:
1616
1617 `fieldname eq unquoted literal`
1618 `fieldname eq &#x27;single quoted literal&#x27;`
1619 `fieldname eq &quot;double quoted literal&quot;`
1620 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1621
1622 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1623 The literal value must match the entire field.
1624
1625 For example, to filter for instances that do not end with name &quot;instance&quot;,
1626 you would use `name ne .*instance`.
1627
1628 You cannot combine constraints on multiple fields using regular
1629 expressions.
1630 maxResults: integer, The maximum number of results per page that should be returned.
1631 If the number of available results is larger than `maxResults`,
1632 Compute Engine returns a `nextPageToken` that can be used to get
1633 the next page of results in subsequent list requests. Acceptable values are
1634 `0` to `500`, inclusive. (Default: `500`)
1635 orderBy: string, Sorts list results by a certain order. By default, results
1636 are returned in alphanumerical order based on the resource name.
1637
1638 You can also sort results in descending order based on the creation
1639 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1640 results based on the `creationTimestamp` field in
1641 reverse chronological order (newest result first). Use this to sort
1642 resources like operations so that the newest operation is returned first.
1643
1644 Currently, only sorting by `name` or
1645 `creationTimestamp desc` is supported.
1646 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1647 `nextPageToken` returned by a previous list request to get
1648 the next page of results.
1649 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1650 of failure. The default value is false.
1651
1652 For example, when partial success behavior is enabled, aggregatedList for a
1653 single zone scope either returns all resources in the zone or no resources,
1654 with an error code.
1655 x__xgafv: string, V1 error format.
1656 Allowed values
1657 1 - v1 error format
1658 2 - v2 error format
1659
1660 Returns:
1661 An object of the form:
1662
1663 {
1664 &quot;etag&quot;: &quot;A String&quot;, # Output only. Fingerprint of this resource. A hash of the contents stored
1665 # in this object. This field is used in optimistic locking. This field will
1666 # be ignored when inserting a VmExtensionPolicy. An up-to-date
1667 # fingerprint must be provided in order to update the VmExtensionPolicy.
1668 #
1669 # To see the latest value of the fingerprint, make a get() request to
1670 # retrieve a VmExtensionPolicy.
1671 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier for the resource; defined by the server.
1672 &quot;items&quot;: [ # Output only. A list of VM extensions.
1673 {
1674 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1675 # text format.
1676 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional textual description of the resource.
1677 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1678 # defined by the server.
1679 &quot;kind&quot;: &quot;compute#globalVmExtension&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtension.
1680 &quot;name&quot;: &quot;A String&quot;,
1681 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1682 &quot;versions&quot;: [
1683 &quot;A String&quot;,
1684 ],
1685 },
1686 ],
1687 &quot;kind&quot;: &quot;compute#globalVmExtensionList&quot;, # Output only. Type of resource.
1688 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. This token allows you to get the next page of results for
1689 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1690 # the query parameter pageToken in the next list request.
1691 # Subsequent list requests will have their own nextPageToken to
1692 # continue paging through the results.
1693 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server-defined URL for this resource.
1694 &quot;unreachables&quot;: [ # Output only. Unreachable resources.
1695 &quot;A String&quot;,
1696 ],
1697 &quot;warning&quot;: { # Output only. Informational warning message.
1698 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1699 # Engine returns NO_RESULTS_ON_PAGE if there
1700 # are no results in the response.
1701 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1702 # value format. For example:
1703 #
1704 # &quot;data&quot;: [
1705 # {
1706 # &quot;key&quot;: &quot;scope&quot;,
1707 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1708 # }
1709 {
1710 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1711 # returned. For example, for warnings where there are no results in a list
1712 # request for a particular zone, this key might be scope and
1713 # the key value might be the zone name. Other examples might be a key
1714 # indicating a deprecated resource and a suggested replacement, or a
1715 # warning about invalid network settings (for example, if an instance
1716 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1717 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1718 },
1719 ],
1720 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1721 },
1722 }</pre>
1723 </div>
1724
1725 <div class="method">
1726 <code class="details" id="listVmExtensions_next">listVmExtensions_next()</code>
1727 <pre>Retrieves the next page of results.
1728
1729 Args:
1730 previous_request: The request for the previous page. (required)
1731 previous_response: The response from the request for the previous page. (required)
1732
1733 Returns:
1734 A request object that you can call &#x27;execute()&#x27; on to request the next
1735 page. Returns None if there are no more items in the collection.
1736 </pre>
1737 </div>
1738
1739 <div class="method">
1740 <code class="details" id="list_next">list_next()</code>
1741 <pre>Retrieves the next page of results.
1742
1743 Args:
1744 previous_request: The request for the previous page. (required)
1745 previous_response: The response from the request for the previous page. (required)
1746
1747 Returns:
1748 A request object that you can call &#x27;execute()&#x27; on to request the next
1749 page. Returns None if there are no more items in the collection.
1750 </pre>
1751 </div>
1752
1753 <div class="method">
1754 <code class="details" id="update">update(folder, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)</code>
1755 <pre>Updates a folder level GlobalVmExtensionPolicy.
1756
1757 Args:
1758 folder: string, Folder ID for this request. (required)
1759 globalVmExtensionPolicy: string, Name of the global VM extension policy to update. (required)
1760 body: object, The request body.
1761 The object takes the form of:
1762
1763 { # Message describing GlobalVmExtensionPolicy object.
1764 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1765 # text format.
1766 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1767 # create the resource.
1768 &quot;extensionPolicies&quot;: { # Required. Map from extension (eg: &quot;cloudops&quot;) to its policy configuration.
1769 # The key is the name of the extension.
1770 &quot;a_key&quot;: { # Policy for a single extension.
1771 &quot;pinnedVersion&quot;: &quot;A String&quot;, # Optional. The version pinning for the extension.
1772 # If empty, the extension will be installed with the latest version
1773 # released by the extension producer.
1774 &quot;stringConfig&quot;: &quot;A String&quot;, # Optional. String configuration. Any string payload that the extension
1775 # understands.
1776 },
1777 },
1778 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1779 # defined by the server.
1780 &quot;instanceSelectors&quot;: [ # Optional. Selector to target VMs for a policy.
1781 # There is a logical &quot;AND&quot; between instance_selectors.
1782 { # Selector to target VMs for a zone VM extension policy.
1783 &quot;labelSelector&quot;: { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR&#x27;d.
1784 # the LabelSelector.
1785 &quot;inclusionLabels&quot;: { # Optional. Labels as key value pairs.
1786 # A VM should contain all the pairs specified in this map to be selected;
1787 # Labels within the LabelSelector are OR&#x27;ed.
1788 &quot;a_key&quot;: &quot;A String&quot;,
1789 },
1790 },
1791 },
1792 ],
1793 &quot;kind&quot;: &quot;compute#globalVmExtensionPolicy&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
1794 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1795 # The name must be 1-63 characters long, and comply withRFC1035.
1796 # Specifically, the name must be 1-63 characters long and match the regular
1797 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
1798 # which means the first character must be a lowercase letter, and all
1799 # following characters must be a dash, lowercase letter, or digit, except
1800 # the last character, which cannot be a dash.
1801 &quot;priority&quot;: 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
1802 # extension. Defaults to 0.
1803 #
1804 # Larger the number, higher the priority. When the priority is the same,
1805 # the policy with the newer create time has higher priority.
1806 &quot;rolloutOperation&quot;: { # Represents the rollout operation # Required. The rollout strategy and status.
1807 &quot;rolloutInput&quot;: { # Required. The rollout input which defines the rollout plan.
1808 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Optional. Specifies the behavior of the rollout if a conflict is detected in a
1809 # project during a rollout. This only applies to `insert` and `update`
1810 # methods.
1811 #
1812 # A conflict occurs in the following cases:
1813 #
1814 # * `insert` method: If the zonal policy already exists when the insert
1815 # happens.
1816 # * `update` method: If the zonal policy was modified by a zonal API call
1817 # outside of this rollout.
1818 #
1819 # Possible values are the following:
1820 #
1821 # * `&quot;&quot;` (empty string): If a conflict occurs, the local value is not
1822 # overwritten. This is the default behavior.
1823 # * `&quot;overwrite&quot;`: If a conflict occurs, the local value is overwritten
1824 # with the rollout value.
1825 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of the rollout plan.
1826 # Ex.
1827 # projects//locations/global/rolloutPlans/.
1828 &quot;predefinedRolloutPlan&quot;: &quot;A String&quot;, # Optional. Specifies the predefined rollout plan for the policy. Valid values
1829 # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is
1830 # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout
1831 # plans for global policies.
1832 &quot;retryUuid&quot;: &quot;A String&quot;, # Optional. The UUID that identifies a policy rollout retry attempt for update and
1833 # delete operations. Set this field only when retrying a rollout for an
1834 # existing extension policy.
1835 #
1836 # * `update` method: Lets you retry policy rollout without changes.
1837 # An error occurs if you set retry_uuid but the policy is modified.
1838 # * `delete` method: Lets you retry policy deletion rollout if the
1839 # previous deletion rollout is not finished and the policy is in the
1840 # DELETING state. If you set this field when the policy is not in the
1841 # DELETING state, an error occurs.
1842 },
1843 &quot;rolloutStatus&quot;: { # Output only. [Output Only] The rollout status of the policy.
1844 &quot;currentRollouts&quot;: [ # Output only. [Output Only] The current rollouts for the latest version of the
1845 # resource. There should be only one current rollout, but for
1846 # scalability, we make it repeated.
1847 {
1848 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
1849 # locations is the same as the list of locations in the rollout plan.
1850 &quot;a_key&quot;: {
1851 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
1852 },
1853 },
1854 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
1855 # Ex. projects//locations/global/rollouts/.
1856 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
1857 # Ex.
1858 # projects//locations/global/rolloutPlans/.
1859 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
1860 },
1861 ],
1862 &quot;previousRollout&quot;: { # Output only. [Output Only] The last completed rollout resource. This field will not
1863 # be populated until the first rollout is completed.
1864 &quot;locationRolloutStatus&quot;: { # Output only. [Output Only] The rollout status for each location. The list of the
1865 # locations is the same as the list of locations in the rollout plan.
1866 &quot;a_key&quot;: {
1867 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The state of the location rollout.
1868 },
1869 },
1870 &quot;rollout&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout.
1871 # Ex. projects//locations/global/rollouts/.
1872 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the rollout plan.
1873 # Ex.
1874 # projects//locations/global/rolloutPlans/.
1875 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The overall state of the rollout.
1876 },
1877 },
1878 },
1879 &quot;scopedResourceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The scoped resource status. It&#x27;s only for tracking the
1880 # purging status of the policy.
1881 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1882 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1883 &quot;updateTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Update timestamp inRFC3339
1884 # text format.
1885 }
1886
1887 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1888 that if you must retry your request, the server will know to ignore the
1889 request if it has already been completed.
1890
1891 For example, consider a situation where you make an initial request and
1892 the request times out. If you make the request again with the same
1893 request ID, the server can check if original operation with the same
1894 request ID was received, and if so, will ignore the second request. This
1895 prevents clients from accidentally creating duplicate commitments.
1896
1897 The request ID must be
1898 a valid UUID with the exception that zero UUID is not supported
1899 (00000000-0000-0000-0000-000000000000).
1900 x__xgafv: string, V1 error format.
1901 Allowed values
1902 1 - v1 error format
1903 2 - v2 error format
1904
1905 Returns:
1906 An object of the form:
1907
1908 { # Represents an Operation resource.
1909 #
1910 # Google Compute Engine has three Operation resources:
1911 #
1912 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1913 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1914 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1915 #
1916 # You can use an operation resource to manage asynchronous API requests.
1917 # For more information, readHandling
1918 # API responses.
1919 #
1920 # Operations can be global, regional or zonal.
1921 #
1922 # - For global operations, use the `globalOperations`
1923 # resource.
1924 # - For regional operations, use the
1925 # `regionOperations` resource.
1926 # - For zonal operations, use
1927 # the `zoneOperations` resource.
1928 #
1929 #
1930 #
1931 # For more information, read
1932 # Global, Regional, and Zonal Resources.
1933 #
1934 # Note that completed Operation resources have a limited
1935 # retention period.
1936 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1937 # Not present otherwise.
1938 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1939 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1940 # set when the operation is created.
1941 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1942 # text format.
1943 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1944 # this field will be populated.
1945 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1946 # operation.
1947 {
1948 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1949 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1950 # details. There is a set of defined message types to use for providing
1951 # details.The syntax depends on the error code. For example,
1952 # QuotaExceededInfo will have details when the error code is
1953 # QUOTA_EXCEEDED.
1954 {
1955 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1956 #
1957 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1958 # is not enabled:
1959 #
1960 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1961 # &quot;domain&quot;: &quot;googleapis.com&quot;
1962 # &quot;metadata&quot;: {
1963 # &quot;resource&quot;: &quot;projects/123&quot;,
1964 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1965 # }
1966 # }
1967 #
1968 # This response indicates that the pubsub.googleapis.com API is not enabled.
1969 #
1970 # Example of an error that is returned when attempting to create a Spanner
1971 # instance in a region that is out of stock:
1972 #
1973 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1974 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1975 # &quot;metadata&quot;: {
1976 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1977 # }
1978 # }
1979 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1980 # is typically the registered service name of the tool or product that
1981 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1982 # generated by some common infrastructure, the error domain must be a
1983 # globally unique value that identifies the infrastructure. For Google API
1984 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1985 &quot;metadatas&quot;: { # Additional structured details about this error.
1986 #
1987 # Keys must match a regular expression of `a-z+` but should
1988 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1989 # length. When identifying the current value of an exceeded limit, the units
1990 # should be contained in the key, not the value. For example, rather than
1991 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1992 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1993 # instances that can be created in a single (batch) request.
1994 &quot;a_key&quot;: &quot;A String&quot;,
1995 },
1996 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1997 # proximate cause of the error. Error reasons are unique within a particular
1998 # domain of errors. This should be at most 63 characters and match a
1999 # regular expression of `A-Z+[A-Z0-9]`, which represents
2000 # UPPER_SNAKE_CASE.
2001 },
2002 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2003 #
2004 # For example, if a quota check failed with an error indicating the calling
2005 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2006 # directly to the right place in the developer console to flip the bit.
2007 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2008 { # Describes a URL link.
2009 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2010 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2011 },
2012 ],
2013 },
2014 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2015 # which can be attached to an RPC error.
2016 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2017 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2018 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2019 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2020 },
2021 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2022 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2023 &quot;a_key&quot;: &quot;A String&quot;,
2024 },
2025 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2026 # type or metric.
2027 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2028 # or metric.
2029 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2030 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2031 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2032 },
2033 },
2034 ],
2035 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2036 # This property is optional.
2037 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2038 },
2039 ],
2040 },
2041 &quot;getVersionOperationMetadata&quot;: {
2042 &quot;inlineSbomInfo&quot;: {
2043 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2044 # appropriate identifiers.
2045 &quot;a_key&quot;: &quot;A String&quot;,
2046 },
2047 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2048 # identifiers.
2049 &quot;a_key&quot;: &quot;A String&quot;,
2050 },
2051 },
2052 },
2053 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2054 # message that was returned, such as `NOT FOUND`.
2055 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2056 # status code that was returned. For example, a `404` means the
2057 # resource was not found.
2058 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2059 # defined by the server.
2060 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2061 # This value is inRFC3339
2062 # text format.
2063 &quot;instancesBulkInsertOperationMetadata&quot;: {
2064 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2065 # Example key: zones/us-central1-a
2066 &quot;a_key&quot;: {
2067 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2068 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2069 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2070 # error.
2071 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2072 # if the flow is rolling forward or rolling back.
2073 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2074 },
2075 },
2076 },
2077 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2078 # Operation resources.
2079 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2080 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2081 # group of operations results from a `bulkInsert` API request.
2082 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2083 # `update`, or `delete`, and so on.
2084 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2085 # There is no requirement that this be linear or support any granularity of
2086 # operations. This should not be used to guess when the operation will be
2087 # complete. This number should monotonically increase as the operation
2088 # progresses.
2089 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2090 # applicable when performing regional operations.
2091 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2092 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2093 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2094 # this field will contain information on all underlying zonal actions and
2095 # their state.
2096 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2097 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2098 # Example key: zones/us-central1-a
2099 &quot;a_key&quot;: {
2100 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2101 # populated.
2102 # different programming environments, including REST APIs and RPC APIs. It is
2103 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2104 # three pieces of data: error code, error message, and error details.
2105 #
2106 # You can find out more about this error model and how to work with it in the
2107 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2108 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2109 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2110 # message types for APIs to use.
2111 {
2112 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2113 },
2114 ],
2115 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2116 # user-facing error message should be localized and sent in the
2117 # google.rpc.Status.details field, or localized by the client.
2118 },
2119 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2120 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2121 },
2122 },
2123 },
2124 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2125 # This value is inRFC3339
2126 # text format.
2127 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2128 # following:
2129 # `PENDING`, `RUNNING`, or `DONE`.
2130 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2131 # operation.
2132 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2133 # of the target resource.
2134 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2135 # operations related to creating a snapshot, this points to the disk
2136 # that the snapshot was created from.
2137 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2138 # `[email protected]` or
2139 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2140 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2141 # operation, this field will be populated.
2142 {
2143 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2144 # Engine returns NO_RESULTS_ON_PAGE if there
2145 # are no results in the response.
2146 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2147 # value format. For example:
2148 #
2149 # &quot;data&quot;: [
2150 # {
2151 # &quot;key&quot;: &quot;scope&quot;,
2152 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2153 # }
2154 {
2155 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2156 # returned. For example, for warnings where there are no results in a list
2157 # request for a particular zone, this key might be scope and
2158 # the key value might be the zone name. Other examples might be a key
2159 # indicating a deprecated resource and a suggested replacement, or a
2160 # warning about invalid network settings (for example, if an instance
2161 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2162 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2163 },
2164 ],
2165 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2166 },
2167 ],
2168 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2169 # applicable when performing per-zone operations.
2170 }</pre>
2171 </div>
2172
2173 </body></html>