Debian Codegraph @

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