Debian Codegraph @

docs/dyn/compute_v1.nodeGroups.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_v1.html">Compute Engine API</a> . <a href="compute_v1.nodeGroups.html">nodeGroups</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds specified number of nodes to the node group.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves an aggregated list of node groups.</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#close">close()</a></code></p>
88 <p class="firstline">Close httplib2 connections.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified NodeGroup resource.</p>
92 <p class="toc_element">
93 <code><a href="#deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes specified nodes from the node group.</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, zone, nodeGroup, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified NodeGroup. Get a list of available NodeGroups</p>
98 <p class="toc_element">
99 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
101 <p class="toc_element">
102 <code><a href="#insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Creates a NodeGroup resource in the specified project using the data</p>
104 <p class="toc_element">
105 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves a list of node groups available to the specified project.</p>
107 <p class="toc_element">
108 <code><a href="#listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Lists nodes in the node group.</p>
110 <p class="toc_element">
111 <code><a href="#listNodes_next">listNodes_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#list_next">list_next()</a></code></p>
115 <p class="firstline">Retrieves the next page of results.</p>
116 <p class="toc_element">
117 <code><a href="#patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Updates the specified node group.</p>
119 <p class="toc_element">
120 <code><a href="#performMaintenance">performMaintenance(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Perform maintenance on a subset of nodes in the node group.</p>
122 <p class="toc_element">
123 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Sets the access control policy on the specified resource.</p>
125 <p class="toc_element">
126 <code><a href="#setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Updates the node template of the node group.</p>
128 <p class="toc_element">
129 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Simulates maintenance event on specified nodes from the node group.</p>
131 <p class="toc_element">
132 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
134 <h3>Method Details</h3>
135 <div class="method">
136 <code class="details" id="addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
137 <pre>Adds specified number of nodes to the node group.
138
139 Args:
140 project: string, Project ID for this request. (required)
141 zone: string, The name of the zone for this request. (required)
142 nodeGroup: string, Name of the NodeGroup resource. (required)
143 body: object, The request body.
144 The object takes the form of:
145
146 {
147 &quot;additionalNodeCount&quot;: 42, # Count of additional nodes to be added to the node group.
148 }
149
150 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
151 that if you must retry your request, the server will know to ignore the
152 request if it has already been completed.
153
154 For example, consider a situation where you make an initial request and
155 the request times out. If you make the request again with the same
156 request ID, the server can check if original operation with the same
157 request ID was received, and if so, will ignore the second request. This
158 prevents clients from accidentally creating duplicate commitments.
159
160 The request ID must be
161 a valid UUID with the exception that zero UUID is not supported
162 (00000000-0000-0000-0000-000000000000).
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # Represents an Operation resource.
172 #
173 # Google Compute Engine has three Operation resources:
174 #
175 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
176 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
177 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
178 #
179 # You can use an operation resource to manage asynchronous API requests.
180 # For more information, readHandling
181 # API responses.
182 #
183 # Operations can be global, regional or zonal.
184 #
185 # - For global operations, use the `globalOperations`
186 # resource.
187 # - For regional operations, use the
188 # `regionOperations` resource.
189 # - For zonal operations, use
190 # the `zoneOperations` resource.
191 #
192 #
193 #
194 # For more information, read
195 # Global, Regional, and Zonal Resources.
196 #
197 # Note that completed Operation resources have a limited
198 # retention period.
199 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
200 # Not present otherwise.
201 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
202 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
203 # set when the operation is created.
204 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
205 # text format.
206 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
207 # this field will be populated.
208 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
209 # operation.
210 {
211 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
212 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
213 # details. There is a set of defined message types to use for providing
214 # details.The syntax depends on the error code. For example,
215 # QuotaExceededInfo will have details when the error code is
216 # QUOTA_EXCEEDED.
217 {
218 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
219 #
220 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
221 # is not enabled:
222 #
223 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
224 # &quot;domain&quot;: &quot;googleapis.com&quot;
225 # &quot;metadata&quot;: {
226 # &quot;resource&quot;: &quot;projects/123&quot;,
227 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
228 # }
229 # }
230 #
231 # This response indicates that the pubsub.googleapis.com API is not enabled.
232 #
233 # Example of an error that is returned when attempting to create a Spanner
234 # instance in a region that is out of stock:
235 #
236 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
237 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
238 # &quot;metadata&quot;: {
239 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
240 # }
241 # }
242 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
243 # is typically the registered service name of the tool or product that
244 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
245 # generated by some common infrastructure, the error domain must be a
246 # globally unique value that identifies the infrastructure. For Google API
247 # infrastructure, the error domain is &quot;googleapis.com&quot;.
248 &quot;metadatas&quot;: { # Additional structured details about this error.
249 #
250 # Keys must match a regular expression of `a-z+` but should
251 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
252 # length. When identifying the current value of an exceeded limit, the units
253 # should be contained in the key, not the value. For example, rather than
254 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
255 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
256 # instances that can be created in a single (batch) request.
257 &quot;a_key&quot;: &quot;A String&quot;,
258 },
259 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
260 # proximate cause of the error. Error reasons are unique within a particular
261 # domain of errors. This should be at most 63 characters and match a
262 # regular expression of `A-Z+[A-Z0-9]`, which represents
263 # UPPER_SNAKE_CASE.
264 },
265 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
266 #
267 # For example, if a quota check failed with an error indicating the calling
268 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
269 # directly to the right place in the developer console to flip the bit.
270 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
271 { # Describes a URL link.
272 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
273 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
274 },
275 ],
276 },
277 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
278 # which can be attached to an RPC error.
279 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
280 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
281 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
282 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
283 },
284 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
285 &quot;dimensions&quot;: { # The map holding related quota dimensions.
286 &quot;a_key&quot;: &quot;A String&quot;,
287 },
288 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
289 # type or metric.
290 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
291 # or metric.
292 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
293 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
294 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
295 },
296 },
297 ],
298 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
299 # This property is optional.
300 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
301 },
302 ],
303 },
304 &quot;getVersionOperationMetadata&quot;: {
305 &quot;inlineSbomInfo&quot;: {
306 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
307 # appropriate identifiers.
308 &quot;a_key&quot;: &quot;A String&quot;,
309 },
310 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
311 # identifiers.
312 &quot;a_key&quot;: &quot;A String&quot;,
313 },
314 },
315 },
316 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
317 # message that was returned, such as `NOT FOUND`.
318 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
319 # status code that was returned. For example, a `404` means the
320 # resource was not found.
321 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
322 # defined by the server.
323 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
324 # This value is inRFC3339
325 # text format.
326 &quot;instancesBulkInsertOperationMetadata&quot;: {
327 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
328 # Example key: zones/us-central1-a
329 &quot;a_key&quot;: {
330 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
331 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
332 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
333 # error.
334 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
335 # if the flow is rolling forward or rolling back.
336 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
337 },
338 },
339 },
340 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
341 # Operation resources.
342 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
343 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
344 # group of operations results from a `bulkInsert` API request.
345 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
346 # `update`, or `delete`, and so on.
347 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
348 # There is no requirement that this be linear or support any granularity of
349 # operations. This should not be used to guess when the operation will be
350 # complete. This number should monotonically increase as the operation
351 # progresses.
352 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
353 # applicable when performing regional operations.
354 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
355 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
356 # this field will contain information on all underlying zonal actions and
357 # their state.
358 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
359 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
360 # Example key: zones/us-central1-a
361 &quot;a_key&quot;: {
362 &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
363 # populated.
364 # different programming environments, including REST APIs and RPC APIs. It is
365 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
366 # three pieces of data: error code, error message, and error details.
367 #
368 # You can find out more about this error model and how to work with it in the
369 # [API Design Guide](https://cloud.google.com/apis/design/errors).
370 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
371 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
372 # message types for APIs to use.
373 {
374 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
375 },
376 ],
377 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
378 # user-facing error message should be localized and sent in the
379 # google.rpc.Status.details field, or localized by the client.
380 },
381 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
382 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
383 },
384 },
385 },
386 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
387 # This value is inRFC3339
388 # text format.
389 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
390 # following:
391 # `PENDING`, `RUNNING`, or `DONE`.
392 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
393 # operation.
394 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
395 # of the target resource.
396 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
397 # operations related to creating a snapshot, this points to the disk
398 # that the snapshot was created from.
399 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
400 # `[email protected]` or
401 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
402 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
403 # operation, this field will be populated.
404 {
405 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
406 # Engine returns NO_RESULTS_ON_PAGE if there
407 # are no results in the response.
408 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
409 # value format. For example:
410 #
411 # &quot;data&quot;: [
412 # {
413 # &quot;key&quot;: &quot;scope&quot;,
414 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
415 # }
416 {
417 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
418 # returned. For example, for warnings where there are no results in a list
419 # request for a particular zone, this key might be scope and
420 # the key value might be the zone name. Other examples might be a key
421 # indicating a deprecated resource and a suggested replacement, or a
422 # warning about invalid network settings (for example, if an instance
423 # attempts to perform IP forwarding but is not enabled for IP forwarding).
424 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
425 },
426 ],
427 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
428 },
429 ],
430 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
431 # applicable when performing per-zone operations.
432 }</pre>
433 </div>
434
435 <div class="method">
436 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
437 <pre>Retrieves an aggregated list of node groups.
438 Note: use nodeGroups.listNodes for more details about each group.
439
440 To prevent failure, Google recommends that you set the
441 `returnPartialSuccess` parameter to `true`.
442
443 Args:
444 project: string, Project ID for this request. (required)
445 filter: string, A filter expression that filters resources listed in the response. Most
446 Compute resources support two types of filter expressions:
447 expressions that support regular expressions and expressions that follow
448 API improvement proposal AIP-160.
449 These two types of filter expressions cannot be mixed in one request.
450
451 If you want to use AIP-160, your expression must specify the field name, an
452 operator, and the value that you want to use for filtering. The value
453 must be a string, a number, or a boolean. The operator
454 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
455
456 For example, if you are filtering Compute Engine instances, you can
457 exclude instances named `example-instance` by specifying
458 `name != example-instance`.
459
460 The `:*` comparison can be used to test whether a key has been defined.
461 For example, to find all objects with `owner` label use:
462 ```
463 labels.owner:*
464 ```
465
466 You can also filter nested fields. For example, you could specify
467 `scheduling.automaticRestart = false` to include instances only
468 if they are not scheduled for automatic restarts. You can use filtering
469 on nested fields to filter based onresource labels.
470
471 To filter on multiple expressions, provide each separate expression within
472 parentheses. For example:
473 ```
474 (scheduling.automaticRestart = true)
475 (cpuPlatform = &quot;Intel Skylake&quot;)
476 ```
477 By default, each expression is an `AND` expression. However, you
478 can include `AND` and `OR` expressions explicitly.
479 For example:
480 ```
481 (cpuPlatform = &quot;Intel Skylake&quot;) OR
482 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
483 (scheduling.automaticRestart = true)
484 ```
485
486 If you want to use a regular expression, use the `eq` (equal) or `ne`
487 (not equal) operator against a single un-parenthesized expression with or
488 without quotes or against multiple parenthesized expressions. Examples:
489
490 `fieldname eq unquoted literal`
491 `fieldname eq &#x27;single quoted literal&#x27;`
492 `fieldname eq &quot;double quoted literal&quot;`
493 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
494
495 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
496 The literal value must match the entire field.
497
498 For example, to filter for instances that do not end with name &quot;instance&quot;,
499 you would use `name ne .*instance`.
500
501 You cannot combine constraints on multiple fields using regular
502 expressions.
503 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
504 global) should be included in the response. For new resource types added
505 after this field, the flag has no effect as new resource types will always
506 include every visible scope for each scope type in response. For resource
507 types which predate this field, if this flag is omitted or false, only
508 scopes of the scope types where the resource type is expected to be found
509 will be included.
510 maxResults: integer, The maximum number of results per page that should be returned.
511 If the number of available results is larger than `maxResults`,
512 Compute Engine returns a `nextPageToken` that can be used to get
513 the next page of results in subsequent list requests. Acceptable values are
514 `0` to `500`, inclusive. (Default: `500`)
515 orderBy: string, Sorts list results by a certain order. By default, results
516 are returned in alphanumerical order based on the resource name.
517
518 You can also sort results in descending order based on the creation
519 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
520 results based on the `creationTimestamp` field in
521 reverse chronological order (newest result first). Use this to sort
522 resources like operations so that the newest operation is returned first.
523
524 Currently, only sorting by `name` or
525 `creationTimestamp desc` is supported.
526 pageToken: string, Specifies a page token to use. Set `pageToken` to the
527 `nextPageToken` returned by a previous list request to get
528 the next page of results.
529 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
530 of failure. The default value is false.
531
532 For example, when partial success behavior is enabled, aggregatedList for a
533 single zone scope either returns all resources in the zone or no resources,
534 with an error code.
535 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
536 aggregated list request is invoked for subnetworks list-usable api.
537 x__xgafv: string, V1 error format.
538 Allowed values
539 1 - v1 error format
540 2 - v2 error format
541
542 Returns:
543 An object of the form:
544
545 {
546 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
547 &quot;items&quot;: { # A list of NodeGroupsScopedList resources.
548 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of node groups.
549 &quot;nodeGroups&quot;: [ # [Output Only] A list of node groups contained in this scope.
550 { # Represents a sole-tenant Node Group resource.
551 #
552 # A sole-tenant node is a physical server that is dedicated to
553 # hosting VM instances only for your specific project. Use sole-tenant nodes to
554 # keep your instances physically separated from instances in other projects, or
555 # to group your instances together on the same host hardware. For more
556 # information, readSole-tenant nodes.
557 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
558 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if
559 # autoscaling is enabled. Maximum value allowed is 100.
560 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
561 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF,
562 # or ONLY_SCALE_OUT. For more information, see
563 # Autoscaler modes.
564 },
565 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
566 # text format.
567 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
568 # create the resource.
569 &quot;fingerprint&quot;: &quot;A String&quot;,
570 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
571 # defined by the server.
572 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.
573 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other
574 # resources.
575 # This field is for use by internal tools that use the public API.
576 # The location hint here on the NodeGroup overrides any location_hint
577 # present in the NodeTemplate.
578 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
579 # are: `AS_NEEDED` and `RECURRENT`.
580 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes
581 # maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.
582 # The default value is DEFAULT. For more information, see
583 # Maintenance policies.
584 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal
585 # maintenance will be performed within this window.
586 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented # Output only. [Output only] A predetermined duration for the window, automatically
587 # chosen to be the smallest possible in the given scenario.
588 # as a count of seconds and fractions of seconds at nanosecond
589 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
590 # or &quot;month&quot;. Range is approximately 10,000 years.
591 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
592 # Durations less than one second are represented with a 0
593 # `seconds` field and a positive `nanos` field. Must be from 0
594 # to 999,999,999 inclusive.
595 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
596 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
597 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
598 },
599 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one
600 # of 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For
601 # example, both 13:00-5 and 08:00 are valid.
602 },
603 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
604 # the resource. The resource name must be 1-63 characters long, and comply
605 # withRFC1035.
606 # Specifically, the name must be 1-63 characters long and match the regular
607 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
608 # character must be a lowercase letter, and all following characters must be
609 # a dash, lowercase letter, or digit, except the last character, which cannot
610 # be a dash.
611 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
612 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
613 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
614 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
615 # share_type&#x27;s value is SPECIFIC_PROJECTS.
616 &quot;a_key&quot;: { # Config for each project in the share settings.
617 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
618 # parent map.
619 },
620 },
621 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
622 },
623 &quot;size&quot;: 42, # Output only. [Output Only] The total number of nodes in the node group.
624 &quot;status&quot;: &quot;A String&quot;,
625 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone where the node group resides,
626 # such as us-central1-a.
627 },
628 ],
629 &quot;warning&quot;: { # [Output Only] An informational warning that appears when the nodeGroup
630 # list is empty.
631 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
632 # Engine returns NO_RESULTS_ON_PAGE if there
633 # are no results in the response.
634 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
635 # value format. For example:
636 #
637 # &quot;data&quot;: [
638 # {
639 # &quot;key&quot;: &quot;scope&quot;,
640 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
641 # }
642 {
643 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
644 # returned. For example, for warnings where there are no results in a list
645 # request for a particular zone, this key might be scope and
646 # the key value might be the zone name. Other examples might be a key
647 # indicating a deprecated resource and a suggested replacement, or a
648 # warning about invalid network settings (for example, if an instance
649 # attempts to perform IP forwarding but is not enabled for IP forwarding).
650 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
651 },
652 ],
653 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
654 },
655 },
656 },
657 &quot;kind&quot;: &quot;compute#nodeGroupAggregatedList&quot;, # Output only. [Output Only] Type of resource.Alwayscompute#nodeGroupAggregatedList for aggregated lists of node
658 # groups.
659 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
660 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
661 # the query parameter pageToken in the next list request.
662 # Subsequent list requests will have their own nextPageToken to
663 # continue paging through the results.
664 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
665 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
666 &quot;A String&quot;,
667 ],
668 &quot;warning&quot;: { # [Output Only] Informational warning message.
669 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
670 # Engine returns NO_RESULTS_ON_PAGE if there
671 # are no results in the response.
672 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
673 # value format. For example:
674 #
675 # &quot;data&quot;: [
676 # {
677 # &quot;key&quot;: &quot;scope&quot;,
678 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
679 # }
680 {
681 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
682 # returned. For example, for warnings where there are no results in a list
683 # request for a particular zone, this key might be scope and
684 # the key value might be the zone name. Other examples might be a key
685 # indicating a deprecated resource and a suggested replacement, or a
686 # warning about invalid network settings (for example, if an instance
687 # attempts to perform IP forwarding but is not enabled for IP forwarding).
688 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
689 },
690 ],
691 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
692 },
693 }</pre>
694 </div>
695
696 <div class="method">
697 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
698 <pre>Retrieves the next page of results.
699
700 Args:
701 previous_request: The request for the previous page. (required)
702 previous_response: The response from the request for the previous page. (required)
703
704 Returns:
705 A request object that you can call &#x27;execute()&#x27; on to request the next
706 page. Returns None if there are no more items in the collection.
707 </pre>
708 </div>
709
710 <div class="method">
711 <code class="details" id="close">close()</code>
712 <pre>Close httplib2 connections.</pre>
713 </div>
714
715 <div class="method">
716 <code class="details" id="delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</code>
717 <pre>Deletes the specified NodeGroup resource.
718
719 Args:
720 project: string, Project ID for this request. (required)
721 zone: string, The name of the zone for this request. (required)
722 nodeGroup: string, Name of the NodeGroup resource to delete. (required)
723 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
724 that if you must retry your request, the server will know to ignore the
725 request if it has already been completed.
726
727 For example, consider a situation where you make an initial request and
728 the request times out. If you make the request again with the same
729 request ID, the server can check if original operation with the same
730 request ID was received, and if so, will ignore the second request. This
731 prevents clients from accidentally creating duplicate commitments.
732
733 The request ID must be
734 a valid UUID with the exception that zero UUID is not supported
735 (00000000-0000-0000-0000-000000000000).
736 x__xgafv: string, V1 error format.
737 Allowed values
738 1 - v1 error format
739 2 - v2 error format
740
741 Returns:
742 An object of the form:
743
744 { # Represents an Operation resource.
745 #
746 # Google Compute Engine has three Operation resources:
747 #
748 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
749 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
750 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
751 #
752 # You can use an operation resource to manage asynchronous API requests.
753 # For more information, readHandling
754 # API responses.
755 #
756 # Operations can be global, regional or zonal.
757 #
758 # - For global operations, use the `globalOperations`
759 # resource.
760 # - For regional operations, use the
761 # `regionOperations` resource.
762 # - For zonal operations, use
763 # the `zoneOperations` resource.
764 #
765 #
766 #
767 # For more information, read
768 # Global, Regional, and Zonal Resources.
769 #
770 # Note that completed Operation resources have a limited
771 # retention period.
772 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
773 # Not present otherwise.
774 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
775 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
776 # set when the operation is created.
777 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
778 # text format.
779 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
780 # this field will be populated.
781 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
782 # operation.
783 {
784 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
785 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
786 # details. There is a set of defined message types to use for providing
787 # details.The syntax depends on the error code. For example,
788 # QuotaExceededInfo will have details when the error code is
789 # QUOTA_EXCEEDED.
790 {
791 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
792 #
793 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
794 # is not enabled:
795 #
796 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
797 # &quot;domain&quot;: &quot;googleapis.com&quot;
798 # &quot;metadata&quot;: {
799 # &quot;resource&quot;: &quot;projects/123&quot;,
800 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
801 # }
802 # }
803 #
804 # This response indicates that the pubsub.googleapis.com API is not enabled.
805 #
806 # Example of an error that is returned when attempting to create a Spanner
807 # instance in a region that is out of stock:
808 #
809 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
810 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
811 # &quot;metadata&quot;: {
812 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
813 # }
814 # }
815 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
816 # is typically the registered service name of the tool or product that
817 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
818 # generated by some common infrastructure, the error domain must be a
819 # globally unique value that identifies the infrastructure. For Google API
820 # infrastructure, the error domain is &quot;googleapis.com&quot;.
821 &quot;metadatas&quot;: { # Additional structured details about this error.
822 #
823 # Keys must match a regular expression of `a-z+` but should
824 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
825 # length. When identifying the current value of an exceeded limit, the units
826 # should be contained in the key, not the value. For example, rather than
827 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
828 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
829 # instances that can be created in a single (batch) request.
830 &quot;a_key&quot;: &quot;A String&quot;,
831 },
832 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
833 # proximate cause of the error. Error reasons are unique within a particular
834 # domain of errors. This should be at most 63 characters and match a
835 # regular expression of `A-Z+[A-Z0-9]`, which represents
836 # UPPER_SNAKE_CASE.
837 },
838 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
839 #
840 # For example, if a quota check failed with an error indicating the calling
841 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
842 # directly to the right place in the developer console to flip the bit.
843 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
844 { # Describes a URL link.
845 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
846 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
847 },
848 ],
849 },
850 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
851 # which can be attached to an RPC error.
852 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
853 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
854 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
855 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
856 },
857 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
858 &quot;dimensions&quot;: { # The map holding related quota dimensions.
859 &quot;a_key&quot;: &quot;A String&quot;,
860 },
861 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
862 # type or metric.
863 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
864 # or metric.
865 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
866 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
867 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
868 },
869 },
870 ],
871 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
872 # This property is optional.
873 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
874 },
875 ],
876 },
877 &quot;getVersionOperationMetadata&quot;: {
878 &quot;inlineSbomInfo&quot;: {
879 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
880 # appropriate identifiers.
881 &quot;a_key&quot;: &quot;A String&quot;,
882 },
883 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
884 # identifiers.
885 &quot;a_key&quot;: &quot;A String&quot;,
886 },
887 },
888 },
889 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
890 # message that was returned, such as `NOT FOUND`.
891 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
892 # status code that was returned. For example, a `404` means the
893 # resource was not found.
894 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
895 # defined by the server.
896 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
897 # This value is inRFC3339
898 # text format.
899 &quot;instancesBulkInsertOperationMetadata&quot;: {
900 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
901 # Example key: zones/us-central1-a
902 &quot;a_key&quot;: {
903 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
904 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
905 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
906 # error.
907 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
908 # if the flow is rolling forward or rolling back.
909 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
910 },
911 },
912 },
913 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
914 # Operation resources.
915 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
916 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
917 # group of operations results from a `bulkInsert` API request.
918 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
919 # `update`, or `delete`, and so on.
920 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
921 # There is no requirement that this be linear or support any granularity of
922 # operations. This should not be used to guess when the operation will be
923 # complete. This number should monotonically increase as the operation
924 # progresses.
925 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
926 # applicable when performing regional operations.
927 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
928 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
929 # this field will contain information on all underlying zonal actions and
930 # their state.
931 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
932 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
933 # Example key: zones/us-central1-a
934 &quot;a_key&quot;: {
935 &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
936 # populated.
937 # different programming environments, including REST APIs and RPC APIs. It is
938 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
939 # three pieces of data: error code, error message, and error details.
940 #
941 # You can find out more about this error model and how to work with it in the
942 # [API Design Guide](https://cloud.google.com/apis/design/errors).
943 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
944 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
945 # message types for APIs to use.
946 {
947 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
948 },
949 ],
950 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
951 # user-facing error message should be localized and sent in the
952 # google.rpc.Status.details field, or localized by the client.
953 },
954 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
955 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
956 },
957 },
958 },
959 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
960 # This value is inRFC3339
961 # text format.
962 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
963 # following:
964 # `PENDING`, `RUNNING`, or `DONE`.
965 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
966 # operation.
967 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
968 # of the target resource.
969 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
970 # operations related to creating a snapshot, this points to the disk
971 # that the snapshot was created from.
972 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
973 # `[email protected]` or
974 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
975 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
976 # operation, this field will be populated.
977 {
978 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
979 # Engine returns NO_RESULTS_ON_PAGE if there
980 # are no results in the response.
981 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
982 # value format. For example:
983 #
984 # &quot;data&quot;: [
985 # {
986 # &quot;key&quot;: &quot;scope&quot;,
987 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
988 # }
989 {
990 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
991 # returned. For example, for warnings where there are no results in a list
992 # request for a particular zone, this key might be scope and
993 # the key value might be the zone name. Other examples might be a key
994 # indicating a deprecated resource and a suggested replacement, or a
995 # warning about invalid network settings (for example, if an instance
996 # attempts to perform IP forwarding but is not enabled for IP forwarding).
997 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
998 },
999 ],
1000 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1001 },
1002 ],
1003 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1004 # applicable when performing per-zone operations.
1005 }</pre>
1006 </div>
1007
1008 <div class="method">
1009 <code class="details" id="deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
1010 <pre>Deletes specified nodes from the node group.
1011
1012 Args:
1013 project: string, Project ID for this request. (required)
1014 zone: string, The name of the zone for this request. (required)
1015 nodeGroup: string, Name of the NodeGroup resource whose nodes will be deleted. (required)
1016 body: object, The request body.
1017 The object takes the form of:
1018
1019 {
1020 &quot;nodes&quot;: [ # Names of the nodes to delete.
1021 &quot;A String&quot;,
1022 ],
1023 }
1024
1025 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1026 that if you must retry your request, the server will know to ignore the
1027 request if it has already been completed.
1028
1029 For example, consider a situation where you make an initial request and
1030 the request times out. If you make the request again with the same
1031 request ID, the server can check if original operation with the same
1032 request ID was received, and if so, will ignore the second request. This
1033 prevents clients from accidentally creating duplicate commitments.
1034
1035 The request ID must be
1036 a valid UUID with the exception that zero UUID is not supported
1037 (00000000-0000-0000-0000-000000000000).
1038 x__xgafv: string, V1 error format.
1039 Allowed values
1040 1 - v1 error format
1041 2 - v2 error format
1042
1043 Returns:
1044 An object of the form:
1045
1046 { # Represents an Operation resource.
1047 #
1048 # Google Compute Engine has three Operation resources:
1049 #
1050 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1051 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1052 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1053 #
1054 # You can use an operation resource to manage asynchronous API requests.
1055 # For more information, readHandling
1056 # API responses.
1057 #
1058 # Operations can be global, regional or zonal.
1059 #
1060 # - For global operations, use the `globalOperations`
1061 # resource.
1062 # - For regional operations, use the
1063 # `regionOperations` resource.
1064 # - For zonal operations, use
1065 # the `zoneOperations` resource.
1066 #
1067 #
1068 #
1069 # For more information, read
1070 # Global, Regional, and Zonal Resources.
1071 #
1072 # Note that completed Operation resources have a limited
1073 # retention period.
1074 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1075 # Not present otherwise.
1076 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1077 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1078 # set when the operation is created.
1079 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1080 # text format.
1081 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1082 # this field will be populated.
1083 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1084 # operation.
1085 {
1086 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1087 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1088 # details. There is a set of defined message types to use for providing
1089 # details.The syntax depends on the error code. For example,
1090 # QuotaExceededInfo will have details when the error code is
1091 # QUOTA_EXCEEDED.
1092 {
1093 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1094 #
1095 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1096 # is not enabled:
1097 #
1098 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1099 # &quot;domain&quot;: &quot;googleapis.com&quot;
1100 # &quot;metadata&quot;: {
1101 # &quot;resource&quot;: &quot;projects/123&quot;,
1102 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1103 # }
1104 # }
1105 #
1106 # This response indicates that the pubsub.googleapis.com API is not enabled.
1107 #
1108 # Example of an error that is returned when attempting to create a Spanner
1109 # instance in a region that is out of stock:
1110 #
1111 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1112 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1113 # &quot;metadata&quot;: {
1114 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1115 # }
1116 # }
1117 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1118 # is typically the registered service name of the tool or product that
1119 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1120 # generated by some common infrastructure, the error domain must be a
1121 # globally unique value that identifies the infrastructure. For Google API
1122 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1123 &quot;metadatas&quot;: { # Additional structured details about this error.
1124 #
1125 # Keys must match a regular expression of `a-z+` but should
1126 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1127 # length. When identifying the current value of an exceeded limit, the units
1128 # should be contained in the key, not the value. For example, rather than
1129 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1130 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1131 # instances that can be created in a single (batch) request.
1132 &quot;a_key&quot;: &quot;A String&quot;,
1133 },
1134 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1135 # proximate cause of the error. Error reasons are unique within a particular
1136 # domain of errors. This should be at most 63 characters and match a
1137 # regular expression of `A-Z+[A-Z0-9]`, which represents
1138 # UPPER_SNAKE_CASE.
1139 },
1140 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1141 #
1142 # For example, if a quota check failed with an error indicating the calling
1143 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1144 # directly to the right place in the developer console to flip the bit.
1145 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1146 { # Describes a URL link.
1147 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1148 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1149 },
1150 ],
1151 },
1152 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1153 # which can be attached to an RPC error.
1154 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1155 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1156 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1157 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1158 },
1159 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1160 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1161 &quot;a_key&quot;: &quot;A String&quot;,
1162 },
1163 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1164 # type or metric.
1165 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1166 # or metric.
1167 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1168 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1169 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1170 },
1171 },
1172 ],
1173 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1174 # This property is optional.
1175 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1176 },
1177 ],
1178 },
1179 &quot;getVersionOperationMetadata&quot;: {
1180 &quot;inlineSbomInfo&quot;: {
1181 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1182 # appropriate identifiers.
1183 &quot;a_key&quot;: &quot;A String&quot;,
1184 },
1185 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1186 # identifiers.
1187 &quot;a_key&quot;: &quot;A String&quot;,
1188 },
1189 },
1190 },
1191 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1192 # message that was returned, such as `NOT FOUND`.
1193 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1194 # status code that was returned. For example, a `404` means the
1195 # resource was not found.
1196 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1197 # defined by the server.
1198 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1199 # This value is inRFC3339
1200 # text format.
1201 &quot;instancesBulkInsertOperationMetadata&quot;: {
1202 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1203 # Example key: zones/us-central1-a
1204 &quot;a_key&quot;: {
1205 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1206 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1207 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1208 # error.
1209 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1210 # if the flow is rolling forward or rolling back.
1211 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1212 },
1213 },
1214 },
1215 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1216 # Operation resources.
1217 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1218 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1219 # group of operations results from a `bulkInsert` API request.
1220 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1221 # `update`, or `delete`, and so on.
1222 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1223 # There is no requirement that this be linear or support any granularity of
1224 # operations. This should not be used to guess when the operation will be
1225 # complete. This number should monotonically increase as the operation
1226 # progresses.
1227 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1228 # applicable when performing regional operations.
1229 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1230 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1231 # this field will contain information on all underlying zonal actions and
1232 # their state.
1233 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1234 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1235 # Example key: zones/us-central1-a
1236 &quot;a_key&quot;: {
1237 &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
1238 # populated.
1239 # different programming environments, including REST APIs and RPC APIs. It is
1240 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1241 # three pieces of data: error code, error message, and error details.
1242 #
1243 # You can find out more about this error model and how to work with it in the
1244 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1245 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1246 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1247 # message types for APIs to use.
1248 {
1249 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1250 },
1251 ],
1252 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1253 # user-facing error message should be localized and sent in the
1254 # google.rpc.Status.details field, or localized by the client.
1255 },
1256 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1257 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1258 },
1259 },
1260 },
1261 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1262 # This value is inRFC3339
1263 # text format.
1264 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1265 # following:
1266 # `PENDING`, `RUNNING`, or `DONE`.
1267 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1268 # operation.
1269 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1270 # of the target resource.
1271 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1272 # operations related to creating a snapshot, this points to the disk
1273 # that the snapshot was created from.
1274 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1275 # `[email protected]` or
1276 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1277 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1278 # operation, this field will be populated.
1279 {
1280 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1281 # Engine returns NO_RESULTS_ON_PAGE if there
1282 # are no results in the response.
1283 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1284 # value format. For example:
1285 #
1286 # &quot;data&quot;: [
1287 # {
1288 # &quot;key&quot;: &quot;scope&quot;,
1289 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1290 # }
1291 {
1292 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1293 # returned. For example, for warnings where there are no results in a list
1294 # request for a particular zone, this key might be scope and
1295 # the key value might be the zone name. Other examples might be a key
1296 # indicating a deprecated resource and a suggested replacement, or a
1297 # warning about invalid network settings (for example, if an instance
1298 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1299 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1300 },
1301 ],
1302 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1303 },
1304 ],
1305 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1306 # applicable when performing per-zone operations.
1307 }</pre>
1308 </div>
1309
1310 <div class="method">
1311 <code class="details" id="get">get(project, zone, nodeGroup, x__xgafv=None)</code>
1312 <pre>Returns the specified NodeGroup. Get a list of available NodeGroups
1313 by making a list() request.
1314 Note: the &quot;nodes&quot; field should not be used. Use nodeGroups.listNodes
1315 instead.
1316
1317 Args:
1318 project: string, Project ID for this request. (required)
1319 zone: string, The name of the zone for this request. (required)
1320 nodeGroup: string, Name of the node group to return. (required)
1321 x__xgafv: string, V1 error format.
1322 Allowed values
1323 1 - v1 error format
1324 2 - v2 error format
1325
1326 Returns:
1327 An object of the form:
1328
1329 { # Represents a sole-tenant Node Group resource.
1330 #
1331 # A sole-tenant node is a physical server that is dedicated to
1332 # hosting VM instances only for your specific project. Use sole-tenant nodes to
1333 # keep your instances physically separated from instances in other projects, or
1334 # to group your instances together on the same host hardware. For more
1335 # information, readSole-tenant nodes.
1336 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
1337 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if
1338 # autoscaling is enabled. Maximum value allowed is 100.
1339 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
1340 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF,
1341 # or ONLY_SCALE_OUT. For more information, see
1342 # Autoscaler modes.
1343 },
1344 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1345 # text format.
1346 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1347 # create the resource.
1348 &quot;fingerprint&quot;: &quot;A String&quot;,
1349 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1350 # defined by the server.
1351 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.
1352 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other
1353 # resources.
1354 # This field is for use by internal tools that use the public API.
1355 # The location hint here on the NodeGroup overrides any location_hint
1356 # present in the NodeTemplate.
1357 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
1358 # are: `AS_NEEDED` and `RECURRENT`.
1359 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes
1360 # maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.
1361 # The default value is DEFAULT. For more information, see
1362 # Maintenance policies.
1363 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal
1364 # maintenance will be performed within this window.
1365 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented # Output only. [Output only] A predetermined duration for the window, automatically
1366 # chosen to be the smallest possible in the given scenario.
1367 # as a count of seconds and fractions of seconds at nanosecond
1368 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1369 # or &quot;month&quot;. Range is approximately 10,000 years.
1370 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1371 # Durations less than one second are represented with a 0
1372 # `seconds` field and a positive `nanos` field. Must be from 0
1373 # to 999,999,999 inclusive.
1374 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1375 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1376 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1377 },
1378 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one
1379 # of 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For
1380 # example, both 13:00-5 and 08:00 are valid.
1381 },
1382 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1383 # the resource. The resource name must be 1-63 characters long, and comply
1384 # withRFC1035.
1385 # Specifically, the name must be 1-63 characters long and match the regular
1386 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1387 # character must be a lowercase letter, and all following characters must be
1388 # a dash, lowercase letter, or digit, except the last character, which cannot
1389 # be a dash.
1390 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
1391 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1392 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
1393 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1394 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1395 &quot;a_key&quot;: { # Config for each project in the share settings.
1396 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1397 # parent map.
1398 },
1399 },
1400 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1401 },
1402 &quot;size&quot;: 42, # Output only. [Output Only] The total number of nodes in the node group.
1403 &quot;status&quot;: &quot;A String&quot;,
1404 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone where the node group resides,
1405 # such as us-central1-a.
1406 }</pre>
1407 </div>
1408
1409 <div class="method">
1410 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1411 <pre>Gets the access control policy for a resource. May be empty if no such
1412 policy or resource exists.
1413
1414 Args:
1415 project: string, Project ID for this request. (required)
1416 zone: string, The name of the zone for this request. (required)
1417 resource: string, Name or id of the resource for this request. (required)
1418 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1419 x__xgafv: string, V1 error format.
1420 Allowed values
1421 1 - v1 error format
1422 2 - v2 error format
1423
1424 Returns:
1425 An object of the form:
1426
1427 { # An Identity and Access Management (IAM) policy, which specifies access
1428 # controls for Google Cloud resources.
1429 #
1430 #
1431 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1432 # `members`, or principals, to a single `role`. Principals can be user
1433 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1434 # `role` is a named list of permissions; each `role` can be an IAM predefined
1435 # role or a user-created custom role.
1436 #
1437 # For some types of Google Cloud resources, a `binding` can also specify a
1438 # `condition`, which is a logical expression that allows access to a resource
1439 # only if the expression evaluates to `true`. A condition can add constraints
1440 # based on attributes of the request, the resource, or both. To learn which
1441 # resources support conditions in their IAM policies, see the
1442 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1443 #
1444 # **JSON example:**
1445 #
1446 # ```
1447 # {
1448 # &quot;bindings&quot;: [
1449 # {
1450 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1451 # &quot;members&quot;: [
1452 # &quot;user:[email protected]&quot;,
1453 # &quot;group:[email protected]&quot;,
1454 # &quot;domain:google.com&quot;,
1455 # &quot;serviceAccount:[email protected]&quot;
1456 # ]
1457 # },
1458 # {
1459 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1460 # &quot;members&quot;: [
1461 # &quot;user:[email protected]&quot;
1462 # ],
1463 # &quot;condition&quot;: {
1464 # &quot;title&quot;: &quot;expirable access&quot;,
1465 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1466 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1467 # }
1468 # }
1469 # ],
1470 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1471 # &quot;version&quot;: 3
1472 # }
1473 # ```
1474 #
1475 # **YAML example:**
1476 #
1477 # ```
1478 # bindings:
1479 # - members:
1480 # - user:[email protected]
1481 # - group:[email protected]
1482 # - domain:google.com
1483 # - serviceAccount:[email protected]
1484 # role: roles/resourcemanager.organizationAdmin
1485 # - members:
1486 # - user:[email protected]
1487 # role: roles/resourcemanager.organizationViewer
1488 # condition:
1489 # title: expirable access
1490 # description: Does not grant access after Sep 2020
1491 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1492 # etag: BwWWja0YfJA=
1493 # version: 3
1494 # ```
1495 #
1496 # For a description of IAM and its features, see the
1497 # [IAM documentation](https://cloud.google.com/iam/docs/).
1498 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1499 { # Specifies the audit configuration for a service.
1500 # The configuration determines which permission types are logged, and what
1501 # identities, if any, are exempted from logging.
1502 # An AuditConfig must have one or more AuditLogConfigs.
1503 #
1504 # If there are AuditConfigs for both `allServices` and a specific service,
1505 # the union of the two AuditConfigs is used for that service: the log_types
1506 # specified in each AuditConfig are enabled, and the exempted_members in each
1507 # AuditLogConfig are exempted.
1508 #
1509 # Example Policy with multiple AuditConfigs:
1510 #
1511 # {
1512 # &quot;audit_configs&quot;: [
1513 # {
1514 # &quot;service&quot;: &quot;allServices&quot;,
1515 # &quot;audit_log_configs&quot;: [
1516 # {
1517 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1518 # &quot;exempted_members&quot;: [
1519 # &quot;user:[email protected]&quot;
1520 # ]
1521 # },
1522 # {
1523 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1524 # },
1525 # {
1526 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1527 # }
1528 # ]
1529 # },
1530 # {
1531 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1532 # &quot;audit_log_configs&quot;: [
1533 # {
1534 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1535 # },
1536 # {
1537 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1538 # &quot;exempted_members&quot;: [
1539 # &quot;user:[email protected]&quot;
1540 # ]
1541 # }
1542 # ]
1543 # }
1544 # ]
1545 # }
1546 #
1547 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1548 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1549 # `[email protected]` from DATA_WRITE logging.
1550 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1551 { # Provides the configuration for logging a type of permissions.
1552 # Example:
1553 #
1554 # {
1555 # &quot;audit_log_configs&quot;: [
1556 # {
1557 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1558 # &quot;exempted_members&quot;: [
1559 # &quot;user:[email protected]&quot;
1560 # ]
1561 # },
1562 # {
1563 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1564 # }
1565 # ]
1566 # }
1567 #
1568 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1569 # [email protected] from DATA_READ logging.
1570 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1571 # permission.
1572 # Follows the same format of Binding.members.
1573 &quot;A String&quot;,
1574 ],
1575 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1576 },
1577 ],
1578 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1579 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1580 # `allServices` is a special value that covers all services.
1581 },
1582 ],
1583 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1584 # may specify a `condition` that determines how and when the `bindings` are
1585 # applied. Each of the `bindings` must contain at least one principal.
1586 #
1587 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1588 # of these principals can be Google groups. Each occurrence of a principal
1589 # counts towards these limits. For example, if the `bindings` grant 50
1590 # different roles to `user:[email protected]`, and not to any other
1591 # principal, then you can add another 1,450 principals to the `bindings` in
1592 # the `Policy`.
1593 { # Associates `members`, or principals, with a `role`.
1594 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1595 #
1596 # If the condition evaluates to `true`, then this binding applies to the
1597 # current request.
1598 #
1599 # If the condition evaluates to `false`, then this binding does not apply to
1600 # the current request. However, a different role binding might grant the same
1601 # role to one or more of the principals in this binding.
1602 #
1603 # To learn which resources support conditions in their IAM policies, see the
1604 # [IAM
1605 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1606 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1607 # are documented at https://github.com/google/cel-spec.
1608 #
1609 # Example (Comparison):
1610 #
1611 # title: &quot;Summary size limit&quot;
1612 # description: &quot;Determines if a summary is less than 100 chars&quot;
1613 # expression: &quot;document.summary.size() &lt; 100&quot;
1614 #
1615 # Example (Equality):
1616 #
1617 # title: &quot;Requestor is owner&quot;
1618 # description: &quot;Determines if requestor is the document owner&quot;
1619 # expression: &quot;document.owner == request.auth.claims.email&quot;
1620 #
1621 # Example (Logic):
1622 #
1623 # title: &quot;Public documents&quot;
1624 # description: &quot;Determine whether the document should be publicly visible&quot;
1625 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1626 #
1627 # Example (Data Manipulation):
1628 #
1629 # title: &quot;Notification string&quot;
1630 # description: &quot;Create a notification string with a timestamp.&quot;
1631 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1632 #
1633 # The exact variables and functions that may be referenced within an expression
1634 # are determined by the service that evaluates it. See the service
1635 # documentation for additional information.
1636 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1637 # describes the expression, e.g. when hovered over it in a UI.
1638 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1639 # syntax.
1640 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1641 # reporting, e.g. a file name and a position in the file.
1642 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1643 # its purpose. This can be used e.g. in UIs which allow to enter the
1644 # expression.
1645 },
1646 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1647 # `members` can have the following values:
1648 #
1649 # * `allUsers`: A special identifier that represents anyone who is
1650 # on the internet; with or without a Google account.
1651 #
1652 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1653 # who is authenticated with a Google account or a service account.
1654 # Does not include identities that come from external identity providers
1655 # (IdPs) through identity federation.
1656 #
1657 # * `user:{emailid}`: An email address that represents a specific Google
1658 # account. For example, `[email protected]` .
1659 #
1660 #
1661 # * `serviceAccount:{emailid}`: An email address that represents a Google
1662 # service account. For example,
1663 # `[email protected]`.
1664 #
1665 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1666 # identifier for a
1667 # [Kubernetes service
1668 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1669 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1670 #
1671 # * `group:{emailid}`: An email address that represents a Google group.
1672 # For example, `[email protected]`.
1673 #
1674 #
1675 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1676 # users of that domain. For example, `google.com` or `example.com`.
1677 #
1678 #
1679 #
1680 #
1681 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1682 # A single identity in a workforce identity pool.
1683 #
1684 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1685 # All workforce identities in a group.
1686 #
1687 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1688 # All workforce identities with a specific attribute value.
1689 #
1690 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1691 # All identities in a workforce identity pool.
1692 #
1693 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1694 # A single identity in a workload identity pool.
1695 #
1696 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1697 # A workload identity pool group.
1698 #
1699 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1700 # All identities in a workload identity pool with a certain attribute.
1701 #
1702 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1703 # All identities in a workload identity pool.
1704 #
1705 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1706 # identifier) representing a user that has been recently deleted. For
1707 # example, `[email protected]?uid=123456789012345678901`. If the user is
1708 # recovered, this value reverts to `user:{emailid}` and the recovered user
1709 # retains the role in the binding.
1710 #
1711 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1712 # unique identifier) representing a service account that has been recently
1713 # deleted. For example,
1714 # `[email protected]?uid=123456789012345678901`.
1715 # If the service account is undeleted, this value reverts to
1716 # `serviceAccount:{emailid}` and the undeleted service account retains the
1717 # role in the binding.
1718 #
1719 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1720 # identifier) representing a Google group that has been recently
1721 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1722 # the group is recovered, this value reverts to `group:{emailid}` and the
1723 # recovered group retains the role in the binding.
1724 #
1725 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1726 # Deleted single identity in a workforce identity pool. For example,
1727 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1728 &quot;A String&quot;,
1729 ],
1730 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1731 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1732 #
1733 # For an overview of the IAM roles and permissions, see the
1734 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1735 # a list of the available pre-defined roles, see
1736 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1737 },
1738 ],
1739 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1740 # prevent simultaneous updates of a policy from overwriting each other.
1741 # It is strongly suggested that systems make use of the `etag` in the
1742 # read-modify-write cycle to perform policy updates in order to avoid race
1743 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1744 # systems are expected to put that etag in the request to `setIamPolicy` to
1745 # ensure that their change will be applied to the same version of the policy.
1746 #
1747 # **Important:** If you use IAM Conditions, you must include the `etag` field
1748 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1749 # you to overwrite a version `3` policy with a version `1` policy, and all of
1750 # the conditions in the version `3` policy are lost.
1751 &quot;version&quot;: 42, # Specifies the format of the policy.
1752 #
1753 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1754 # are rejected.
1755 #
1756 # Any operation that affects conditional role bindings must specify version
1757 # `3`. This requirement applies to the following operations:
1758 #
1759 # * Getting a policy that includes a conditional role binding
1760 # * Adding a conditional role binding to a policy
1761 # * Changing a conditional role binding in a policy
1762 # * Removing any role binding, with or without a condition, from a policy
1763 # that includes conditions
1764 #
1765 # **Important:** If you use IAM Conditions, you must include the `etag` field
1766 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1767 # you to overwrite a version `3` policy with a version `1` policy, and all of
1768 # the conditions in the version `3` policy are lost.
1769 #
1770 # If a policy does not include any conditions, operations on that policy may
1771 # specify any valid version or leave the field unset.
1772 #
1773 # To learn which resources support conditions in their IAM policies, see the
1774 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1775 }</pre>
1776 </div>
1777
1778 <div class="method">
1779 <code class="details" id="insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</code>
1780 <pre>Creates a NodeGroup resource in the specified project using the data
1781 included in the request.
1782
1783 Args:
1784 project: string, Project ID for this request. (required)
1785 zone: string, The name of the zone for this request. (required)
1786 initialNodeCount: integer, Initial count of nodes in the node group. (required)
1787 body: object, The request body.
1788 The object takes the form of:
1789
1790 { # Represents a sole-tenant Node Group resource.
1791 #
1792 # A sole-tenant node is a physical server that is dedicated to
1793 # hosting VM instances only for your specific project. Use sole-tenant nodes to
1794 # keep your instances physically separated from instances in other projects, or
1795 # to group your instances together on the same host hardware. For more
1796 # information, readSole-tenant nodes.
1797 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
1798 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if
1799 # autoscaling is enabled. Maximum value allowed is 100.
1800 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
1801 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF,
1802 # or ONLY_SCALE_OUT. For more information, see
1803 # Autoscaler modes.
1804 },
1805 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1806 # text format.
1807 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1808 # create the resource.
1809 &quot;fingerprint&quot;: &quot;A String&quot;,
1810 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1811 # defined by the server.
1812 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.
1813 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other
1814 # resources.
1815 # This field is for use by internal tools that use the public API.
1816 # The location hint here on the NodeGroup overrides any location_hint
1817 # present in the NodeTemplate.
1818 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
1819 # are: `AS_NEEDED` and `RECURRENT`.
1820 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes
1821 # maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.
1822 # The default value is DEFAULT. For more information, see
1823 # Maintenance policies.
1824 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal
1825 # maintenance will be performed within this window.
1826 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented # Output only. [Output only] A predetermined duration for the window, automatically
1827 # chosen to be the smallest possible in the given scenario.
1828 # as a count of seconds and fractions of seconds at nanosecond
1829 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1830 # or &quot;month&quot;. Range is approximately 10,000 years.
1831 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1832 # Durations less than one second are represented with a 0
1833 # `seconds` field and a positive `nanos` field. Must be from 0
1834 # to 999,999,999 inclusive.
1835 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1836 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1837 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1838 },
1839 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one
1840 # of 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For
1841 # example, both 13:00-5 and 08:00 are valid.
1842 },
1843 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1844 # the resource. The resource name must be 1-63 characters long, and comply
1845 # withRFC1035.
1846 # Specifically, the name must be 1-63 characters long and match the regular
1847 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1848 # character must be a lowercase letter, and all following characters must be
1849 # a dash, lowercase letter, or digit, except the last character, which cannot
1850 # be a dash.
1851 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
1852 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1853 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
1854 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1855 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1856 &quot;a_key&quot;: { # Config for each project in the share settings.
1857 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1858 # parent map.
1859 },
1860 },
1861 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1862 },
1863 &quot;size&quot;: 42, # Output only. [Output Only] The total number of nodes in the node group.
1864 &quot;status&quot;: &quot;A String&quot;,
1865 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone where the node group resides,
1866 # such as us-central1-a.
1867 }
1868
1869 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1870 that if you must retry your request, the server will know to ignore the
1871 request if it has already been completed.
1872
1873 For example, consider a situation where you make an initial request and
1874 the request times out. If you make the request again with the same
1875 request ID, the server can check if original operation with the same
1876 request ID was received, and if so, will ignore the second request. This
1877 prevents clients from accidentally creating duplicate commitments.
1878
1879 The request ID must be
1880 a valid UUID with the exception that zero UUID is not supported
1881 (00000000-0000-0000-0000-000000000000).
1882 x__xgafv: string, V1 error format.
1883 Allowed values
1884 1 - v1 error format
1885 2 - v2 error format
1886
1887 Returns:
1888 An object of the form:
1889
1890 { # Represents an Operation resource.
1891 #
1892 # Google Compute Engine has three Operation resources:
1893 #
1894 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1895 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1896 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1897 #
1898 # You can use an operation resource to manage asynchronous API requests.
1899 # For more information, readHandling
1900 # API responses.
1901 #
1902 # Operations can be global, regional or zonal.
1903 #
1904 # - For global operations, use the `globalOperations`
1905 # resource.
1906 # - For regional operations, use the
1907 # `regionOperations` resource.
1908 # - For zonal operations, use
1909 # the `zoneOperations` resource.
1910 #
1911 #
1912 #
1913 # For more information, read
1914 # Global, Regional, and Zonal Resources.
1915 #
1916 # Note that completed Operation resources have a limited
1917 # retention period.
1918 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1919 # Not present otherwise.
1920 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1921 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1922 # set when the operation is created.
1923 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1924 # text format.
1925 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1926 # this field will be populated.
1927 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1928 # operation.
1929 {
1930 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1931 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1932 # details. There is a set of defined message types to use for providing
1933 # details.The syntax depends on the error code. For example,
1934 # QuotaExceededInfo will have details when the error code is
1935 # QUOTA_EXCEEDED.
1936 {
1937 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1938 #
1939 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1940 # is not enabled:
1941 #
1942 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1943 # &quot;domain&quot;: &quot;googleapis.com&quot;
1944 # &quot;metadata&quot;: {
1945 # &quot;resource&quot;: &quot;projects/123&quot;,
1946 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1947 # }
1948 # }
1949 #
1950 # This response indicates that the pubsub.googleapis.com API is not enabled.
1951 #
1952 # Example of an error that is returned when attempting to create a Spanner
1953 # instance in a region that is out of stock:
1954 #
1955 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1956 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1957 # &quot;metadata&quot;: {
1958 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1959 # }
1960 # }
1961 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1962 # is typically the registered service name of the tool or product that
1963 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1964 # generated by some common infrastructure, the error domain must be a
1965 # globally unique value that identifies the infrastructure. For Google API
1966 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1967 &quot;metadatas&quot;: { # Additional structured details about this error.
1968 #
1969 # Keys must match a regular expression of `a-z+` but should
1970 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1971 # length. When identifying the current value of an exceeded limit, the units
1972 # should be contained in the key, not the value. For example, rather than
1973 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1974 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1975 # instances that can be created in a single (batch) request.
1976 &quot;a_key&quot;: &quot;A String&quot;,
1977 },
1978 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1979 # proximate cause of the error. Error reasons are unique within a particular
1980 # domain of errors. This should be at most 63 characters and match a
1981 # regular expression of `A-Z+[A-Z0-9]`, which represents
1982 # UPPER_SNAKE_CASE.
1983 },
1984 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1985 #
1986 # For example, if a quota check failed with an error indicating the calling
1987 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1988 # directly to the right place in the developer console to flip the bit.
1989 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1990 { # Describes a URL link.
1991 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1992 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1993 },
1994 ],
1995 },
1996 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1997 # which can be attached to an RPC error.
1998 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1999 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2000 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2001 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2002 },
2003 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2004 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2005 &quot;a_key&quot;: &quot;A String&quot;,
2006 },
2007 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2008 # type or metric.
2009 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2010 # or metric.
2011 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2012 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2013 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2014 },
2015 },
2016 ],
2017 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2018 # This property is optional.
2019 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2020 },
2021 ],
2022 },
2023 &quot;getVersionOperationMetadata&quot;: {
2024 &quot;inlineSbomInfo&quot;: {
2025 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2026 # appropriate identifiers.
2027 &quot;a_key&quot;: &quot;A String&quot;,
2028 },
2029 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2030 # identifiers.
2031 &quot;a_key&quot;: &quot;A String&quot;,
2032 },
2033 },
2034 },
2035 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2036 # message that was returned, such as `NOT FOUND`.
2037 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2038 # status code that was returned. For example, a `404` means the
2039 # resource was not found.
2040 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2041 # defined by the server.
2042 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2043 # This value is inRFC3339
2044 # text format.
2045 &quot;instancesBulkInsertOperationMetadata&quot;: {
2046 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2047 # Example key: zones/us-central1-a
2048 &quot;a_key&quot;: {
2049 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2050 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2051 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2052 # error.
2053 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2054 # if the flow is rolling forward or rolling back.
2055 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2056 },
2057 },
2058 },
2059 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2060 # Operation resources.
2061 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2062 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2063 # group of operations results from a `bulkInsert` API request.
2064 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2065 # `update`, or `delete`, and so on.
2066 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2067 # There is no requirement that this be linear or support any granularity of
2068 # operations. This should not be used to guess when the operation will be
2069 # complete. This number should monotonically increase as the operation
2070 # progresses.
2071 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2072 # applicable when performing regional operations.
2073 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2074 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2075 # this field will contain information on all underlying zonal actions and
2076 # their state.
2077 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2078 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2079 # Example key: zones/us-central1-a
2080 &quot;a_key&quot;: {
2081 &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
2082 # populated.
2083 # different programming environments, including REST APIs and RPC APIs. It is
2084 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2085 # three pieces of data: error code, error message, and error details.
2086 #
2087 # You can find out more about this error model and how to work with it in the
2088 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2089 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2090 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2091 # message types for APIs to use.
2092 {
2093 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2094 },
2095 ],
2096 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2097 # user-facing error message should be localized and sent in the
2098 # google.rpc.Status.details field, or localized by the client.
2099 },
2100 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2101 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2102 },
2103 },
2104 },
2105 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2106 # This value is inRFC3339
2107 # text format.
2108 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2109 # following:
2110 # `PENDING`, `RUNNING`, or `DONE`.
2111 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2112 # operation.
2113 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2114 # of the target resource.
2115 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2116 # operations related to creating a snapshot, this points to the disk
2117 # that the snapshot was created from.
2118 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2119 # `[email protected]` or
2120 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2121 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2122 # operation, this field will be populated.
2123 {
2124 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2125 # Engine returns NO_RESULTS_ON_PAGE if there
2126 # are no results in the response.
2127 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2128 # value format. For example:
2129 #
2130 # &quot;data&quot;: [
2131 # {
2132 # &quot;key&quot;: &quot;scope&quot;,
2133 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2134 # }
2135 {
2136 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2137 # returned. For example, for warnings where there are no results in a list
2138 # request for a particular zone, this key might be scope and
2139 # the key value might be the zone name. Other examples might be a key
2140 # indicating a deprecated resource and a suggested replacement, or a
2141 # warning about invalid network settings (for example, if an instance
2142 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2143 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2144 },
2145 ],
2146 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2147 },
2148 ],
2149 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2150 # applicable when performing per-zone operations.
2151 }</pre>
2152 </div>
2153
2154 <div class="method">
2155 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2156 <pre>Retrieves a list of node groups available to the specified project.
2157 Note: use nodeGroups.listNodes for more details about each group.
2158
2159 Args:
2160 project: string, Project ID for this request. (required)
2161 zone: string, The name of the zone for this request. (required)
2162 filter: string, A filter expression that filters resources listed in the response. Most
2163 Compute resources support two types of filter expressions:
2164 expressions that support regular expressions and expressions that follow
2165 API improvement proposal AIP-160.
2166 These two types of filter expressions cannot be mixed in one request.
2167
2168 If you want to use AIP-160, your expression must specify the field name, an
2169 operator, and the value that you want to use for filtering. The value
2170 must be a string, a number, or a boolean. The operator
2171 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2172
2173 For example, if you are filtering Compute Engine instances, you can
2174 exclude instances named `example-instance` by specifying
2175 `name != example-instance`.
2176
2177 The `:*` comparison can be used to test whether a key has been defined.
2178 For example, to find all objects with `owner` label use:
2179 ```
2180 labels.owner:*
2181 ```
2182
2183 You can also filter nested fields. For example, you could specify
2184 `scheduling.automaticRestart = false` to include instances only
2185 if they are not scheduled for automatic restarts. You can use filtering
2186 on nested fields to filter based onresource labels.
2187
2188 To filter on multiple expressions, provide each separate expression within
2189 parentheses. For example:
2190 ```
2191 (scheduling.automaticRestart = true)
2192 (cpuPlatform = &quot;Intel Skylake&quot;)
2193 ```
2194 By default, each expression is an `AND` expression. However, you
2195 can include `AND` and `OR` expressions explicitly.
2196 For example:
2197 ```
2198 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2199 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2200 (scheduling.automaticRestart = true)
2201 ```
2202
2203 If you want to use a regular expression, use the `eq` (equal) or `ne`
2204 (not equal) operator against a single un-parenthesized expression with or
2205 without quotes or against multiple parenthesized expressions. Examples:
2206
2207 `fieldname eq unquoted literal`
2208 `fieldname eq &#x27;single quoted literal&#x27;`
2209 `fieldname eq &quot;double quoted literal&quot;`
2210 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2211
2212 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2213 The literal value must match the entire field.
2214
2215 For example, to filter for instances that do not end with name &quot;instance&quot;,
2216 you would use `name ne .*instance`.
2217
2218 You cannot combine constraints on multiple fields using regular
2219 expressions.
2220 maxResults: integer, The maximum number of results per page that should be returned.
2221 If the number of available results is larger than `maxResults`,
2222 Compute Engine returns a `nextPageToken` that can be used to get
2223 the next page of results in subsequent list requests. Acceptable values are
2224 `0` to `500`, inclusive. (Default: `500`)
2225 orderBy: string, Sorts list results by a certain order. By default, results
2226 are returned in alphanumerical order based on the resource name.
2227
2228 You can also sort results in descending order based on the creation
2229 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2230 results based on the `creationTimestamp` field in
2231 reverse chronological order (newest result first). Use this to sort
2232 resources like operations so that the newest operation is returned first.
2233
2234 Currently, only sorting by `name` or
2235 `creationTimestamp desc` is supported.
2236 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2237 `nextPageToken` returned by a previous list request to get
2238 the next page of results.
2239 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2240 of failure. The default value is false.
2241
2242 For example, when partial success behavior is enabled, aggregatedList for a
2243 single zone scope either returns all resources in the zone or no resources,
2244 with an error code.
2245 x__xgafv: string, V1 error format.
2246 Allowed values
2247 1 - v1 error format
2248 2 - v2 error format
2249
2250 Returns:
2251 An object of the form:
2252
2253 { # Contains a list of nodeGroups.
2254 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2255 &quot;items&quot;: [ # A list of NodeGroup resources.
2256 { # Represents a sole-tenant Node Group resource.
2257 #
2258 # A sole-tenant node is a physical server that is dedicated to
2259 # hosting VM instances only for your specific project. Use sole-tenant nodes to
2260 # keep your instances physically separated from instances in other projects, or
2261 # to group your instances together on the same host hardware. For more
2262 # information, readSole-tenant nodes.
2263 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
2264 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if
2265 # autoscaling is enabled. Maximum value allowed is 100.
2266 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
2267 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF,
2268 # or ONLY_SCALE_OUT. For more information, see
2269 # Autoscaler modes.
2270 },
2271 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2272 # text format.
2273 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2274 # create the resource.
2275 &quot;fingerprint&quot;: &quot;A String&quot;,
2276 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2277 # defined by the server.
2278 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.
2279 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other
2280 # resources.
2281 # This field is for use by internal tools that use the public API.
2282 # The location hint here on the NodeGroup overrides any location_hint
2283 # present in the NodeTemplate.
2284 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
2285 # are: `AS_NEEDED` and `RECURRENT`.
2286 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes
2287 # maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.
2288 # The default value is DEFAULT. For more information, see
2289 # Maintenance policies.
2290 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal
2291 # maintenance will be performed within this window.
2292 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented # Output only. [Output only] A predetermined duration for the window, automatically
2293 # chosen to be the smallest possible in the given scenario.
2294 # as a count of seconds and fractions of seconds at nanosecond
2295 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2296 # or &quot;month&quot;. Range is approximately 10,000 years.
2297 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2298 # Durations less than one second are represented with a 0
2299 # `seconds` field and a positive `nanos` field. Must be from 0
2300 # to 999,999,999 inclusive.
2301 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2302 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2303 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2304 },
2305 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one
2306 # of 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For
2307 # example, both 13:00-5 and 08:00 are valid.
2308 },
2309 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2310 # the resource. The resource name must be 1-63 characters long, and comply
2311 # withRFC1035.
2312 # Specifically, the name must be 1-63 characters long and match the regular
2313 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2314 # character must be a lowercase letter, and all following characters must be
2315 # a dash, lowercase letter, or digit, except the last character, which cannot
2316 # be a dash.
2317 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
2318 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2319 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
2320 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2321 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2322 &quot;a_key&quot;: { # Config for each project in the share settings.
2323 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2324 # parent map.
2325 },
2326 },
2327 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2328 },
2329 &quot;size&quot;: 42, # Output only. [Output Only] The total number of nodes in the node group.
2330 &quot;status&quot;: &quot;A String&quot;,
2331 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone where the node group resides,
2332 # such as us-central1-a.
2333 },
2334 ],
2335 &quot;kind&quot;: &quot;compute#nodeGroupList&quot;, # Output only. [Output Only] Type of resource.Always compute#nodeGroupList
2336 # for lists of node groups.
2337 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2338 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2339 # the query parameter pageToken in the next list request.
2340 # Subsequent list requests will have their own nextPageToken to
2341 # continue paging through the results.
2342 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2343 &quot;warning&quot;: { # [Output Only] Informational warning message.
2344 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2345 # Engine returns NO_RESULTS_ON_PAGE if there
2346 # are no results in the response.
2347 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2348 # value format. For example:
2349 #
2350 # &quot;data&quot;: [
2351 # {
2352 # &quot;key&quot;: &quot;scope&quot;,
2353 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2354 # }
2355 {
2356 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2357 # returned. For example, for warnings where there are no results in a list
2358 # request for a particular zone, this key might be scope and
2359 # the key value might be the zone name. Other examples might be a key
2360 # indicating a deprecated resource and a suggested replacement, or a
2361 # warning about invalid network settings (for example, if an instance
2362 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2363 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2364 },
2365 ],
2366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2367 },
2368 }</pre>
2369 </div>
2370
2371 <div class="method">
2372 <code class="details" id="listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2373 <pre>Lists nodes in the node group.
2374
2375 Args:
2376 project: string, Project ID for this request. (required)
2377 zone: string, The name of the zone for this request. (required)
2378 nodeGroup: string, Name of the NodeGroup resource whose nodes you want to list. (required)
2379 filter: string, A filter expression that filters resources listed in the response. Most
2380 Compute resources support two types of filter expressions:
2381 expressions that support regular expressions and expressions that follow
2382 API improvement proposal AIP-160.
2383 These two types of filter expressions cannot be mixed in one request.
2384
2385 If you want to use AIP-160, your expression must specify the field name, an
2386 operator, and the value that you want to use for filtering. The value
2387 must be a string, a number, or a boolean. The operator
2388 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2389
2390 For example, if you are filtering Compute Engine instances, you can
2391 exclude instances named `example-instance` by specifying
2392 `name != example-instance`.
2393
2394 The `:*` comparison can be used to test whether a key has been defined.
2395 For example, to find all objects with `owner` label use:
2396 ```
2397 labels.owner:*
2398 ```
2399
2400 You can also filter nested fields. For example, you could specify
2401 `scheduling.automaticRestart = false` to include instances only
2402 if they are not scheduled for automatic restarts. You can use filtering
2403 on nested fields to filter based onresource labels.
2404
2405 To filter on multiple expressions, provide each separate expression within
2406 parentheses. For example:
2407 ```
2408 (scheduling.automaticRestart = true)
2409 (cpuPlatform = &quot;Intel Skylake&quot;)
2410 ```
2411 By default, each expression is an `AND` expression. However, you
2412 can include `AND` and `OR` expressions explicitly.
2413 For example:
2414 ```
2415 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2416 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2417 (scheduling.automaticRestart = true)
2418 ```
2419
2420 If you want to use a regular expression, use the `eq` (equal) or `ne`
2421 (not equal) operator against a single un-parenthesized expression with or
2422 without quotes or against multiple parenthesized expressions. Examples:
2423
2424 `fieldname eq unquoted literal`
2425 `fieldname eq &#x27;single quoted literal&#x27;`
2426 `fieldname eq &quot;double quoted literal&quot;`
2427 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2428
2429 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2430 The literal value must match the entire field.
2431
2432 For example, to filter for instances that do not end with name &quot;instance&quot;,
2433 you would use `name ne .*instance`.
2434
2435 You cannot combine constraints on multiple fields using regular
2436 expressions.
2437 maxResults: integer, The maximum number of results per page that should be returned.
2438 If the number of available results is larger than `maxResults`,
2439 Compute Engine returns a `nextPageToken` that can be used to get
2440 the next page of results in subsequent list requests. Acceptable values are
2441 `0` to `500`, inclusive. (Default: `500`)
2442 orderBy: string, Sorts list results by a certain order. By default, results
2443 are returned in alphanumerical order based on the resource name.
2444
2445 You can also sort results in descending order based on the creation
2446 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2447 results based on the `creationTimestamp` field in
2448 reverse chronological order (newest result first). Use this to sort
2449 resources like operations so that the newest operation is returned first.
2450
2451 Currently, only sorting by `name` or
2452 `creationTimestamp desc` is supported.
2453 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2454 `nextPageToken` returned by a previous list request to get
2455 the next page of results.
2456 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2457 of failure. The default value is false.
2458
2459 For example, when partial success behavior is enabled, aggregatedList for a
2460 single zone scope either returns all resources in the zone or no resources,
2461 with an error code.
2462 x__xgafv: string, V1 error format.
2463 Allowed values
2464 1 - v1 error format
2465 2 - v2 error format
2466
2467 Returns:
2468 An object of the form:
2469
2470 {
2471 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
2472 &quot;items&quot;: [ # A list of Node resources.
2473 {
2474 &quot;accelerators&quot;: [ # Accelerators for this node.
2475 { # A specification of the type and number of accelerator cards attached to the
2476 # instance.
2477 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2478 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2479 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2480 # If you are creating an instance template, specify only the
2481 # accelerator name.
2482 # See GPUs on Compute Engine
2483 # for a full list of accelerator types.
2484 },
2485 ],
2486 &quot;consumedResources&quot;: { # Output only. Node resources that are reserved by all instances.
2487 &quot;guestCpus&quot;: 42, # Output only. The number of virtual CPUs that are available to the instance.
2488 &quot;localSsdGb&quot;: 42, # Output only. The amount of local SSD storage available to the instance,
2489 # defined in GiB.
2490 &quot;memoryMb&quot;: 42, # Output only. The amount of physical memory available to the instance,
2491 # defined in MiB.
2492 &quot;minNodeCpus&quot;: 42, # Output only. The minimal guaranteed number of virtual CPUs that are reserved.
2493 },
2494 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
2495 &quot;disks&quot;: [ # Local disk configurations.
2496 {
2497 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
2498 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
2499 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a
2500 # local storage type (e.g.: local-ssd).
2501 # Note that for nodeTemplates, this should be the name of the disk type and
2502 # not its URL.
2503 },
2504 ],
2505 &quot;instanceConsumptionData&quot;: [ # Output only. Instance data that shows consumed resources on the node.
2506 {
2507 &quot;consumptionInfo&quot;: { # Output only. Resources consumed by the instance.
2508 &quot;guestCpus&quot;: 42, # Output only. The number of virtual CPUs that are available to the instance.
2509 &quot;localSsdGb&quot;: 42, # Output only. The amount of local SSD storage available to the instance,
2510 # defined in GiB.
2511 &quot;memoryMb&quot;: 42, # Output only. The amount of physical memory available to the instance,
2512 # defined in MiB.
2513 &quot;minNodeCpus&quot;: 42, # Output only. The minimal guaranteed number of virtual CPUs that are reserved.
2514 },
2515 &quot;instance&quot;: &quot;A String&quot;, # Output only. Server-defined URL for the instance.
2516 },
2517 ],
2518 &quot;instances&quot;: [ # Instances scheduled on this node.
2519 &quot;A String&quot;,
2520 ],
2521 &quot;name&quot;: &quot;A String&quot;, # The name of the node.
2522 &quot;nodeType&quot;: &quot;A String&quot;, # The type of this node.
2523 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2524 &quot;serverBinding&quot;: { # Binding properties for the physical server.
2525 &quot;type&quot;: &quot;A String&quot;,
2526 },
2527 &quot;serverId&quot;: &quot;A String&quot;, # Server ID associated with this node.
2528 &quot;status&quot;: &quot;A String&quot;,
2529 &quot;totalResources&quot;: { # Output only. Total amount of available resources on the node.
2530 &quot;guestCpus&quot;: 42, # Output only. The number of virtual CPUs that are available to the instance.
2531 &quot;localSsdGb&quot;: 42, # Output only. The amount of local SSD storage available to the instance,
2532 # defined in GiB.
2533 &quot;memoryMb&quot;: 42, # Output only. The amount of physical memory available to the instance,
2534 # defined in MiB.
2535 &quot;minNodeCpus&quot;: 42, # Output only. The minimal guaranteed number of virtual CPUs that are reserved.
2536 },
2537 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. [Output Only] The information about an upcoming maintenance event.
2538 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2539 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2540 # This timestamp value is in RFC3339 text format.
2541 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2542 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2543 &quot;A String&quot;,
2544 ],
2545 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2546 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2547 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2548 # This timestamp value is in RFC3339 text format.
2549 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2550 # This timestamp value is in RFC3339 text format.
2551 },
2552 },
2553 ],
2554 &quot;kind&quot;: &quot;compute#nodeGroupsListNodes&quot;, # Output only. [Output Only] The resource type, which is alwayscompute.nodeGroupsListNodes for the list of nodes in the
2555 # specified node group.
2556 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
2557 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2558 # the query parameter pageToken in the next list request.
2559 # Subsequent list requests will have their own nextPageToken to
2560 # continue paging through the results.
2561 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2562 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
2563 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2564 # Engine returns NO_RESULTS_ON_PAGE if there
2565 # are no results in the response.
2566 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2567 # value format. For example:
2568 #
2569 # &quot;data&quot;: [
2570 # {
2571 # &quot;key&quot;: &quot;scope&quot;,
2572 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2573 # }
2574 {
2575 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2576 # returned. For example, for warnings where there are no results in a list
2577 # request for a particular zone, this key might be scope and
2578 # the key value might be the zone name. Other examples might be a key
2579 # indicating a deprecated resource and a suggested replacement, or a
2580 # warning about invalid network settings (for example, if an instance
2581 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2582 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2583 },
2584 ],
2585 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2586 },
2587 }</pre>
2588 </div>
2589
2590 <div class="method">
2591 <code class="details" id="listNodes_next">listNodes_next()</code>
2592 <pre>Retrieves the next page of results.
2593
2594 Args:
2595 previous_request: The request for the previous page. (required)
2596 previous_response: The response from the request for the previous page. (required)
2597
2598 Returns:
2599 A request object that you can call &#x27;execute()&#x27; on to request the next
2600 page. Returns None if there are no more items in the collection.
2601 </pre>
2602 </div>
2603
2604 <div class="method">
2605 <code class="details" id="list_next">list_next()</code>
2606 <pre>Retrieves the next page of results.
2607
2608 Args:
2609 previous_request: The request for the previous page. (required)
2610 previous_response: The response from the request for the previous page. (required)
2611
2612 Returns:
2613 A request object that you can call &#x27;execute()&#x27; on to request the next
2614 page. Returns None if there are no more items in the collection.
2615 </pre>
2616 </div>
2617
2618 <div class="method">
2619 <code class="details" id="patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
2620 <pre>Updates the specified node group.
2621
2622 Args:
2623 project: string, Project ID for this request. (required)
2624 zone: string, The name of the zone for this request. (required)
2625 nodeGroup: string, Name of the NodeGroup resource to update. (required)
2626 body: object, The request body.
2627 The object takes the form of:
2628
2629 { # Represents a sole-tenant Node Group resource.
2630 #
2631 # A sole-tenant node is a physical server that is dedicated to
2632 # hosting VM instances only for your specific project. Use sole-tenant nodes to
2633 # keep your instances physically separated from instances in other projects, or
2634 # to group your instances together on the same host hardware. For more
2635 # information, readSole-tenant nodes.
2636 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
2637 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if
2638 # autoscaling is enabled. Maximum value allowed is 100.
2639 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
2640 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF,
2641 # or ONLY_SCALE_OUT. For more information, see
2642 # Autoscaler modes.
2643 },
2644 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2645 # text format.
2646 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2647 # create the resource.
2648 &quot;fingerprint&quot;: &quot;A String&quot;,
2649 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2650 # defined by the server.
2651 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.
2652 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other
2653 # resources.
2654 # This field is for use by internal tools that use the public API.
2655 # The location hint here on the NodeGroup overrides any location_hint
2656 # present in the NodeTemplate.
2657 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
2658 # are: `AS_NEEDED` and `RECURRENT`.
2659 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes
2660 # maintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.
2661 # The default value is DEFAULT. For more information, see
2662 # Maintenance policies.
2663 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal
2664 # maintenance will be performed within this window.
2665 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented # Output only. [Output only] A predetermined duration for the window, automatically
2666 # chosen to be the smallest possible in the given scenario.
2667 # as a count of seconds and fractions of seconds at nanosecond
2668 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2669 # or &quot;month&quot;. Range is approximately 10,000 years.
2670 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2671 # Durations less than one second are represented with a 0
2672 # `seconds` field and a positive `nanos` field. Must be from 0
2673 # to 999,999,999 inclusive.
2674 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2675 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2676 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2677 },
2678 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one
2679 # of 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For
2680 # example, both 13:00-5 and 08:00 are valid.
2681 },
2682 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2683 # the resource. The resource name must be 1-63 characters long, and comply
2684 # withRFC1035.
2685 # Specifically, the name must be 1-63 characters long and match the regular
2686 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2687 # character must be a lowercase letter, and all following characters must be
2688 # a dash, lowercase letter, or digit, except the last character, which cannot
2689 # be a dash.
2690 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
2691 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2692 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
2693 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2694 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2695 &quot;a_key&quot;: { # Config for each project in the share settings.
2696 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2697 # parent map.
2698 },
2699 },
2700 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2701 },
2702 &quot;size&quot;: 42, # Output only. [Output Only] The total number of nodes in the node group.
2703 &quot;status&quot;: &quot;A String&quot;,
2704 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the zone where the node group resides,
2705 # such as us-central1-a.
2706 }
2707
2708 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2709 that if you must retry your request, the server will know to ignore the
2710 request if it has already been completed.
2711
2712 For example, consider a situation where you make an initial request and
2713 the request times out. If you make the request again with the same
2714 request ID, the server can check if original operation with the same
2715 request ID was received, and if so, will ignore the second request. This
2716 prevents clients from accidentally creating duplicate commitments.
2717
2718 The request ID must be
2719 a valid UUID with the exception that zero UUID is not supported
2720 (00000000-0000-0000-0000-000000000000).
2721 x__xgafv: string, V1 error format.
2722 Allowed values
2723 1 - v1 error format
2724 2 - v2 error format
2725
2726 Returns:
2727 An object of the form:
2728
2729 { # Represents an Operation resource.
2730 #
2731 # Google Compute Engine has three Operation resources:
2732 #
2733 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2734 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2735 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2736 #
2737 # You can use an operation resource to manage asynchronous API requests.
2738 # For more information, readHandling
2739 # API responses.
2740 #
2741 # Operations can be global, regional or zonal.
2742 #
2743 # - For global operations, use the `globalOperations`
2744 # resource.
2745 # - For regional operations, use the
2746 # `regionOperations` resource.
2747 # - For zonal operations, use
2748 # the `zoneOperations` resource.
2749 #
2750 #
2751 #
2752 # For more information, read
2753 # Global, Regional, and Zonal Resources.
2754 #
2755 # Note that completed Operation resources have a limited
2756 # retention period.
2757 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2758 # Not present otherwise.
2759 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2760 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2761 # set when the operation is created.
2762 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2763 # text format.
2764 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2765 # this field will be populated.
2766 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2767 # operation.
2768 {
2769 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2770 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2771 # details. There is a set of defined message types to use for providing
2772 # details.The syntax depends on the error code. For example,
2773 # QuotaExceededInfo will have details when the error code is
2774 # QUOTA_EXCEEDED.
2775 {
2776 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2777 #
2778 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2779 # is not enabled:
2780 #
2781 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2782 # &quot;domain&quot;: &quot;googleapis.com&quot;
2783 # &quot;metadata&quot;: {
2784 # &quot;resource&quot;: &quot;projects/123&quot;,
2785 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2786 # }
2787 # }
2788 #
2789 # This response indicates that the pubsub.googleapis.com API is not enabled.
2790 #
2791 # Example of an error that is returned when attempting to create a Spanner
2792 # instance in a region that is out of stock:
2793 #
2794 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2795 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2796 # &quot;metadata&quot;: {
2797 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2798 # }
2799 # }
2800 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2801 # is typically the registered service name of the tool or product that
2802 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2803 # generated by some common infrastructure, the error domain must be a
2804 # globally unique value that identifies the infrastructure. For Google API
2805 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2806 &quot;metadatas&quot;: { # Additional structured details about this error.
2807 #
2808 # Keys must match a regular expression of `a-z+` but should
2809 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2810 # length. When identifying the current value of an exceeded limit, the units
2811 # should be contained in the key, not the value. For example, rather than
2812 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2813 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2814 # instances that can be created in a single (batch) request.
2815 &quot;a_key&quot;: &quot;A String&quot;,
2816 },
2817 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2818 # proximate cause of the error. Error reasons are unique within a particular
2819 # domain of errors. This should be at most 63 characters and match a
2820 # regular expression of `A-Z+[A-Z0-9]`, which represents
2821 # UPPER_SNAKE_CASE.
2822 },
2823 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2824 #
2825 # For example, if a quota check failed with an error indicating the calling
2826 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2827 # directly to the right place in the developer console to flip the bit.
2828 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2829 { # Describes a URL link.
2830 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2831 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2832 },
2833 ],
2834 },
2835 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2836 # which can be attached to an RPC error.
2837 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2838 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2839 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2840 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2841 },
2842 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2843 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2844 &quot;a_key&quot;: &quot;A String&quot;,
2845 },
2846 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2847 # type or metric.
2848 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2849 # or metric.
2850 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2851 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2852 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2853 },
2854 },
2855 ],
2856 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2857 # This property is optional.
2858 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2859 },
2860 ],
2861 },
2862 &quot;getVersionOperationMetadata&quot;: {
2863 &quot;inlineSbomInfo&quot;: {
2864 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2865 # appropriate identifiers.
2866 &quot;a_key&quot;: &quot;A String&quot;,
2867 },
2868 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2869 # identifiers.
2870 &quot;a_key&quot;: &quot;A String&quot;,
2871 },
2872 },
2873 },
2874 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2875 # message that was returned, such as `NOT FOUND`.
2876 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2877 # status code that was returned. For example, a `404` means the
2878 # resource was not found.
2879 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2880 # defined by the server.
2881 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2882 # This value is inRFC3339
2883 # text format.
2884 &quot;instancesBulkInsertOperationMetadata&quot;: {
2885 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2886 # Example key: zones/us-central1-a
2887 &quot;a_key&quot;: {
2888 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2889 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2890 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2891 # error.
2892 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2893 # if the flow is rolling forward or rolling back.
2894 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2895 },
2896 },
2897 },
2898 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2899 # Operation resources.
2900 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2901 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2902 # group of operations results from a `bulkInsert` API request.
2903 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2904 # `update`, or `delete`, and so on.
2905 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2906 # There is no requirement that this be linear or support any granularity of
2907 # operations. This should not be used to guess when the operation will be
2908 # complete. This number should monotonically increase as the operation
2909 # progresses.
2910 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2911 # applicable when performing regional operations.
2912 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2913 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2914 # this field will contain information on all underlying zonal actions and
2915 # their state.
2916 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2917 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2918 # Example key: zones/us-central1-a
2919 &quot;a_key&quot;: {
2920 &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
2921 # populated.
2922 # different programming environments, including REST APIs and RPC APIs. It is
2923 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2924 # three pieces of data: error code, error message, and error details.
2925 #
2926 # You can find out more about this error model and how to work with it in the
2927 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2928 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2929 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2930 # message types for APIs to use.
2931 {
2932 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2933 },
2934 ],
2935 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2936 # user-facing error message should be localized and sent in the
2937 # google.rpc.Status.details field, or localized by the client.
2938 },
2939 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2940 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2941 },
2942 },
2943 },
2944 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2945 # This value is inRFC3339
2946 # text format.
2947 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2948 # following:
2949 # `PENDING`, `RUNNING`, or `DONE`.
2950 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2951 # operation.
2952 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2953 # of the target resource.
2954 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2955 # operations related to creating a snapshot, this points to the disk
2956 # that the snapshot was created from.
2957 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2958 # `[email protected]` or
2959 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2960 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2961 # operation, this field will be populated.
2962 {
2963 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2964 # Engine returns NO_RESULTS_ON_PAGE if there
2965 # are no results in the response.
2966 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2967 # value format. For example:
2968 #
2969 # &quot;data&quot;: [
2970 # {
2971 # &quot;key&quot;: &quot;scope&quot;,
2972 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2973 # }
2974 {
2975 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2976 # returned. For example, for warnings where there are no results in a list
2977 # request for a particular zone, this key might be scope and
2978 # the key value might be the zone name. Other examples might be a key
2979 # indicating a deprecated resource and a suggested replacement, or a
2980 # warning about invalid network settings (for example, if an instance
2981 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2982 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2983 },
2984 ],
2985 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2986 },
2987 ],
2988 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2989 # applicable when performing per-zone operations.
2990 }</pre>
2991 </div>
2992
2993 <div class="method">
2994 <code class="details" id="performMaintenance">performMaintenance(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
2995 <pre>Perform maintenance on a subset of nodes in the node group.
2996
2997 Args:
2998 project: string, Project ID for this request. (required)
2999 zone: string, The name of the zone for this request. (required)
3000 nodeGroup: string, Name of the node group scoping this request. (required)
3001 body: object, The request body.
3002 The object takes the form of:
3003
3004 {
3005 &quot;nodes&quot;: [ # [Required] List of nodes affected by the call.
3006 &quot;A String&quot;,
3007 ],
3008 &quot;startTime&quot;: &quot;A String&quot;, # The start time of the schedule. The timestamp is an RFC3339 string.
3009 }
3010
3011 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3012 that if you must retry your request, the server will know to ignore the
3013 request if it has already been completed.
3014
3015 For example, consider a situation where you make an initial request and
3016 the request times out. If you make the request again with the same
3017 request ID, the server can check if original operation with the same
3018 request ID was received, and if so, will ignore the second request. This
3019 prevents clients from accidentally creating duplicate commitments.
3020
3021 The request ID must be
3022 a valid UUID with the exception that zero UUID is not supported
3023 (00000000-0000-0000-0000-000000000000).
3024 x__xgafv: string, V1 error format.
3025 Allowed values
3026 1 - v1 error format
3027 2 - v2 error format
3028
3029 Returns:
3030 An object of the form:
3031
3032 { # Represents an Operation resource.
3033 #
3034 # Google Compute Engine has three Operation resources:
3035 #
3036 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3037 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3038 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3039 #
3040 # You can use an operation resource to manage asynchronous API requests.
3041 # For more information, readHandling
3042 # API responses.
3043 #
3044 # Operations can be global, regional or zonal.
3045 #
3046 # - For global operations, use the `globalOperations`
3047 # resource.
3048 # - For regional operations, use the
3049 # `regionOperations` resource.
3050 # - For zonal operations, use
3051 # the `zoneOperations` resource.
3052 #
3053 #
3054 #
3055 # For more information, read
3056 # Global, Regional, and Zonal Resources.
3057 #
3058 # Note that completed Operation resources have a limited
3059 # retention period.
3060 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3061 # Not present otherwise.
3062 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3063 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3064 # set when the operation is created.
3065 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3066 # text format.
3067 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3068 # this field will be populated.
3069 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3070 # operation.
3071 {
3072 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3073 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3074 # details. There is a set of defined message types to use for providing
3075 # details.The syntax depends on the error code. For example,
3076 # QuotaExceededInfo will have details when the error code is
3077 # QUOTA_EXCEEDED.
3078 {
3079 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3080 #
3081 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3082 # is not enabled:
3083 #
3084 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3085 # &quot;domain&quot;: &quot;googleapis.com&quot;
3086 # &quot;metadata&quot;: {
3087 # &quot;resource&quot;: &quot;projects/123&quot;,
3088 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3089 # }
3090 # }
3091 #
3092 # This response indicates that the pubsub.googleapis.com API is not enabled.
3093 #
3094 # Example of an error that is returned when attempting to create a Spanner
3095 # instance in a region that is out of stock:
3096 #
3097 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3098 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3099 # &quot;metadata&quot;: {
3100 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3101 # }
3102 # }
3103 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3104 # is typically the registered service name of the tool or product that
3105 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3106 # generated by some common infrastructure, the error domain must be a
3107 # globally unique value that identifies the infrastructure. For Google API
3108 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3109 &quot;metadatas&quot;: { # Additional structured details about this error.
3110 #
3111 # Keys must match a regular expression of `a-z+` but should
3112 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3113 # length. When identifying the current value of an exceeded limit, the units
3114 # should be contained in the key, not the value. For example, rather than
3115 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3116 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3117 # instances that can be created in a single (batch) request.
3118 &quot;a_key&quot;: &quot;A String&quot;,
3119 },
3120 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3121 # proximate cause of the error. Error reasons are unique within a particular
3122 # domain of errors. This should be at most 63 characters and match a
3123 # regular expression of `A-Z+[A-Z0-9]`, which represents
3124 # UPPER_SNAKE_CASE.
3125 },
3126 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3127 #
3128 # For example, if a quota check failed with an error indicating the calling
3129 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3130 # directly to the right place in the developer console to flip the bit.
3131 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3132 { # Describes a URL link.
3133 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3134 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3135 },
3136 ],
3137 },
3138 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3139 # which can be attached to an RPC error.
3140 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3141 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3142 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3143 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3144 },
3145 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3146 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3147 &quot;a_key&quot;: &quot;A String&quot;,
3148 },
3149 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3150 # type or metric.
3151 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3152 # or metric.
3153 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3154 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3155 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3156 },
3157 },
3158 ],
3159 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3160 # This property is optional.
3161 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3162 },
3163 ],
3164 },
3165 &quot;getVersionOperationMetadata&quot;: {
3166 &quot;inlineSbomInfo&quot;: {
3167 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3168 # appropriate identifiers.
3169 &quot;a_key&quot;: &quot;A String&quot;,
3170 },
3171 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3172 # identifiers.
3173 &quot;a_key&quot;: &quot;A String&quot;,
3174 },
3175 },
3176 },
3177 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3178 # message that was returned, such as `NOT FOUND`.
3179 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3180 # status code that was returned. For example, a `404` means the
3181 # resource was not found.
3182 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3183 # defined by the server.
3184 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3185 # This value is inRFC3339
3186 # text format.
3187 &quot;instancesBulkInsertOperationMetadata&quot;: {
3188 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3189 # Example key: zones/us-central1-a
3190 &quot;a_key&quot;: {
3191 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3192 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3193 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3194 # error.
3195 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3196 # if the flow is rolling forward or rolling back.
3197 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3198 },
3199 },
3200 },
3201 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3202 # Operation resources.
3203 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3204 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3205 # group of operations results from a `bulkInsert` API request.
3206 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3207 # `update`, or `delete`, and so on.
3208 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3209 # There is no requirement that this be linear or support any granularity of
3210 # operations. This should not be used to guess when the operation will be
3211 # complete. This number should monotonically increase as the operation
3212 # progresses.
3213 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3214 # applicable when performing regional operations.
3215 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3216 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3217 # this field will contain information on all underlying zonal actions and
3218 # their state.
3219 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3220 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3221 # Example key: zones/us-central1-a
3222 &quot;a_key&quot;: {
3223 &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
3224 # populated.
3225 # different programming environments, including REST APIs and RPC APIs. It is
3226 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3227 # three pieces of data: error code, error message, and error details.
3228 #
3229 # You can find out more about this error model and how to work with it in the
3230 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3231 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3232 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3233 # message types for APIs to use.
3234 {
3235 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3236 },
3237 ],
3238 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3239 # user-facing error message should be localized and sent in the
3240 # google.rpc.Status.details field, or localized by the client.
3241 },
3242 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3243 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3244 },
3245 },
3246 },
3247 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3248 # This value is inRFC3339
3249 # text format.
3250 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3251 # following:
3252 # `PENDING`, `RUNNING`, or `DONE`.
3253 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3254 # operation.
3255 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3256 # of the target resource.
3257 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3258 # operations related to creating a snapshot, this points to the disk
3259 # that the snapshot was created from.
3260 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3261 # `[email protected]` or
3262 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3263 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3264 # operation, this field will be populated.
3265 {
3266 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3267 # Engine returns NO_RESULTS_ON_PAGE if there
3268 # are no results in the response.
3269 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3270 # value format. For example:
3271 #
3272 # &quot;data&quot;: [
3273 # {
3274 # &quot;key&quot;: &quot;scope&quot;,
3275 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3276 # }
3277 {
3278 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3279 # returned. For example, for warnings where there are no results in a list
3280 # request for a particular zone, this key might be scope and
3281 # the key value might be the zone name. Other examples might be a key
3282 # indicating a deprecated resource and a suggested replacement, or a
3283 # warning about invalid network settings (for example, if an instance
3284 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3285 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3286 },
3287 ],
3288 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3289 },
3290 ],
3291 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3292 # applicable when performing per-zone operations.
3293 }</pre>
3294 </div>
3295
3296 <div class="method">
3297 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
3298 <pre>Sets the access control policy on the specified resource.
3299 Replaces any existing policy.
3300
3301 Args:
3302 project: string, Project ID for this request. (required)
3303 zone: string, The name of the zone for this request. (required)
3304 resource: string, Name or id of the resource for this request. (required)
3305 body: object, The request body.
3306 The object takes the form of:
3307
3308 {
3309 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
3310 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
3311 { # Associates `members`, or principals, with a `role`.
3312 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3313 #
3314 # If the condition evaluates to `true`, then this binding applies to the
3315 # current request.
3316 #
3317 # If the condition evaluates to `false`, then this binding does not apply to
3318 # the current request. However, a different role binding might grant the same
3319 # role to one or more of the principals in this binding.
3320 #
3321 # To learn which resources support conditions in their IAM policies, see the
3322 # [IAM
3323 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3324 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3325 # are documented at https://github.com/google/cel-spec.
3326 #
3327 # Example (Comparison):
3328 #
3329 # title: &quot;Summary size limit&quot;
3330 # description: &quot;Determines if a summary is less than 100 chars&quot;
3331 # expression: &quot;document.summary.size() &lt; 100&quot;
3332 #
3333 # Example (Equality):
3334 #
3335 # title: &quot;Requestor is owner&quot;
3336 # description: &quot;Determines if requestor is the document owner&quot;
3337 # expression: &quot;document.owner == request.auth.claims.email&quot;
3338 #
3339 # Example (Logic):
3340 #
3341 # title: &quot;Public documents&quot;
3342 # description: &quot;Determine whether the document should be publicly visible&quot;
3343 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3344 #
3345 # Example (Data Manipulation):
3346 #
3347 # title: &quot;Notification string&quot;
3348 # description: &quot;Create a notification string with a timestamp.&quot;
3349 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3350 #
3351 # The exact variables and functions that may be referenced within an expression
3352 # are determined by the service that evaluates it. See the service
3353 # documentation for additional information.
3354 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3355 # describes the expression, e.g. when hovered over it in a UI.
3356 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3357 # syntax.
3358 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3359 # reporting, e.g. a file name and a position in the file.
3360 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3361 # its purpose. This can be used e.g. in UIs which allow to enter the
3362 # expression.
3363 },
3364 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3365 # `members` can have the following values:
3366 #
3367 # * `allUsers`: A special identifier that represents anyone who is
3368 # on the internet; with or without a Google account.
3369 #
3370 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3371 # who is authenticated with a Google account or a service account.
3372 # Does not include identities that come from external identity providers
3373 # (IdPs) through identity federation.
3374 #
3375 # * `user:{emailid}`: An email address that represents a specific Google
3376 # account. For example, `[email protected]` .
3377 #
3378 #
3379 # * `serviceAccount:{emailid}`: An email address that represents a Google
3380 # service account. For example,
3381 # `[email protected]`.
3382 #
3383 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3384 # identifier for a
3385 # [Kubernetes service
3386 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3387 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3388 #
3389 # * `group:{emailid}`: An email address that represents a Google group.
3390 # For example, `[email protected]`.
3391 #
3392 #
3393 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3394 # users of that domain. For example, `google.com` or `example.com`.
3395 #
3396 #
3397 #
3398 #
3399 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3400 # A single identity in a workforce identity pool.
3401 #
3402 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3403 # All workforce identities in a group.
3404 #
3405 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3406 # All workforce identities with a specific attribute value.
3407 #
3408 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3409 # All identities in a workforce identity pool.
3410 #
3411 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3412 # A single identity in a workload identity pool.
3413 #
3414 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3415 # A workload identity pool group.
3416 #
3417 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3418 # All identities in a workload identity pool with a certain attribute.
3419 #
3420 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3421 # All identities in a workload identity pool.
3422 #
3423 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3424 # identifier) representing a user that has been recently deleted. For
3425 # example, `[email protected]?uid=123456789012345678901`. If the user is
3426 # recovered, this value reverts to `user:{emailid}` and the recovered user
3427 # retains the role in the binding.
3428 #
3429 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3430 # unique identifier) representing a service account that has been recently
3431 # deleted. For example,
3432 # `[email protected]?uid=123456789012345678901`.
3433 # If the service account is undeleted, this value reverts to
3434 # `serviceAccount:{emailid}` and the undeleted service account retains the
3435 # role in the binding.
3436 #
3437 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3438 # identifier) representing a Google group that has been recently
3439 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3440 # the group is recovered, this value reverts to `group:{emailid}` and the
3441 # recovered group retains the role in the binding.
3442 #
3443 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3444 # Deleted single identity in a workforce identity pool. For example,
3445 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3446 &quot;A String&quot;,
3447 ],
3448 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3449 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3450 #
3451 # For an overview of the IAM roles and permissions, see the
3452 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3453 # a list of the available pre-defined roles, see
3454 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3455 },
3456 ],
3457 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3458 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3459 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
3460 # the policy is limited to a few 10s of KB. An empty policy is in general a
3461 # valid policy but certain services (like Projects) might reject them.
3462 # controls for Google Cloud resources.
3463 #
3464 #
3465 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3466 # `members`, or principals, to a single `role`. Principals can be user
3467 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3468 # `role` is a named list of permissions; each `role` can be an IAM predefined
3469 # role or a user-created custom role.
3470 #
3471 # For some types of Google Cloud resources, a `binding` can also specify a
3472 # `condition`, which is a logical expression that allows access to a resource
3473 # only if the expression evaluates to `true`. A condition can add constraints
3474 # based on attributes of the request, the resource, or both. To learn which
3475 # resources support conditions in their IAM policies, see the
3476 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3477 #
3478 # **JSON example:**
3479 #
3480 # ```
3481 # {
3482 # &quot;bindings&quot;: [
3483 # {
3484 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3485 # &quot;members&quot;: [
3486 # &quot;user:[email protected]&quot;,
3487 # &quot;group:[email protected]&quot;,
3488 # &quot;domain:google.com&quot;,
3489 # &quot;serviceAccount:[email protected]&quot;
3490 # ]
3491 # },
3492 # {
3493 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3494 # &quot;members&quot;: [
3495 # &quot;user:[email protected]&quot;
3496 # ],
3497 # &quot;condition&quot;: {
3498 # &quot;title&quot;: &quot;expirable access&quot;,
3499 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3500 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3501 # }
3502 # }
3503 # ],
3504 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3505 # &quot;version&quot;: 3
3506 # }
3507 # ```
3508 #
3509 # **YAML example:**
3510 #
3511 # ```
3512 # bindings:
3513 # - members:
3514 # - user:[email protected]
3515 # - group:[email protected]
3516 # - domain:google.com
3517 # - serviceAccount:[email protected]
3518 # role: roles/resourcemanager.organizationAdmin
3519 # - members:
3520 # - user:[email protected]
3521 # role: roles/resourcemanager.organizationViewer
3522 # condition:
3523 # title: expirable access
3524 # description: Does not grant access after Sep 2020
3525 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3526 # etag: BwWWja0YfJA=
3527 # version: 3
3528 # ```
3529 #
3530 # For a description of IAM and its features, see the
3531 # [IAM documentation](https://cloud.google.com/iam/docs/).
3532 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3533 { # Specifies the audit configuration for a service.
3534 # The configuration determines which permission types are logged, and what
3535 # identities, if any, are exempted from logging.
3536 # An AuditConfig must have one or more AuditLogConfigs.
3537 #
3538 # If there are AuditConfigs for both `allServices` and a specific service,
3539 # the union of the two AuditConfigs is used for that service: the log_types
3540 # specified in each AuditConfig are enabled, and the exempted_members in each
3541 # AuditLogConfig are exempted.
3542 #
3543 # Example Policy with multiple AuditConfigs:
3544 #
3545 # {
3546 # &quot;audit_configs&quot;: [
3547 # {
3548 # &quot;service&quot;: &quot;allServices&quot;,
3549 # &quot;audit_log_configs&quot;: [
3550 # {
3551 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3552 # &quot;exempted_members&quot;: [
3553 # &quot;user:[email protected]&quot;
3554 # ]
3555 # },
3556 # {
3557 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3558 # },
3559 # {
3560 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3561 # }
3562 # ]
3563 # },
3564 # {
3565 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3566 # &quot;audit_log_configs&quot;: [
3567 # {
3568 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3569 # },
3570 # {
3571 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3572 # &quot;exempted_members&quot;: [
3573 # &quot;user:[email protected]&quot;
3574 # ]
3575 # }
3576 # ]
3577 # }
3578 # ]
3579 # }
3580 #
3581 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3582 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3583 # `[email protected]` from DATA_WRITE logging.
3584 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3585 { # Provides the configuration for logging a type of permissions.
3586 # Example:
3587 #
3588 # {
3589 # &quot;audit_log_configs&quot;: [
3590 # {
3591 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3592 # &quot;exempted_members&quot;: [
3593 # &quot;user:[email protected]&quot;
3594 # ]
3595 # },
3596 # {
3597 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3598 # }
3599 # ]
3600 # }
3601 #
3602 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3603 # [email protected] from DATA_READ logging.
3604 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3605 # permission.
3606 # Follows the same format of Binding.members.
3607 &quot;A String&quot;,
3608 ],
3609 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3610 },
3611 ],
3612 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3613 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3614 # `allServices` is a special value that covers all services.
3615 },
3616 ],
3617 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3618 # may specify a `condition` that determines how and when the `bindings` are
3619 # applied. Each of the `bindings` must contain at least one principal.
3620 #
3621 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3622 # of these principals can be Google groups. Each occurrence of a principal
3623 # counts towards these limits. For example, if the `bindings` grant 50
3624 # different roles to `user:[email protected]`, and not to any other
3625 # principal, then you can add another 1,450 principals to the `bindings` in
3626 # the `Policy`.
3627 { # Associates `members`, or principals, with a `role`.
3628 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3629 #
3630 # If the condition evaluates to `true`, then this binding applies to the
3631 # current request.
3632 #
3633 # If the condition evaluates to `false`, then this binding does not apply to
3634 # the current request. However, a different role binding might grant the same
3635 # role to one or more of the principals in this binding.
3636 #
3637 # To learn which resources support conditions in their IAM policies, see the
3638 # [IAM
3639 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3640 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3641 # are documented at https://github.com/google/cel-spec.
3642 #
3643 # Example (Comparison):
3644 #
3645 # title: &quot;Summary size limit&quot;
3646 # description: &quot;Determines if a summary is less than 100 chars&quot;
3647 # expression: &quot;document.summary.size() &lt; 100&quot;
3648 #
3649 # Example (Equality):
3650 #
3651 # title: &quot;Requestor is owner&quot;
3652 # description: &quot;Determines if requestor is the document owner&quot;
3653 # expression: &quot;document.owner == request.auth.claims.email&quot;
3654 #
3655 # Example (Logic):
3656 #
3657 # title: &quot;Public documents&quot;
3658 # description: &quot;Determine whether the document should be publicly visible&quot;
3659 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3660 #
3661 # Example (Data Manipulation):
3662 #
3663 # title: &quot;Notification string&quot;
3664 # description: &quot;Create a notification string with a timestamp.&quot;
3665 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3666 #
3667 # The exact variables and functions that may be referenced within an expression
3668 # are determined by the service that evaluates it. See the service
3669 # documentation for additional information.
3670 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3671 # describes the expression, e.g. when hovered over it in a UI.
3672 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3673 # syntax.
3674 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3675 # reporting, e.g. a file name and a position in the file.
3676 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3677 # its purpose. This can be used e.g. in UIs which allow to enter the
3678 # expression.
3679 },
3680 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3681 # `members` can have the following values:
3682 #
3683 # * `allUsers`: A special identifier that represents anyone who is
3684 # on the internet; with or without a Google account.
3685 #
3686 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3687 # who is authenticated with a Google account or a service account.
3688 # Does not include identities that come from external identity providers
3689 # (IdPs) through identity federation.
3690 #
3691 # * `user:{emailid}`: An email address that represents a specific Google
3692 # account. For example, `[email protected]` .
3693 #
3694 #
3695 # * `serviceAccount:{emailid}`: An email address that represents a Google
3696 # service account. For example,
3697 # `[email protected]`.
3698 #
3699 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3700 # identifier for a
3701 # [Kubernetes service
3702 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3703 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3704 #
3705 # * `group:{emailid}`: An email address that represents a Google group.
3706 # For example, `[email protected]`.
3707 #
3708 #
3709 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3710 # users of that domain. For example, `google.com` or `example.com`.
3711 #
3712 #
3713 #
3714 #
3715 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3716 # A single identity in a workforce identity pool.
3717 #
3718 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3719 # All workforce identities in a group.
3720 #
3721 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3722 # All workforce identities with a specific attribute value.
3723 #
3724 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3725 # All identities in a workforce identity pool.
3726 #
3727 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3728 # A single identity in a workload identity pool.
3729 #
3730 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3731 # A workload identity pool group.
3732 #
3733 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3734 # All identities in a workload identity pool with a certain attribute.
3735 #
3736 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3737 # All identities in a workload identity pool.
3738 #
3739 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3740 # identifier) representing a user that has been recently deleted. For
3741 # example, `[email protected]?uid=123456789012345678901`. If the user is
3742 # recovered, this value reverts to `user:{emailid}` and the recovered user
3743 # retains the role in the binding.
3744 #
3745 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3746 # unique identifier) representing a service account that has been recently
3747 # deleted. For example,
3748 # `[email protected]?uid=123456789012345678901`.
3749 # If the service account is undeleted, this value reverts to
3750 # `serviceAccount:{emailid}` and the undeleted service account retains the
3751 # role in the binding.
3752 #
3753 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3754 # identifier) representing a Google group that has been recently
3755 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3756 # the group is recovered, this value reverts to `group:{emailid}` and the
3757 # recovered group retains the role in the binding.
3758 #
3759 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3760 # Deleted single identity in a workforce identity pool. For example,
3761 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3762 &quot;A String&quot;,
3763 ],
3764 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3765 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3766 #
3767 # For an overview of the IAM roles and permissions, see the
3768 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3769 # a list of the available pre-defined roles, see
3770 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3771 },
3772 ],
3773 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3774 # prevent simultaneous updates of a policy from overwriting each other.
3775 # It is strongly suggested that systems make use of the `etag` in the
3776 # read-modify-write cycle to perform policy updates in order to avoid race
3777 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3778 # systems are expected to put that etag in the request to `setIamPolicy` to
3779 # ensure that their change will be applied to the same version of the policy.
3780 #
3781 # **Important:** If you use IAM Conditions, you must include the `etag` field
3782 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3783 # you to overwrite a version `3` policy with a version `1` policy, and all of
3784 # the conditions in the version `3` policy are lost.
3785 &quot;version&quot;: 42, # Specifies the format of the policy.
3786 #
3787 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3788 # are rejected.
3789 #
3790 # Any operation that affects conditional role bindings must specify version
3791 # `3`. This requirement applies to the following operations:
3792 #
3793 # * Getting a policy that includes a conditional role binding
3794 # * Adding a conditional role binding to a policy
3795 # * Changing a conditional role binding in a policy
3796 # * Removing any role binding, with or without a condition, from a policy
3797 # that includes conditions
3798 #
3799 # **Important:** If you use IAM Conditions, you must include the `etag` field
3800 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3801 # you to overwrite a version `3` policy with a version `1` policy, and all of
3802 # the conditions in the version `3` policy are lost.
3803 #
3804 # If a policy does not include any conditions, operations on that policy may
3805 # specify any valid version or leave the field unset.
3806 #
3807 # To learn which resources support conditions in their IAM policies, see the
3808 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3809 },
3810 }
3811
3812 x__xgafv: string, V1 error format.
3813 Allowed values
3814 1 - v1 error format
3815 2 - v2 error format
3816
3817 Returns:
3818 An object of the form:
3819
3820 { # An Identity and Access Management (IAM) policy, which specifies access
3821 # controls for Google Cloud resources.
3822 #
3823 #
3824 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3825 # `members`, or principals, to a single `role`. Principals can be user
3826 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3827 # `role` is a named list of permissions; each `role` can be an IAM predefined
3828 # role or a user-created custom role.
3829 #
3830 # For some types of Google Cloud resources, a `binding` can also specify a
3831 # `condition`, which is a logical expression that allows access to a resource
3832 # only if the expression evaluates to `true`. A condition can add constraints
3833 # based on attributes of the request, the resource, or both. To learn which
3834 # resources support conditions in their IAM policies, see the
3835 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3836 #
3837 # **JSON example:**
3838 #
3839 # ```
3840 # {
3841 # &quot;bindings&quot;: [
3842 # {
3843 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3844 # &quot;members&quot;: [
3845 # &quot;user:[email protected]&quot;,
3846 # &quot;group:[email protected]&quot;,
3847 # &quot;domain:google.com&quot;,
3848 # &quot;serviceAccount:[email protected]&quot;
3849 # ]
3850 # },
3851 # {
3852 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3853 # &quot;members&quot;: [
3854 # &quot;user:[email protected]&quot;
3855 # ],
3856 # &quot;condition&quot;: {
3857 # &quot;title&quot;: &quot;expirable access&quot;,
3858 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3859 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3860 # }
3861 # }
3862 # ],
3863 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3864 # &quot;version&quot;: 3
3865 # }
3866 # ```
3867 #
3868 # **YAML example:**
3869 #
3870 # ```
3871 # bindings:
3872 # - members:
3873 # - user:[email protected]
3874 # - group:[email protected]
3875 # - domain:google.com
3876 # - serviceAccount:[email protected]
3877 # role: roles/resourcemanager.organizationAdmin
3878 # - members:
3879 # - user:[email protected]
3880 # role: roles/resourcemanager.organizationViewer
3881 # condition:
3882 # title: expirable access
3883 # description: Does not grant access after Sep 2020
3884 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3885 # etag: BwWWja0YfJA=
3886 # version: 3
3887 # ```
3888 #
3889 # For a description of IAM and its features, see the
3890 # [IAM documentation](https://cloud.google.com/iam/docs/).
3891 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3892 { # Specifies the audit configuration for a service.
3893 # The configuration determines which permission types are logged, and what
3894 # identities, if any, are exempted from logging.
3895 # An AuditConfig must have one or more AuditLogConfigs.
3896 #
3897 # If there are AuditConfigs for both `allServices` and a specific service,
3898 # the union of the two AuditConfigs is used for that service: the log_types
3899 # specified in each AuditConfig are enabled, and the exempted_members in each
3900 # AuditLogConfig are exempted.
3901 #
3902 # Example Policy with multiple AuditConfigs:
3903 #
3904 # {
3905 # &quot;audit_configs&quot;: [
3906 # {
3907 # &quot;service&quot;: &quot;allServices&quot;,
3908 # &quot;audit_log_configs&quot;: [
3909 # {
3910 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3911 # &quot;exempted_members&quot;: [
3912 # &quot;user:[email protected]&quot;
3913 # ]
3914 # },
3915 # {
3916 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3917 # },
3918 # {
3919 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3920 # }
3921 # ]
3922 # },
3923 # {
3924 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3925 # &quot;audit_log_configs&quot;: [
3926 # {
3927 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3928 # },
3929 # {
3930 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3931 # &quot;exempted_members&quot;: [
3932 # &quot;user:[email protected]&quot;
3933 # ]
3934 # }
3935 # ]
3936 # }
3937 # ]
3938 # }
3939 #
3940 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3941 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3942 # `[email protected]` from DATA_WRITE logging.
3943 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3944 { # Provides the configuration for logging a type of permissions.
3945 # Example:
3946 #
3947 # {
3948 # &quot;audit_log_configs&quot;: [
3949 # {
3950 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3951 # &quot;exempted_members&quot;: [
3952 # &quot;user:[email protected]&quot;
3953 # ]
3954 # },
3955 # {
3956 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3957 # }
3958 # ]
3959 # }
3960 #
3961 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3962 # [email protected] from DATA_READ logging.
3963 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3964 # permission.
3965 # Follows the same format of Binding.members.
3966 &quot;A String&quot;,
3967 ],
3968 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3969 },
3970 ],
3971 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3972 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3973 # `allServices` is a special value that covers all services.
3974 },
3975 ],
3976 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3977 # may specify a `condition` that determines how and when the `bindings` are
3978 # applied. Each of the `bindings` must contain at least one principal.
3979 #
3980 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3981 # of these principals can be Google groups. Each occurrence of a principal
3982 # counts towards these limits. For example, if the `bindings` grant 50
3983 # different roles to `user:[email protected]`, and not to any other
3984 # principal, then you can add another 1,450 principals to the `bindings` in
3985 # the `Policy`.
3986 { # Associates `members`, or principals, with a `role`.
3987 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3988 #
3989 # If the condition evaluates to `true`, then this binding applies to the
3990 # current request.
3991 #
3992 # If the condition evaluates to `false`, then this binding does not apply to
3993 # the current request. However, a different role binding might grant the same
3994 # role to one or more of the principals in this binding.
3995 #
3996 # To learn which resources support conditions in their IAM policies, see the
3997 # [IAM
3998 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3999 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4000 # are documented at https://github.com/google/cel-spec.
4001 #
4002 # Example (Comparison):
4003 #
4004 # title: &quot;Summary size limit&quot;
4005 # description: &quot;Determines if a summary is less than 100 chars&quot;
4006 # expression: &quot;document.summary.size() &lt; 100&quot;
4007 #
4008 # Example (Equality):
4009 #
4010 # title: &quot;Requestor is owner&quot;
4011 # description: &quot;Determines if requestor is the document owner&quot;
4012 # expression: &quot;document.owner == request.auth.claims.email&quot;
4013 #
4014 # Example (Logic):
4015 #
4016 # title: &quot;Public documents&quot;
4017 # description: &quot;Determine whether the document should be publicly visible&quot;
4018 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4019 #
4020 # Example (Data Manipulation):
4021 #
4022 # title: &quot;Notification string&quot;
4023 # description: &quot;Create a notification string with a timestamp.&quot;
4024 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4025 #
4026 # The exact variables and functions that may be referenced within an expression
4027 # are determined by the service that evaluates it. See the service
4028 # documentation for additional information.
4029 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4030 # describes the expression, e.g. when hovered over it in a UI.
4031 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4032 # syntax.
4033 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4034 # reporting, e.g. a file name and a position in the file.
4035 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4036 # its purpose. This can be used e.g. in UIs which allow to enter the
4037 # expression.
4038 },
4039 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4040 # `members` can have the following values:
4041 #
4042 # * `allUsers`: A special identifier that represents anyone who is
4043 # on the internet; with or without a Google account.
4044 #
4045 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4046 # who is authenticated with a Google account or a service account.
4047 # Does not include identities that come from external identity providers
4048 # (IdPs) through identity federation.
4049 #
4050 # * `user:{emailid}`: An email address that represents a specific Google
4051 # account. For example, `[email protected]` .
4052 #
4053 #
4054 # * `serviceAccount:{emailid}`: An email address that represents a Google
4055 # service account. For example,
4056 # `[email protected]`.
4057 #
4058 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4059 # identifier for a
4060 # [Kubernetes service
4061 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4062 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4063 #
4064 # * `group:{emailid}`: An email address that represents a Google group.
4065 # For example, `[email protected]`.
4066 #
4067 #
4068 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4069 # users of that domain. For example, `google.com` or `example.com`.
4070 #
4071 #
4072 #
4073 #
4074 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4075 # A single identity in a workforce identity pool.
4076 #
4077 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4078 # All workforce identities in a group.
4079 #
4080 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4081 # All workforce identities with a specific attribute value.
4082 #
4083 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4084 # All identities in a workforce identity pool.
4085 #
4086 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4087 # A single identity in a workload identity pool.
4088 #
4089 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4090 # A workload identity pool group.
4091 #
4092 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4093 # All identities in a workload identity pool with a certain attribute.
4094 #
4095 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4096 # All identities in a workload identity pool.
4097 #
4098 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4099 # identifier) representing a user that has been recently deleted. For
4100 # example, `[email protected]?uid=123456789012345678901`. If the user is
4101 # recovered, this value reverts to `user:{emailid}` and the recovered user
4102 # retains the role in the binding.
4103 #
4104 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4105 # unique identifier) representing a service account that has been recently
4106 # deleted. For example,
4107 # `[email protected]?uid=123456789012345678901`.
4108 # If the service account is undeleted, this value reverts to
4109 # `serviceAccount:{emailid}` and the undeleted service account retains the
4110 # role in the binding.
4111 #
4112 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4113 # identifier) representing a Google group that has been recently
4114 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4115 # the group is recovered, this value reverts to `group:{emailid}` and the
4116 # recovered group retains the role in the binding.
4117 #
4118 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4119 # Deleted single identity in a workforce identity pool. For example,
4120 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4121 &quot;A String&quot;,
4122 ],
4123 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4124 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4125 #
4126 # For an overview of the IAM roles and permissions, see the
4127 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4128 # a list of the available pre-defined roles, see
4129 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4130 },
4131 ],
4132 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4133 # prevent simultaneous updates of a policy from overwriting each other.
4134 # It is strongly suggested that systems make use of the `etag` in the
4135 # read-modify-write cycle to perform policy updates in order to avoid race
4136 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4137 # systems are expected to put that etag in the request to `setIamPolicy` to
4138 # ensure that their change will be applied to the same version of the policy.
4139 #
4140 # **Important:** If you use IAM Conditions, you must include the `etag` field
4141 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4142 # you to overwrite a version `3` policy with a version `1` policy, and all of
4143 # the conditions in the version `3` policy are lost.
4144 &quot;version&quot;: 42, # Specifies the format of the policy.
4145 #
4146 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4147 # are rejected.
4148 #
4149 # Any operation that affects conditional role bindings must specify version
4150 # `3`. This requirement applies to the following operations:
4151 #
4152 # * Getting a policy that includes a conditional role binding
4153 # * Adding a conditional role binding to a policy
4154 # * Changing a conditional role binding in a policy
4155 # * Removing any role binding, with or without a condition, from a policy
4156 # that includes conditions
4157 #
4158 # **Important:** If you use IAM Conditions, you must include the `etag` field
4159 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4160 # you to overwrite a version `3` policy with a version `1` policy, and all of
4161 # the conditions in the version `3` policy are lost.
4162 #
4163 # If a policy does not include any conditions, operations on that policy may
4164 # specify any valid version or leave the field unset.
4165 #
4166 # To learn which resources support conditions in their IAM policies, see the
4167 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4168 }</pre>
4169 </div>
4170
4171 <div class="method">
4172 <code class="details" id="setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
4173 <pre>Updates the node template of the node group.
4174
4175 Args:
4176 project: string, Project ID for this request. (required)
4177 zone: string, The name of the zone for this request. (required)
4178 nodeGroup: string, Name of the NodeGroup resource to update. (required)
4179 body: object, The request body.
4180 The object takes the form of:
4181
4182 {
4183 &quot;nodeTemplate&quot;: &quot;A String&quot;, # Full or partial URL of the node template resource to be updated for this
4184 # node group.
4185 }
4186
4187 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4188 that if you must retry your request, the server will know to ignore the
4189 request if it has already been completed.
4190
4191 For example, consider a situation where you make an initial request and
4192 the request times out. If you make the request again with the same
4193 request ID, the server can check if original operation with the same
4194 request ID was received, and if so, will ignore the second request. This
4195 prevents clients from accidentally creating duplicate commitments.
4196
4197 The request ID must be
4198 a valid UUID with the exception that zero UUID is not supported
4199 (00000000-0000-0000-0000-000000000000).
4200 x__xgafv: string, V1 error format.
4201 Allowed values
4202 1 - v1 error format
4203 2 - v2 error format
4204
4205 Returns:
4206 An object of the form:
4207
4208 { # Represents an Operation resource.
4209 #
4210 # Google Compute Engine has three Operation resources:
4211 #
4212 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4213 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4214 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4215 #
4216 # You can use an operation resource to manage asynchronous API requests.
4217 # For more information, readHandling
4218 # API responses.
4219 #
4220 # Operations can be global, regional or zonal.
4221 #
4222 # - For global operations, use the `globalOperations`
4223 # resource.
4224 # - For regional operations, use the
4225 # `regionOperations` resource.
4226 # - For zonal operations, use
4227 # the `zoneOperations` resource.
4228 #
4229 #
4230 #
4231 # For more information, read
4232 # Global, Regional, and Zonal Resources.
4233 #
4234 # Note that completed Operation resources have a limited
4235 # retention period.
4236 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4237 # Not present otherwise.
4238 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4239 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4240 # set when the operation is created.
4241 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4242 # text format.
4243 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4244 # this field will be populated.
4245 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4246 # operation.
4247 {
4248 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4249 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4250 # details. There is a set of defined message types to use for providing
4251 # details.The syntax depends on the error code. For example,
4252 # QuotaExceededInfo will have details when the error code is
4253 # QUOTA_EXCEEDED.
4254 {
4255 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4256 #
4257 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4258 # is not enabled:
4259 #
4260 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4261 # &quot;domain&quot;: &quot;googleapis.com&quot;
4262 # &quot;metadata&quot;: {
4263 # &quot;resource&quot;: &quot;projects/123&quot;,
4264 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4265 # }
4266 # }
4267 #
4268 # This response indicates that the pubsub.googleapis.com API is not enabled.
4269 #
4270 # Example of an error that is returned when attempting to create a Spanner
4271 # instance in a region that is out of stock:
4272 #
4273 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4274 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4275 # &quot;metadata&quot;: {
4276 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4277 # }
4278 # }
4279 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4280 # is typically the registered service name of the tool or product that
4281 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4282 # generated by some common infrastructure, the error domain must be a
4283 # globally unique value that identifies the infrastructure. For Google API
4284 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4285 &quot;metadatas&quot;: { # Additional structured details about this error.
4286 #
4287 # Keys must match a regular expression of `a-z+` but should
4288 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4289 # length. When identifying the current value of an exceeded limit, the units
4290 # should be contained in the key, not the value. For example, rather than
4291 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4292 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4293 # instances that can be created in a single (batch) request.
4294 &quot;a_key&quot;: &quot;A String&quot;,
4295 },
4296 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4297 # proximate cause of the error. Error reasons are unique within a particular
4298 # domain of errors. This should be at most 63 characters and match a
4299 # regular expression of `A-Z+[A-Z0-9]`, which represents
4300 # UPPER_SNAKE_CASE.
4301 },
4302 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4303 #
4304 # For example, if a quota check failed with an error indicating the calling
4305 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4306 # directly to the right place in the developer console to flip the bit.
4307 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4308 { # Describes a URL link.
4309 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4310 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4311 },
4312 ],
4313 },
4314 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4315 # which can be attached to an RPC error.
4316 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4317 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4318 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4319 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4320 },
4321 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4322 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4323 &quot;a_key&quot;: &quot;A String&quot;,
4324 },
4325 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4326 # type or metric.
4327 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4328 # or metric.
4329 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4330 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4331 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4332 },
4333 },
4334 ],
4335 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4336 # This property is optional.
4337 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4338 },
4339 ],
4340 },
4341 &quot;getVersionOperationMetadata&quot;: {
4342 &quot;inlineSbomInfo&quot;: {
4343 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4344 # appropriate identifiers.
4345 &quot;a_key&quot;: &quot;A String&quot;,
4346 },
4347 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4348 # identifiers.
4349 &quot;a_key&quot;: &quot;A String&quot;,
4350 },
4351 },
4352 },
4353 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4354 # message that was returned, such as `NOT FOUND`.
4355 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4356 # status code that was returned. For example, a `404` means the
4357 # resource was not found.
4358 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4359 # defined by the server.
4360 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4361 # This value is inRFC3339
4362 # text format.
4363 &quot;instancesBulkInsertOperationMetadata&quot;: {
4364 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4365 # Example key: zones/us-central1-a
4366 &quot;a_key&quot;: {
4367 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4368 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4369 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4370 # error.
4371 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4372 # if the flow is rolling forward or rolling back.
4373 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4374 },
4375 },
4376 },
4377 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4378 # Operation resources.
4379 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4380 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4381 # group of operations results from a `bulkInsert` API request.
4382 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4383 # `update`, or `delete`, and so on.
4384 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4385 # There is no requirement that this be linear or support any granularity of
4386 # operations. This should not be used to guess when the operation will be
4387 # complete. This number should monotonically increase as the operation
4388 # progresses.
4389 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4390 # applicable when performing regional operations.
4391 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4392 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4393 # this field will contain information on all underlying zonal actions and
4394 # their state.
4395 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4396 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4397 # Example key: zones/us-central1-a
4398 &quot;a_key&quot;: {
4399 &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
4400 # populated.
4401 # different programming environments, including REST APIs and RPC APIs. It is
4402 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4403 # three pieces of data: error code, error message, and error details.
4404 #
4405 # You can find out more about this error model and how to work with it in the
4406 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4407 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4408 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4409 # message types for APIs to use.
4410 {
4411 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4412 },
4413 ],
4414 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4415 # user-facing error message should be localized and sent in the
4416 # google.rpc.Status.details field, or localized by the client.
4417 },
4418 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4419 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4420 },
4421 },
4422 },
4423 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4424 # This value is inRFC3339
4425 # text format.
4426 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4427 # following:
4428 # `PENDING`, `RUNNING`, or `DONE`.
4429 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4430 # operation.
4431 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4432 # of the target resource.
4433 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4434 # operations related to creating a snapshot, this points to the disk
4435 # that the snapshot was created from.
4436 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4437 # `[email protected]` or
4438 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4439 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4440 # operation, this field will be populated.
4441 {
4442 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4443 # Engine returns NO_RESULTS_ON_PAGE if there
4444 # are no results in the response.
4445 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4446 # value format. For example:
4447 #
4448 # &quot;data&quot;: [
4449 # {
4450 # &quot;key&quot;: &quot;scope&quot;,
4451 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4452 # }
4453 {
4454 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4455 # returned. For example, for warnings where there are no results in a list
4456 # request for a particular zone, this key might be scope and
4457 # the key value might be the zone name. Other examples might be a key
4458 # indicating a deprecated resource and a suggested replacement, or a
4459 # warning about invalid network settings (for example, if an instance
4460 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4461 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4462 },
4463 ],
4464 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4465 },
4466 ],
4467 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4468 # applicable when performing per-zone operations.
4469 }</pre>
4470 </div>
4471
4472 <div class="method">
4473 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
4474 <pre>Simulates maintenance event on specified nodes from the node group.
4475
4476 Args:
4477 project: string, Project ID for this request. (required)
4478 zone: string, The name of the zone for this request. (required)
4479 nodeGroup: string, Name of the NodeGroup resource whose nodes will go under maintenance
4480 simulation. (required)
4481 body: object, The request body.
4482 The object takes the form of:
4483
4484 {
4485 &quot;nodes&quot;: [ # Names of the nodes to go under maintenance simulation.
4486 &quot;A String&quot;,
4487 ],
4488 }
4489
4490 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4491 that if you must retry your request, the server will know to ignore the
4492 request if it has already been completed.
4493
4494 For example, consider a situation where you make an initial request and
4495 the request times out. If you make the request again with the same
4496 request ID, the server can check if original operation with the same
4497 request ID was received, and if so, will ignore the second request. This
4498 prevents clients from accidentally creating duplicate commitments.
4499
4500 The request ID must be
4501 a valid UUID with the exception that zero UUID is not supported
4502 (00000000-0000-0000-0000-000000000000).
4503 x__xgafv: string, V1 error format.
4504 Allowed values
4505 1 - v1 error format
4506 2 - v2 error format
4507
4508 Returns:
4509 An object of the form:
4510
4511 { # Represents an Operation resource.
4512 #
4513 # Google Compute Engine has three Operation resources:
4514 #
4515 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4516 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4517 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4518 #
4519 # You can use an operation resource to manage asynchronous API requests.
4520 # For more information, readHandling
4521 # API responses.
4522 #
4523 # Operations can be global, regional or zonal.
4524 #
4525 # - For global operations, use the `globalOperations`
4526 # resource.
4527 # - For regional operations, use the
4528 # `regionOperations` resource.
4529 # - For zonal operations, use
4530 # the `zoneOperations` resource.
4531 #
4532 #
4533 #
4534 # For more information, read
4535 # Global, Regional, and Zonal Resources.
4536 #
4537 # Note that completed Operation resources have a limited
4538 # retention period.
4539 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4540 # Not present otherwise.
4541 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4542 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4543 # set when the operation is created.
4544 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4545 # text format.
4546 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4547 # this field will be populated.
4548 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4549 # operation.
4550 {
4551 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4552 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4553 # details. There is a set of defined message types to use for providing
4554 # details.The syntax depends on the error code. For example,
4555 # QuotaExceededInfo will have details when the error code is
4556 # QUOTA_EXCEEDED.
4557 {
4558 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4559 #
4560 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4561 # is not enabled:
4562 #
4563 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4564 # &quot;domain&quot;: &quot;googleapis.com&quot;
4565 # &quot;metadata&quot;: {
4566 # &quot;resource&quot;: &quot;projects/123&quot;,
4567 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4568 # }
4569 # }
4570 #
4571 # This response indicates that the pubsub.googleapis.com API is not enabled.
4572 #
4573 # Example of an error that is returned when attempting to create a Spanner
4574 # instance in a region that is out of stock:
4575 #
4576 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4577 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4578 # &quot;metadata&quot;: {
4579 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4580 # }
4581 # }
4582 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4583 # is typically the registered service name of the tool or product that
4584 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4585 # generated by some common infrastructure, the error domain must be a
4586 # globally unique value that identifies the infrastructure. For Google API
4587 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4588 &quot;metadatas&quot;: { # Additional structured details about this error.
4589 #
4590 # Keys must match a regular expression of `a-z+` but should
4591 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4592 # length. When identifying the current value of an exceeded limit, the units
4593 # should be contained in the key, not the value. For example, rather than
4594 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4595 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4596 # instances that can be created in a single (batch) request.
4597 &quot;a_key&quot;: &quot;A String&quot;,
4598 },
4599 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4600 # proximate cause of the error. Error reasons are unique within a particular
4601 # domain of errors. This should be at most 63 characters and match a
4602 # regular expression of `A-Z+[A-Z0-9]`, which represents
4603 # UPPER_SNAKE_CASE.
4604 },
4605 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4606 #
4607 # For example, if a quota check failed with an error indicating the calling
4608 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4609 # directly to the right place in the developer console to flip the bit.
4610 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4611 { # Describes a URL link.
4612 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4613 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4614 },
4615 ],
4616 },
4617 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4618 # which can be attached to an RPC error.
4619 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4620 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4621 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4622 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4623 },
4624 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4625 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4626 &quot;a_key&quot;: &quot;A String&quot;,
4627 },
4628 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4629 # type or metric.
4630 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4631 # or metric.
4632 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4633 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4634 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4635 },
4636 },
4637 ],
4638 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4639 # This property is optional.
4640 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4641 },
4642 ],
4643 },
4644 &quot;getVersionOperationMetadata&quot;: {
4645 &quot;inlineSbomInfo&quot;: {
4646 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4647 # appropriate identifiers.
4648 &quot;a_key&quot;: &quot;A String&quot;,
4649 },
4650 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4651 # identifiers.
4652 &quot;a_key&quot;: &quot;A String&quot;,
4653 },
4654 },
4655 },
4656 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4657 # message that was returned, such as `NOT FOUND`.
4658 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4659 # status code that was returned. For example, a `404` means the
4660 # resource was not found.
4661 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4662 # defined by the server.
4663 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4664 # This value is inRFC3339
4665 # text format.
4666 &quot;instancesBulkInsertOperationMetadata&quot;: {
4667 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4668 # Example key: zones/us-central1-a
4669 &quot;a_key&quot;: {
4670 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4671 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4672 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4673 # error.
4674 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4675 # if the flow is rolling forward or rolling back.
4676 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4677 },
4678 },
4679 },
4680 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4681 # Operation resources.
4682 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4683 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4684 # group of operations results from a `bulkInsert` API request.
4685 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4686 # `update`, or `delete`, and so on.
4687 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4688 # There is no requirement that this be linear or support any granularity of
4689 # operations. This should not be used to guess when the operation will be
4690 # complete. This number should monotonically increase as the operation
4691 # progresses.
4692 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4693 # applicable when performing regional operations.
4694 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4695 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4696 # this field will contain information on all underlying zonal actions and
4697 # their state.
4698 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4699 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4700 # Example key: zones/us-central1-a
4701 &quot;a_key&quot;: {
4702 &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
4703 # populated.
4704 # different programming environments, including REST APIs and RPC APIs. It is
4705 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4706 # three pieces of data: error code, error message, and error details.
4707 #
4708 # You can find out more about this error model and how to work with it in the
4709 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4710 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4711 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4712 # message types for APIs to use.
4713 {
4714 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4715 },
4716 ],
4717 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4718 # user-facing error message should be localized and sent in the
4719 # google.rpc.Status.details field, or localized by the client.
4720 },
4721 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4722 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4723 },
4724 },
4725 },
4726 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4727 # This value is inRFC3339
4728 # text format.
4729 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4730 # following:
4731 # `PENDING`, `RUNNING`, or `DONE`.
4732 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4733 # operation.
4734 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4735 # of the target resource.
4736 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4737 # operations related to creating a snapshot, this points to the disk
4738 # that the snapshot was created from.
4739 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4740 # `[email protected]` or
4741 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4742 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4743 # operation, this field will be populated.
4744 {
4745 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4746 # Engine returns NO_RESULTS_ON_PAGE if there
4747 # are no results in the response.
4748 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4749 # value format. For example:
4750 #
4751 # &quot;data&quot;: [
4752 # {
4753 # &quot;key&quot;: &quot;scope&quot;,
4754 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4755 # }
4756 {
4757 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4758 # returned. For example, for warnings where there are no results in a list
4759 # request for a particular zone, this key might be scope and
4760 # the key value might be the zone name. Other examples might be a key
4761 # indicating a deprecated resource and a suggested replacement, or a
4762 # warning about invalid network settings (for example, if an instance
4763 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4764 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4765 },
4766 ],
4767 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4768 },
4769 ],
4770 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4771 # applicable when performing per-zone operations.
4772 }</pre>
4773 </div>
4774
4775 <div class="method">
4776 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
4777 <pre>Returns permissions that a caller has on the specified resource.
4778
4779 Args:
4780 project: string, Project ID for this request. (required)
4781 zone: string, The name of the zone for this request. (required)
4782 resource: string, Name or id of the resource for this request. (required)
4783 body: object, The request body.
4784 The object takes the form of:
4785
4786 {
4787 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
4788 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
4789 &quot;A String&quot;,
4790 ],
4791 }
4792
4793 x__xgafv: string, V1 error format.
4794 Allowed values
4795 1 - v1 error format
4796 2 - v2 error format
4797
4798 Returns:
4799 An object of the form:
4800
4801 {
4802 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4803 # allowed.
4804 &quot;A String&quot;,
4805 ],
4806 }</pre>
4807 </div>
4808
4809 </body></html>