Debian Codegraph @

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