Debian Codegraph @

docs/dyn/compute_alpha.nodeTemplates.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.nodeTemplates.html">nodeTemplates</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <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>
79 <p class="firstline">Retrieves an aggregated list of node templates.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, nodeTemplate, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified NodeTemplate resource.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, nodeTemplate, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified node template.</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a NodeTemplate resource in the specified project using the data</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves a list of node templates available to the specified</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Sets the access control policy on the specified resource.</p>
107 <p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <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>
113 <pre>Retrieves an aggregated list of node templates.
114
115 To prevent failure, Google recommends that you set the
116 `returnPartialSuccess` parameter to `true`.
117
118 Args:
119 project: string, Project ID for this request. (required)
120 filter: string, A filter expression that filters resources listed in the response. Most
121 Compute resources support two types of filter expressions:
122 expressions that support regular expressions and expressions that follow
123 API improvement proposal AIP-160.
124 These two types of filter expressions cannot be mixed in one request.
125
126 If you want to use AIP-160, your expression must specify the field name, an
127 operator, and the value that you want to use for filtering. The value
128 must be a string, a number, or a boolean. The operator
129 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
130
131 For example, if you are filtering Compute Engine instances, you can
132 exclude instances named `example-instance` by specifying
133 `name != example-instance`.
134
135 The `:*` comparison can be used to test whether a key has been defined.
136 For example, to find all objects with `owner` label use:
137 ```
138 labels.owner:*
139 ```
140
141 You can also filter nested fields. For example, you could specify
142 `scheduling.automaticRestart = false` to include instances only
143 if they are not scheduled for automatic restarts. You can use filtering
144 on nested fields to filter based onresource labels.
145
146 To filter on multiple expressions, provide each separate expression within
147 parentheses. For example:
148 ```
149 (scheduling.automaticRestart = true)
150 (cpuPlatform = &quot;Intel Skylake&quot;)
151 ```
152 By default, each expression is an `AND` expression. However, you
153 can include `AND` and `OR` expressions explicitly.
154 For example:
155 ```
156 (cpuPlatform = &quot;Intel Skylake&quot;) OR
157 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
158 (scheduling.automaticRestart = true)
159 ```
160
161 If you want to use a regular expression, use the `eq` (equal) or `ne`
162 (not equal) operator against a single un-parenthesized expression with or
163 without quotes or against multiple parenthesized expressions. Examples:
164
165 `fieldname eq unquoted literal`
166 `fieldname eq &#x27;single quoted literal&#x27;`
167 `fieldname eq &quot;double quoted literal&quot;`
168 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
169
170 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
171 The literal value must match the entire field.
172
173 For example, to filter for instances that do not end with name &quot;instance&quot;,
174 you would use `name ne .*instance`.
175
176 You cannot combine constraints on multiple fields using regular
177 expressions.
178 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
179 global) should be included in the response. For new resource types added
180 after this field, the flag has no effect as new resource types will always
181 include every visible scope for each scope type in response. For resource
182 types which predate this field, if this flag is omitted or false, only
183 scopes of the scope types where the resource type is expected to be found
184 will be included.
185 maxResults: integer, The maximum number of results per page that should be returned.
186 If the number of available results is larger than `maxResults`,
187 Compute Engine returns a `nextPageToken` that can be used to get
188 the next page of results in subsequent list requests. Acceptable values are
189 `0` to `500`, inclusive. (Default: `500`)
190 orderBy: string, Sorts list results by a certain order. By default, results
191 are returned in alphanumerical order based on the resource name.
192
193 You can also sort results in descending order based on the creation
194 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
195 results based on the `creationTimestamp` field in
196 reverse chronological order (newest result first). Use this to sort
197 resources like operations so that the newest operation is returned first.
198
199 Currently, only sorting by `name` or
200 `creationTimestamp desc` is supported.
201 pageToken: string, Specifies a page token to use. Set `pageToken` to the
202 `nextPageToken` returned by a previous list request to get
203 the next page of results.
204 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
205 of failure. The default value is false.
206
207 For example, when partial success behavior is enabled, aggregatedList for a
208 single zone scope either returns all resources in the zone or no resources,
209 with an error code.
210 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
211 aggregated list request is invoked for subnetworks list-usable api.
212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217 Returns:
218 An object of the form:
219
220 {
221 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
222 &quot;items&quot;: { # A list of NodeTemplatesScopedList resources.
223 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of node templates.
224 &quot;nodeTemplates&quot;: [ # [Output Only] A list of node templates contained in this scope.
225 { # Represent a sole-tenant Node Template resource.
226 #
227 # You can use a template to define properties for nodes in a node group. For
228 # more information, readCreating node groups
229 # and instances.
230 &quot;accelerators&quot;: [
231 { # A specification of the type and number of accelerator cards attached to the
232 # instance.
233 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
234 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
235 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
236 # If you are creating an instance template, specify only the
237 # accelerator name.
238 # See GPUs on Compute Engine
239 # for a full list of accelerator types.
240 },
241 ],
242 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
243 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
244 # text format.
245 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
246 # create the resource.
247 &quot;disks&quot;: [
248 {
249 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
250 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
251 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a
252 # local storage type (e.g.: local-ssd).
253 # Note that for nodeTemplates, this should be the name of the disk type and
254 # not its URL.
255 },
256 ],
257 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
258 # defined by the server.
259 &quot;kind&quot;: &quot;compute#nodeTemplate&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeTemplate for node templates.
260 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
261 # the resource. The resource name must be 1-63 characters long, and comply
262 # withRFC1035.
263 # Specifically, the name must be 1-63 characters long and match the regular
264 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
265 # character must be a lowercase letter, and all following characters must be
266 # a dash, lowercase letter, or digit, except the last character, which
267 # cannot be a dash.
268 &quot;nodeAffinityLabels&quot;: { # Labels to use for node affinity, which will be used in instance scheduling.
269 &quot;a_key&quot;: &quot;A String&quot;,
270 },
271 &quot;nodeType&quot;: &quot;A String&quot;, # The node type to use for nodes group that are created from this template.
272 &quot;nodeTypeFlexibility&quot;: { # Do not use. Instead, use the node_type property.
273 &quot;cpus&quot;: &quot;A String&quot;,
274 &quot;localSsd&quot;: &quot;A String&quot;,
275 &quot;memory&quot;: &quot;A String&quot;,
276 },
277 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the region where the node template resides,
278 # such as us-central1.
279 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
280 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
281 &quot;serverBinding&quot;: { # Sets the binding properties for the physical server. Valid values include:
282 #
283 # - *[Default]* RESTART_NODE_ON_ANY_SERVER:
284 # Restarts VMs on any available
285 # physical server
286 # - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same
287 # physical server whenever possible
288 #
289 #
290 #
291 # See Sole-tenant
292 # node options for more information.
293 &quot;type&quot;: &quot;A String&quot;,
294 },
295 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the node template. One of the following values:CREATING, READY, and DELETING.
296 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
297 },
298 ],
299 &quot;warning&quot;: { # [Output Only] An informational warning that appears when the node templates
300 # list is empty.
301 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
302 # Engine returns NO_RESULTS_ON_PAGE if there
303 # are no results in the response.
304 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
305 # value format. For example:
306 #
307 # &quot;data&quot;: [
308 # {
309 # &quot;key&quot;: &quot;scope&quot;,
310 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
311 # }
312 {
313 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
314 # returned. For example, for warnings where there are no results in a list
315 # request for a particular zone, this key might be scope and
316 # the key value might be the zone name. Other examples might be a key
317 # indicating a deprecated resource and a suggested replacement, or a
318 # warning about invalid network settings (for example, if an instance
319 # attempts to perform IP forwarding but is not enabled for IP forwarding).
320 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
321 },
322 ],
323 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
324 },
325 },
326 },
327 &quot;kind&quot;: &quot;compute#nodeTemplateAggregatedList&quot;, # Output only. [Output Only] Type of resource.Alwayscompute#nodeTemplateAggregatedList for aggregated lists of
328 # node templates.
329 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
330 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
331 # the query parameter pageToken in the next list request.
332 # Subsequent list requests will have their own nextPageToken to
333 # continue paging through the results.
334 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
335 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
336 &quot;A String&quot;,
337 ],
338 &quot;warning&quot;: { # [Output Only] Informational warning message.
339 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
340 # Engine returns NO_RESULTS_ON_PAGE if there
341 # are no results in the response.
342 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
343 # value format. For example:
344 #
345 # &quot;data&quot;: [
346 # {
347 # &quot;key&quot;: &quot;scope&quot;,
348 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
349 # }
350 {
351 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
352 # returned. For example, for warnings where there are no results in a list
353 # request for a particular zone, this key might be scope and
354 # the key value might be the zone name. Other examples might be a key
355 # indicating a deprecated resource and a suggested replacement, or a
356 # warning about invalid network settings (for example, if an instance
357 # attempts to perform IP forwarding but is not enabled for IP forwarding).
358 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
359 },
360 ],
361 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
362 },
363 }</pre>
364 </div>
365
366 <div class="method">
367 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
368 <pre>Retrieves the next page of results.
369
370 Args:
371 previous_request: The request for the previous page. (required)
372 previous_response: The response from the request for the previous page. (required)
373
374 Returns:
375 A request object that you can call &#x27;execute()&#x27; on to request the next
376 page. Returns None if there are no more items in the collection.
377 </pre>
378 </div>
379
380 <div class="method">
381 <code class="details" id="close">close()</code>
382 <pre>Close httplib2 connections.</pre>
383 </div>
384
385 <div class="method">
386 <code class="details" id="delete">delete(project, region, nodeTemplate, requestId=None, x__xgafv=None)</code>
387 <pre>Deletes the specified NodeTemplate resource.
388
389 Args:
390 project: string, Project ID for this request. (required)
391 region: string, The name of the region for this request. (required)
392 nodeTemplate: string, Name of the NodeTemplate resource to delete. (required)
393 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
394 that if you must retry your request, the server will know to ignore the
395 request if it has already been completed.
396
397 For example, consider a situation where you make an initial request and
398 the request times out. If you make the request again with the same
399 request ID, the server can check if original operation with the same
400 request ID was received, and if so, will ignore the second request. This
401 prevents clients from accidentally creating duplicate commitments.
402
403 The request ID must be
404 a valid UUID with the exception that zero UUID is not supported
405 (00000000-0000-0000-0000-000000000000).
406 x__xgafv: string, V1 error format.
407 Allowed values
408 1 - v1 error format
409 2 - v2 error format
410
411 Returns:
412 An object of the form:
413
414 { # Represents an Operation resource.
415 #
416 # Google Compute Engine has three Operation resources:
417 #
418 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
419 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
420 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
421 #
422 # You can use an operation resource to manage asynchronous API requests.
423 # For more information, readHandling
424 # API responses.
425 #
426 # Operations can be global, regional or zonal.
427 #
428 # - For global operations, use the `globalOperations`
429 # resource.
430 # - For regional operations, use the
431 # `regionOperations` resource.
432 # - For zonal operations, use
433 # the `zoneOperations` resource.
434 #
435 #
436 #
437 # For more information, read
438 # Global, Regional, and Zonal Resources.
439 #
440 # Note that completed Operation resources have a limited
441 # retention period.
442 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
443 # Not present otherwise.
444 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
445 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
446 # set when the operation is created.
447 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
448 # text format.
449 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
450 # this field will be populated.
451 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
452 # operation.
453 {
454 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
455 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
456 # details. There is a set of defined message types to use for providing
457 # details.The syntax depends on the error code. For example,
458 # QuotaExceededInfo will have details when the error code is
459 # QUOTA_EXCEEDED.
460 {
461 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
462 #
463 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
464 # is not enabled:
465 #
466 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
467 # &quot;domain&quot;: &quot;googleapis.com&quot;
468 # &quot;metadata&quot;: {
469 # &quot;resource&quot;: &quot;projects/123&quot;,
470 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
471 # }
472 # }
473 #
474 # This response indicates that the pubsub.googleapis.com API is not enabled.
475 #
476 # Example of an error that is returned when attempting to create a Spanner
477 # instance in a region that is out of stock:
478 #
479 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
480 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
481 # &quot;metadata&quot;: {
482 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
483 # }
484 # }
485 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
486 # is typically the registered service name of the tool or product that
487 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
488 # generated by some common infrastructure, the error domain must be a
489 # globally unique value that identifies the infrastructure. For Google API
490 # infrastructure, the error domain is &quot;googleapis.com&quot;.
491 &quot;metadatas&quot;: { # Additional structured details about this error.
492 #
493 # Keys must match a regular expression of `a-z+` but should
494 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
495 # length. When identifying the current value of an exceeded limit, the units
496 # should be contained in the key, not the value. For example, rather than
497 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
498 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
499 # instances that can be created in a single (batch) request.
500 &quot;a_key&quot;: &quot;A String&quot;,
501 },
502 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
503 # proximate cause of the error. Error reasons are unique within a particular
504 # domain of errors. This should be at most 63 characters and match a
505 # regular expression of `A-Z+[A-Z0-9]`, which represents
506 # UPPER_SNAKE_CASE.
507 },
508 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
509 #
510 # For example, if a quota check failed with an error indicating the calling
511 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
512 # directly to the right place in the developer console to flip the bit.
513 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
514 { # Describes a URL link.
515 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
516 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
517 },
518 ],
519 },
520 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
521 # which can be attached to an RPC error.
522 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
523 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
524 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
525 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
526 },
527 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
528 &quot;dimensions&quot;: { # The map holding related quota dimensions.
529 &quot;a_key&quot;: &quot;A String&quot;,
530 },
531 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
532 # type or metric.
533 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
534 # or metric.
535 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
536 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
537 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
538 },
539 },
540 ],
541 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
542 # This property is optional.
543 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
544 },
545 ],
546 },
547 &quot;getVersionOperationMetadata&quot;: {
548 &quot;inlineSbomInfo&quot;: {
549 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
550 # appropriate identifiers.
551 &quot;a_key&quot;: &quot;A String&quot;,
552 },
553 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
554 # identifiers.
555 &quot;a_key&quot;: &quot;A String&quot;,
556 },
557 },
558 },
559 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
560 # message that was returned, such as `NOT FOUND`.
561 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
562 # status code that was returned. For example, a `404` means the
563 # resource was not found.
564 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
565 # defined by the server.
566 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
567 # This value is inRFC3339
568 # text format.
569 &quot;instancesBulkInsertOperationMetadata&quot;: {
570 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
571 # Example key: zones/us-central1-a
572 &quot;a_key&quot;: {
573 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
574 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
575 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
576 # error.
577 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
578 # if the flow is rolling forward or rolling back.
579 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
580 },
581 },
582 },
583 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
584 # Operation resources.
585 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
586 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
587 # group of operations results from a `bulkInsert` API request.
588 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
589 # `update`, or `delete`, and so on.
590 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
591 # There is no requirement that this be linear or support any granularity of
592 # operations. This should not be used to guess when the operation will be
593 # complete. This number should monotonically increase as the operation
594 # progresses.
595 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
596 # applicable when performing regional operations.
597 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
598 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
599 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
600 # this field will contain information on all underlying zonal actions and
601 # their state.
602 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
603 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
604 # Example key: zones/us-central1-a
605 &quot;a_key&quot;: {
606 &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
607 # populated.
608 # different programming environments, including REST APIs and RPC APIs. It is
609 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
610 # three pieces of data: error code, error message, and error details.
611 #
612 # You can find out more about this error model and how to work with it in the
613 # [API Design Guide](https://cloud.google.com/apis/design/errors).
614 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
615 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
616 # message types for APIs to use.
617 {
618 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
619 },
620 ],
621 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
622 # user-facing error message should be localized and sent in the
623 # google.rpc.Status.details field, or localized by the client.
624 },
625 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
626 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
627 },
628 },
629 },
630 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
631 # This value is inRFC3339
632 # text format.
633 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
634 # following:
635 # `PENDING`, `RUNNING`, or `DONE`.
636 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
637 # operation.
638 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
639 # of the target resource.
640 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
641 # operations related to creating a snapshot, this points to the disk
642 # that the snapshot was created from.
643 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
644 # `[email protected]` or
645 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
646 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
647 # operation, this field will be populated.
648 {
649 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
650 # Engine returns NO_RESULTS_ON_PAGE if there
651 # are no results in the response.
652 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
653 # value format. For example:
654 #
655 # &quot;data&quot;: [
656 # {
657 # &quot;key&quot;: &quot;scope&quot;,
658 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
659 # }
660 {
661 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
662 # returned. For example, for warnings where there are no results in a list
663 # request for a particular zone, this key might be scope and
664 # the key value might be the zone name. Other examples might be a key
665 # indicating a deprecated resource and a suggested replacement, or a
666 # warning about invalid network settings (for example, if an instance
667 # attempts to perform IP forwarding but is not enabled for IP forwarding).
668 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
669 },
670 ],
671 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
672 },
673 ],
674 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
675 # applicable when performing per-zone operations.
676 }</pre>
677 </div>
678
679 <div class="method">
680 <code class="details" id="get">get(project, region, nodeTemplate, x__xgafv=None)</code>
681 <pre>Returns the specified node template.
682
683 Args:
684 project: string, Project ID for this request. (required)
685 region: string, The name of the region for this request. (required)
686 nodeTemplate: string, Name of the node template to return. (required)
687 x__xgafv: string, V1 error format.
688 Allowed values
689 1 - v1 error format
690 2 - v2 error format
691
692 Returns:
693 An object of the form:
694
695 { # Represent a sole-tenant Node Template resource.
696 #
697 # You can use a template to define properties for nodes in a node group. For
698 # more information, readCreating node groups
699 # and instances.
700 &quot;accelerators&quot;: [
701 { # A specification of the type and number of accelerator cards attached to the
702 # instance.
703 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
704 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
705 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
706 # If you are creating an instance template, specify only the
707 # accelerator name.
708 # See GPUs on Compute Engine
709 # for a full list of accelerator types.
710 },
711 ],
712 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
713 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
714 # text format.
715 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
716 # create the resource.
717 &quot;disks&quot;: [
718 {
719 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
720 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
721 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a
722 # local storage type (e.g.: local-ssd).
723 # Note that for nodeTemplates, this should be the name of the disk type and
724 # not its URL.
725 },
726 ],
727 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
728 # defined by the server.
729 &quot;kind&quot;: &quot;compute#nodeTemplate&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeTemplate for node templates.
730 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
731 # the resource. The resource name must be 1-63 characters long, and comply
732 # withRFC1035.
733 # Specifically, the name must be 1-63 characters long and match the regular
734 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
735 # character must be a lowercase letter, and all following characters must be
736 # a dash, lowercase letter, or digit, except the last character, which
737 # cannot be a dash.
738 &quot;nodeAffinityLabels&quot;: { # Labels to use for node affinity, which will be used in instance scheduling.
739 &quot;a_key&quot;: &quot;A String&quot;,
740 },
741 &quot;nodeType&quot;: &quot;A String&quot;, # The node type to use for nodes group that are created from this template.
742 &quot;nodeTypeFlexibility&quot;: { # Do not use. Instead, use the node_type property.
743 &quot;cpus&quot;: &quot;A String&quot;,
744 &quot;localSsd&quot;: &quot;A String&quot;,
745 &quot;memory&quot;: &quot;A String&quot;,
746 },
747 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the region where the node template resides,
748 # such as us-central1.
749 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
750 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
751 &quot;serverBinding&quot;: { # Sets the binding properties for the physical server. Valid values include:
752 #
753 # - *[Default]* RESTART_NODE_ON_ANY_SERVER:
754 # Restarts VMs on any available
755 # physical server
756 # - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same
757 # physical server whenever possible
758 #
759 #
760 #
761 # See Sole-tenant
762 # node options for more information.
763 &quot;type&quot;: &quot;A String&quot;,
764 },
765 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the node template. One of the following values:CREATING, READY, and DELETING.
766 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
767 }</pre>
768 </div>
769
770 <div class="method">
771 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
772 <pre>Gets the access control policy for a resource. May be empty if no such
773 policy or resource exists.
774
775 Args:
776 project: string, Project ID for this request. (required)
777 region: string, The name of the region for this request. (required)
778 resource: string, Name or id of the resource for this request. (required)
779 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
780 x__xgafv: string, V1 error format.
781 Allowed values
782 1 - v1 error format
783 2 - v2 error format
784
785 Returns:
786 An object of the form:
787
788 { # An Identity and Access Management (IAM) policy, which specifies access
789 # controls for Google Cloud resources.
790 #
791 #
792 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
793 # `members`, or principals, to a single `role`. Principals can be user
794 # accounts, service accounts, Google groups, and domains (such as G Suite). A
795 # `role` is a named list of permissions; each `role` can be an IAM predefined
796 # role or a user-created custom role.
797 #
798 # For some types of Google Cloud resources, a `binding` can also specify a
799 # `condition`, which is a logical expression that allows access to a resource
800 # only if the expression evaluates to `true`. A condition can add constraints
801 # based on attributes of the request, the resource, or both. To learn which
802 # resources support conditions in their IAM policies, see the
803 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
804 #
805 # **JSON example:**
806 #
807 # ```
808 # {
809 # &quot;bindings&quot;: [
810 # {
811 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
812 # &quot;members&quot;: [
813 # &quot;user:[email protected]&quot;,
814 # &quot;group:[email protected]&quot;,
815 # &quot;domain:google.com&quot;,
816 # &quot;serviceAccount:[email protected]&quot;
817 # ]
818 # },
819 # {
820 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
821 # &quot;members&quot;: [
822 # &quot;user:[email protected]&quot;
823 # ],
824 # &quot;condition&quot;: {
825 # &quot;title&quot;: &quot;expirable access&quot;,
826 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
827 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
828 # }
829 # }
830 # ],
831 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
832 # &quot;version&quot;: 3
833 # }
834 # ```
835 #
836 # **YAML example:**
837 #
838 # ```
839 # bindings:
840 # - members:
841 # - user:[email protected]
842 # - group:[email protected]
843 # - domain:google.com
844 # - serviceAccount:[email protected]
845 # role: roles/resourcemanager.organizationAdmin
846 # - members:
847 # - user:[email protected]
848 # role: roles/resourcemanager.organizationViewer
849 # condition:
850 # title: expirable access
851 # description: Does not grant access after Sep 2020
852 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
853 # etag: BwWWja0YfJA=
854 # version: 3
855 # ```
856 #
857 # For a description of IAM and its features, see the
858 # [IAM documentation](https://cloud.google.com/iam/docs/).
859 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
860 { # Specifies the audit configuration for a service.
861 # The configuration determines which permission types are logged, and what
862 # identities, if any, are exempted from logging.
863 # An AuditConfig must have one or more AuditLogConfigs.
864 #
865 # If there are AuditConfigs for both `allServices` and a specific service,
866 # the union of the two AuditConfigs is used for that service: the log_types
867 # specified in each AuditConfig are enabled, and the exempted_members in each
868 # AuditLogConfig are exempted.
869 #
870 # Example Policy with multiple AuditConfigs:
871 #
872 # {
873 # &quot;audit_configs&quot;: [
874 # {
875 # &quot;service&quot;: &quot;allServices&quot;,
876 # &quot;audit_log_configs&quot;: [
877 # {
878 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
879 # &quot;exempted_members&quot;: [
880 # &quot;user:[email protected]&quot;
881 # ]
882 # },
883 # {
884 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
885 # },
886 # {
887 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
888 # }
889 # ]
890 # },
891 # {
892 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
893 # &quot;audit_log_configs&quot;: [
894 # {
895 # &quot;log_type&quot;: &quot;DATA_READ&quot;
896 # },
897 # {
898 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
899 # &quot;exempted_members&quot;: [
900 # &quot;user:[email protected]&quot;
901 # ]
902 # }
903 # ]
904 # }
905 # ]
906 # }
907 #
908 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
909 # logging. It also exempts `[email protected]` from DATA_READ logging, and
910 # `[email protected]` from DATA_WRITE logging.
911 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
912 { # Provides the configuration for logging a type of permissions.
913 # Example:
914 #
915 # {
916 # &quot;audit_log_configs&quot;: [
917 # {
918 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
919 # &quot;exempted_members&quot;: [
920 # &quot;user:[email protected]&quot;
921 # ]
922 # },
923 # {
924 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
925 # }
926 # ]
927 # }
928 #
929 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
930 # [email protected] from DATA_READ logging.
931 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
932 # permission.
933 # Follows the same format of Binding.members.
934 &quot;A String&quot;,
935 ],
936 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
937 },
938 ],
939 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
940 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
941 # `allServices` is a special value that covers all services.
942 },
943 ],
944 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
945 # may specify a `condition` that determines how and when the `bindings` are
946 # applied. Each of the `bindings` must contain at least one principal.
947 #
948 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
949 # of these principals can be Google groups. Each occurrence of a principal
950 # counts towards these limits. For example, if the `bindings` grant 50
951 # different roles to `user:[email protected]`, and not to any other
952 # principal, then you can add another 1,450 principals to the `bindings` in
953 # the `Policy`.
954 { # Associates `members`, or principals, with a `role`.
955 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
956 #
957 # If the condition evaluates to `true`, then this binding applies to the
958 # current request.
959 #
960 # If the condition evaluates to `false`, then this binding does not apply to
961 # the current request. However, a different role binding might grant the same
962 # role to one or more of the principals in this binding.
963 #
964 # To learn which resources support conditions in their IAM policies, see the
965 # [IAM
966 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
967 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
968 # are documented at https://github.com/google/cel-spec.
969 #
970 # Example (Comparison):
971 #
972 # title: &quot;Summary size limit&quot;
973 # description: &quot;Determines if a summary is less than 100 chars&quot;
974 # expression: &quot;document.summary.size() &lt; 100&quot;
975 #
976 # Example (Equality):
977 #
978 # title: &quot;Requestor is owner&quot;
979 # description: &quot;Determines if requestor is the document owner&quot;
980 # expression: &quot;document.owner == request.auth.claims.email&quot;
981 #
982 # Example (Logic):
983 #
984 # title: &quot;Public documents&quot;
985 # description: &quot;Determine whether the document should be publicly visible&quot;
986 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
987 #
988 # Example (Data Manipulation):
989 #
990 # title: &quot;Notification string&quot;
991 # description: &quot;Create a notification string with a timestamp.&quot;
992 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
993 #
994 # The exact variables and functions that may be referenced within an expression
995 # are determined by the service that evaluates it. See the service
996 # documentation for additional information.
997 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
998 # describes the expression, e.g. when hovered over it in a UI.
999 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1000 # syntax.
1001 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1002 # reporting, e.g. a file name and a position in the file.
1003 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1004 # its purpose. This can be used e.g. in UIs which allow to enter the
1005 # expression.
1006 },
1007 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1008 # `members` can have the following values:
1009 #
1010 # * `allUsers`: A special identifier that represents anyone who is
1011 # on the internet; with or without a Google account.
1012 #
1013 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1014 # who is authenticated with a Google account or a service account.
1015 # Does not include identities that come from external identity providers
1016 # (IdPs) through identity federation.
1017 #
1018 # * `user:{emailid}`: An email address that represents a specific Google
1019 # account. For example, `[email protected]` .
1020 #
1021 #
1022 # * `serviceAccount:{emailid}`: An email address that represents a Google
1023 # service account. For example,
1024 # `[email protected]`.
1025 #
1026 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1027 # identifier for a
1028 # [Kubernetes service
1029 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1030 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1031 #
1032 # * `group:{emailid}`: An email address that represents a Google group.
1033 # For example, `[email protected]`.
1034 #
1035 #
1036 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1037 # users of that domain. For example, `google.com` or `example.com`.
1038 #
1039 #
1040 #
1041 #
1042 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1043 # A single identity in a workforce identity pool.
1044 #
1045 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1046 # All workforce identities in a group.
1047 #
1048 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1049 # All workforce identities with a specific attribute value.
1050 #
1051 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1052 # All identities in a workforce identity pool.
1053 #
1054 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1055 # A single identity in a workload identity pool.
1056 #
1057 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1058 # A workload identity pool group.
1059 #
1060 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1061 # All identities in a workload identity pool with a certain attribute.
1062 #
1063 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1064 # All identities in a workload identity pool.
1065 #
1066 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1067 # identifier) representing a user that has been recently deleted. For
1068 # example, `[email protected]?uid=123456789012345678901`. If the user is
1069 # recovered, this value reverts to `user:{emailid}` and the recovered user
1070 # retains the role in the binding.
1071 #
1072 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1073 # unique identifier) representing a service account that has been recently
1074 # deleted. For example,
1075 # `[email protected]?uid=123456789012345678901`.
1076 # If the service account is undeleted, this value reverts to
1077 # `serviceAccount:{emailid}` and the undeleted service account retains the
1078 # role in the binding.
1079 #
1080 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1081 # identifier) representing a Google group that has been recently
1082 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1083 # the group is recovered, this value reverts to `group:{emailid}` and the
1084 # recovered group retains the role in the binding.
1085 #
1086 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1087 # Deleted single identity in a workforce identity pool. For example,
1088 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1089 &quot;A String&quot;,
1090 ],
1091 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1092 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1093 #
1094 # For an overview of the IAM roles and permissions, see the
1095 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1096 # a list of the available pre-defined roles, see
1097 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1098 },
1099 ],
1100 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1101 # prevent simultaneous updates of a policy from overwriting each other.
1102 # It is strongly suggested that systems make use of the `etag` in the
1103 # read-modify-write cycle to perform policy updates in order to avoid race
1104 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1105 # systems are expected to put that etag in the request to `setIamPolicy` to
1106 # ensure that their change will be applied to the same version of the policy.
1107 #
1108 # **Important:** If you use IAM Conditions, you must include the `etag` field
1109 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1110 # you to overwrite a version `3` policy with a version `1` policy, and all of
1111 # the conditions in the version `3` policy are lost.
1112 &quot;version&quot;: 42, # Specifies the format of the policy.
1113 #
1114 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1115 # are rejected.
1116 #
1117 # Any operation that affects conditional role bindings must specify version
1118 # `3`. This requirement applies to the following operations:
1119 #
1120 # * Getting a policy that includes a conditional role binding
1121 # * Adding a conditional role binding to a policy
1122 # * Changing a conditional role binding in a policy
1123 # * Removing any role binding, with or without a condition, from a policy
1124 # that includes conditions
1125 #
1126 # **Important:** If you use IAM Conditions, you must include the `etag` field
1127 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1128 # you to overwrite a version `3` policy with a version `1` policy, and all of
1129 # the conditions in the version `3` policy are lost.
1130 #
1131 # If a policy does not include any conditions, operations on that policy may
1132 # specify any valid version or leave the field unset.
1133 #
1134 # To learn which resources support conditions in their IAM policies, see the
1135 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1136 }</pre>
1137 </div>
1138
1139 <div class="method">
1140 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1141 <pre>Creates a NodeTemplate resource in the specified project using the data
1142 included in the request.
1143
1144 Args:
1145 project: string, Project ID for this request. (required)
1146 region: string, The name of the region for this request. (required)
1147 body: object, The request body.
1148 The object takes the form of:
1149
1150 { # Represent a sole-tenant Node Template resource.
1151 #
1152 # You can use a template to define properties for nodes in a node group. For
1153 # more information, readCreating node groups
1154 # and instances.
1155 &quot;accelerators&quot;: [
1156 { # A specification of the type and number of accelerator cards attached to the
1157 # instance.
1158 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1159 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1160 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1161 # If you are creating an instance template, specify only the
1162 # accelerator name.
1163 # See GPUs on Compute Engine
1164 # for a full list of accelerator types.
1165 },
1166 ],
1167 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
1168 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1169 # text format.
1170 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1171 # create the resource.
1172 &quot;disks&quot;: [
1173 {
1174 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
1175 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
1176 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a
1177 # local storage type (e.g.: local-ssd).
1178 # Note that for nodeTemplates, this should be the name of the disk type and
1179 # not its URL.
1180 },
1181 ],
1182 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1183 # defined by the server.
1184 &quot;kind&quot;: &quot;compute#nodeTemplate&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeTemplate for node templates.
1185 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1186 # the resource. The resource name must be 1-63 characters long, and comply
1187 # withRFC1035.
1188 # Specifically, the name must be 1-63 characters long and match the regular
1189 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1190 # character must be a lowercase letter, and all following characters must be
1191 # a dash, lowercase letter, or digit, except the last character, which
1192 # cannot be a dash.
1193 &quot;nodeAffinityLabels&quot;: { # Labels to use for node affinity, which will be used in instance scheduling.
1194 &quot;a_key&quot;: &quot;A String&quot;,
1195 },
1196 &quot;nodeType&quot;: &quot;A String&quot;, # The node type to use for nodes group that are created from this template.
1197 &quot;nodeTypeFlexibility&quot;: { # Do not use. Instead, use the node_type property.
1198 &quot;cpus&quot;: &quot;A String&quot;,
1199 &quot;localSsd&quot;: &quot;A String&quot;,
1200 &quot;memory&quot;: &quot;A String&quot;,
1201 },
1202 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the region where the node template resides,
1203 # such as us-central1.
1204 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1205 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1206 &quot;serverBinding&quot;: { # Sets the binding properties for the physical server. Valid values include:
1207 #
1208 # - *[Default]* RESTART_NODE_ON_ANY_SERVER:
1209 # Restarts VMs on any available
1210 # physical server
1211 # - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same
1212 # physical server whenever possible
1213 #
1214 #
1215 #
1216 # See Sole-tenant
1217 # node options for more information.
1218 &quot;type&quot;: &quot;A String&quot;,
1219 },
1220 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the node template. One of the following values:CREATING, READY, and DELETING.
1221 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
1222 }
1223
1224 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1225 that if you must retry your request, the server will know to ignore the
1226 request if it has already been completed.
1227
1228 For example, consider a situation where you make an initial request and
1229 the request times out. If you make the request again with the same
1230 request ID, the server can check if original operation with the same
1231 request ID was received, and if so, will ignore the second request. This
1232 prevents clients from accidentally creating duplicate commitments.
1233
1234 The request ID must be
1235 a valid UUID with the exception that zero UUID is not supported
1236 (00000000-0000-0000-0000-000000000000).
1237 x__xgafv: string, V1 error format.
1238 Allowed values
1239 1 - v1 error format
1240 2 - v2 error format
1241
1242 Returns:
1243 An object of the form:
1244
1245 { # Represents an Operation resource.
1246 #
1247 # Google Compute Engine has three Operation resources:
1248 #
1249 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1250 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1251 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1252 #
1253 # You can use an operation resource to manage asynchronous API requests.
1254 # For more information, readHandling
1255 # API responses.
1256 #
1257 # Operations can be global, regional or zonal.
1258 #
1259 # - For global operations, use the `globalOperations`
1260 # resource.
1261 # - For regional operations, use the
1262 # `regionOperations` resource.
1263 # - For zonal operations, use
1264 # the `zoneOperations` resource.
1265 #
1266 #
1267 #
1268 # For more information, read
1269 # Global, Regional, and Zonal Resources.
1270 #
1271 # Note that completed Operation resources have a limited
1272 # retention period.
1273 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1274 # Not present otherwise.
1275 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1276 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1277 # set when the operation is created.
1278 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1279 # text format.
1280 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1281 # this field will be populated.
1282 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1283 # operation.
1284 {
1285 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1286 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1287 # details. There is a set of defined message types to use for providing
1288 # details.The syntax depends on the error code. For example,
1289 # QuotaExceededInfo will have details when the error code is
1290 # QUOTA_EXCEEDED.
1291 {
1292 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1293 #
1294 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1295 # is not enabled:
1296 #
1297 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1298 # &quot;domain&quot;: &quot;googleapis.com&quot;
1299 # &quot;metadata&quot;: {
1300 # &quot;resource&quot;: &quot;projects/123&quot;,
1301 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1302 # }
1303 # }
1304 #
1305 # This response indicates that the pubsub.googleapis.com API is not enabled.
1306 #
1307 # Example of an error that is returned when attempting to create a Spanner
1308 # instance in a region that is out of stock:
1309 #
1310 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1311 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1312 # &quot;metadata&quot;: {
1313 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1314 # }
1315 # }
1316 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1317 # is typically the registered service name of the tool or product that
1318 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1319 # generated by some common infrastructure, the error domain must be a
1320 # globally unique value that identifies the infrastructure. For Google API
1321 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1322 &quot;metadatas&quot;: { # Additional structured details about this error.
1323 #
1324 # Keys must match a regular expression of `a-z+` but should
1325 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1326 # length. When identifying the current value of an exceeded limit, the units
1327 # should be contained in the key, not the value. For example, rather than
1328 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1329 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1330 # instances that can be created in a single (batch) request.
1331 &quot;a_key&quot;: &quot;A String&quot;,
1332 },
1333 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1334 # proximate cause of the error. Error reasons are unique within a particular
1335 # domain of errors. This should be at most 63 characters and match a
1336 # regular expression of `A-Z+[A-Z0-9]`, which represents
1337 # UPPER_SNAKE_CASE.
1338 },
1339 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1340 #
1341 # For example, if a quota check failed with an error indicating the calling
1342 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1343 # directly to the right place in the developer console to flip the bit.
1344 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1345 { # Describes a URL link.
1346 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1347 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1348 },
1349 ],
1350 },
1351 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1352 # which can be attached to an RPC error.
1353 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1354 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1355 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1356 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1357 },
1358 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1359 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1360 &quot;a_key&quot;: &quot;A String&quot;,
1361 },
1362 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1363 # type or metric.
1364 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1365 # or metric.
1366 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1367 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1368 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1369 },
1370 },
1371 ],
1372 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1373 # This property is optional.
1374 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1375 },
1376 ],
1377 },
1378 &quot;getVersionOperationMetadata&quot;: {
1379 &quot;inlineSbomInfo&quot;: {
1380 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1381 # appropriate identifiers.
1382 &quot;a_key&quot;: &quot;A String&quot;,
1383 },
1384 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1385 # identifiers.
1386 &quot;a_key&quot;: &quot;A String&quot;,
1387 },
1388 },
1389 },
1390 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1391 # message that was returned, such as `NOT FOUND`.
1392 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1393 # status code that was returned. For example, a `404` means the
1394 # resource was not found.
1395 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1396 # defined by the server.
1397 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1398 # This value is inRFC3339
1399 # text format.
1400 &quot;instancesBulkInsertOperationMetadata&quot;: {
1401 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1402 # Example key: zones/us-central1-a
1403 &quot;a_key&quot;: {
1404 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1405 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1406 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1407 # error.
1408 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1409 # if the flow is rolling forward or rolling back.
1410 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1411 },
1412 },
1413 },
1414 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1415 # Operation resources.
1416 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1417 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1418 # group of operations results from a `bulkInsert` API request.
1419 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1420 # `update`, or `delete`, and so on.
1421 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1422 # There is no requirement that this be linear or support any granularity of
1423 # operations. This should not be used to guess when the operation will be
1424 # complete. This number should monotonically increase as the operation
1425 # progresses.
1426 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1427 # applicable when performing regional operations.
1428 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1429 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1430 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1431 # this field will contain information on all underlying zonal actions and
1432 # their state.
1433 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1434 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1435 # Example key: zones/us-central1-a
1436 &quot;a_key&quot;: {
1437 &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
1438 # populated.
1439 # different programming environments, including REST APIs and RPC APIs. It is
1440 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1441 # three pieces of data: error code, error message, and error details.
1442 #
1443 # You can find out more about this error model and how to work with it in the
1444 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1445 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1446 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1447 # message types for APIs to use.
1448 {
1449 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1450 },
1451 ],
1452 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1453 # user-facing error message should be localized and sent in the
1454 # google.rpc.Status.details field, or localized by the client.
1455 },
1456 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1457 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1458 },
1459 },
1460 },
1461 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1462 # This value is inRFC3339
1463 # text format.
1464 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1465 # following:
1466 # `PENDING`, `RUNNING`, or `DONE`.
1467 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1468 # operation.
1469 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1470 # of the target resource.
1471 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1472 # operations related to creating a snapshot, this points to the disk
1473 # that the snapshot was created from.
1474 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1475 # `[email protected]` or
1476 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1477 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1478 # operation, this field will be populated.
1479 {
1480 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1481 # Engine returns NO_RESULTS_ON_PAGE if there
1482 # are no results in the response.
1483 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1484 # value format. For example:
1485 #
1486 # &quot;data&quot;: [
1487 # {
1488 # &quot;key&quot;: &quot;scope&quot;,
1489 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1490 # }
1491 {
1492 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1493 # returned. For example, for warnings where there are no results in a list
1494 # request for a particular zone, this key might be scope and
1495 # the key value might be the zone name. Other examples might be a key
1496 # indicating a deprecated resource and a suggested replacement, or a
1497 # warning about invalid network settings (for example, if an instance
1498 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1499 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1500 },
1501 ],
1502 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1503 },
1504 ],
1505 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1506 # applicable when performing per-zone operations.
1507 }</pre>
1508 </div>
1509
1510 <div class="method">
1511 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1512 <pre>Retrieves a list of node templates available to the specified
1513 project.
1514
1515 Args:
1516 project: string, Project ID for this request. (required)
1517 region: string, The name of the region for this request. (required)
1518 filter: string, A filter expression that filters resources listed in the response. Most
1519 Compute resources support two types of filter expressions:
1520 expressions that support regular expressions and expressions that follow
1521 API improvement proposal AIP-160.
1522 These two types of filter expressions cannot be mixed in one request.
1523
1524 If you want to use AIP-160, your expression must specify the field name, an
1525 operator, and the value that you want to use for filtering. The value
1526 must be a string, a number, or a boolean. The operator
1527 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1528
1529 For example, if you are filtering Compute Engine instances, you can
1530 exclude instances named `example-instance` by specifying
1531 `name != example-instance`.
1532
1533 The `:*` comparison can be used to test whether a key has been defined.
1534 For example, to find all objects with `owner` label use:
1535 ```
1536 labels.owner:*
1537 ```
1538
1539 You can also filter nested fields. For example, you could specify
1540 `scheduling.automaticRestart = false` to include instances only
1541 if they are not scheduled for automatic restarts. You can use filtering
1542 on nested fields to filter based onresource labels.
1543
1544 To filter on multiple expressions, provide each separate expression within
1545 parentheses. For example:
1546 ```
1547 (scheduling.automaticRestart = true)
1548 (cpuPlatform = &quot;Intel Skylake&quot;)
1549 ```
1550 By default, each expression is an `AND` expression. However, you
1551 can include `AND` and `OR` expressions explicitly.
1552 For example:
1553 ```
1554 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1555 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1556 (scheduling.automaticRestart = true)
1557 ```
1558
1559 If you want to use a regular expression, use the `eq` (equal) or `ne`
1560 (not equal) operator against a single un-parenthesized expression with or
1561 without quotes or against multiple parenthesized expressions. Examples:
1562
1563 `fieldname eq unquoted literal`
1564 `fieldname eq &#x27;single quoted literal&#x27;`
1565 `fieldname eq &quot;double quoted literal&quot;`
1566 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1567
1568 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1569 The literal value must match the entire field.
1570
1571 For example, to filter for instances that do not end with name &quot;instance&quot;,
1572 you would use `name ne .*instance`.
1573
1574 You cannot combine constraints on multiple fields using regular
1575 expressions.
1576 maxResults: integer, The maximum number of results per page that should be returned.
1577 If the number of available results is larger than `maxResults`,
1578 Compute Engine returns a `nextPageToken` that can be used to get
1579 the next page of results in subsequent list requests. Acceptable values are
1580 `0` to `500`, inclusive. (Default: `500`)
1581 orderBy: string, Sorts list results by a certain order. By default, results
1582 are returned in alphanumerical order based on the resource name.
1583
1584 You can also sort results in descending order based on the creation
1585 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1586 results based on the `creationTimestamp` field in
1587 reverse chronological order (newest result first). Use this to sort
1588 resources like operations so that the newest operation is returned first.
1589
1590 Currently, only sorting by `name` or
1591 `creationTimestamp desc` is supported.
1592 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1593 `nextPageToken` returned by a previous list request to get
1594 the next page of results.
1595 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1596 of failure. The default value is false.
1597
1598 For example, when partial success behavior is enabled, aggregatedList for a
1599 single zone scope either returns all resources in the zone or no resources,
1600 with an error code.
1601 x__xgafv: string, V1 error format.
1602 Allowed values
1603 1 - v1 error format
1604 2 - v2 error format
1605
1606 Returns:
1607 An object of the form:
1608
1609 { # Contains a list of node templates.
1610 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1611 &quot;items&quot;: [ # A list of NodeTemplate resources.
1612 { # Represent a sole-tenant Node Template resource.
1613 #
1614 # You can use a template to define properties for nodes in a node group. For
1615 # more information, readCreating node groups
1616 # and instances.
1617 &quot;accelerators&quot;: [
1618 { # A specification of the type and number of accelerator cards attached to the
1619 # instance.
1620 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1621 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1622 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1623 # If you are creating an instance template, specify only the
1624 # accelerator name.
1625 # See GPUs on Compute Engine
1626 # for a full list of accelerator types.
1627 },
1628 ],
1629 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
1630 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1631 # text format.
1632 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1633 # create the resource.
1634 &quot;disks&quot;: [
1635 {
1636 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
1637 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
1638 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a
1639 # local storage type (e.g.: local-ssd).
1640 # Note that for nodeTemplates, this should be the name of the disk type and
1641 # not its URL.
1642 },
1643 ],
1644 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1645 # defined by the server.
1646 &quot;kind&quot;: &quot;compute#nodeTemplate&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#nodeTemplate for node templates.
1647 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1648 # the resource. The resource name must be 1-63 characters long, and comply
1649 # withRFC1035.
1650 # Specifically, the name must be 1-63 characters long and match the regular
1651 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1652 # character must be a lowercase letter, and all following characters must be
1653 # a dash, lowercase letter, or digit, except the last character, which
1654 # cannot be a dash.
1655 &quot;nodeAffinityLabels&quot;: { # Labels to use for node affinity, which will be used in instance scheduling.
1656 &quot;a_key&quot;: &quot;A String&quot;,
1657 },
1658 &quot;nodeType&quot;: &quot;A String&quot;, # The node type to use for nodes group that are created from this template.
1659 &quot;nodeTypeFlexibility&quot;: { # Do not use. Instead, use the node_type property.
1660 &quot;cpus&quot;: &quot;A String&quot;,
1661 &quot;localSsd&quot;: &quot;A String&quot;,
1662 &quot;memory&quot;: &quot;A String&quot;,
1663 },
1664 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the region where the node template resides,
1665 # such as us-central1.
1666 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1667 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1668 &quot;serverBinding&quot;: { # Sets the binding properties for the physical server. Valid values include:
1669 #
1670 # - *[Default]* RESTART_NODE_ON_ANY_SERVER:
1671 # Restarts VMs on any available
1672 # physical server
1673 # - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same
1674 # physical server whenever possible
1675 #
1676 #
1677 #
1678 # See Sole-tenant
1679 # node options for more information.
1680 &quot;type&quot;: &quot;A String&quot;,
1681 },
1682 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the node template. One of the following values:CREATING, READY, and DELETING.
1683 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
1684 },
1685 ],
1686 &quot;kind&quot;: &quot;compute#nodeTemplateList&quot;, # Output only. [Output Only] Type of resource.Always compute#nodeTemplateList
1687 # for lists of node templates.
1688 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1689 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1690 # the query parameter pageToken in the next list request.
1691 # Subsequent list requests will have their own nextPageToken to
1692 # continue paging through the results.
1693 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1694 &quot;warning&quot;: { # [Output Only] Informational warning message.
1695 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1696 # Engine returns NO_RESULTS_ON_PAGE if there
1697 # are no results in the response.
1698 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1699 # value format. For example:
1700 #
1701 # &quot;data&quot;: [
1702 # {
1703 # &quot;key&quot;: &quot;scope&quot;,
1704 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1705 # }
1706 {
1707 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1708 # returned. For example, for warnings where there are no results in a list
1709 # request for a particular zone, this key might be scope and
1710 # the key value might be the zone name. Other examples might be a key
1711 # indicating a deprecated resource and a suggested replacement, or a
1712 # warning about invalid network settings (for example, if an instance
1713 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1714 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1715 },
1716 ],
1717 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1718 },
1719 }</pre>
1720 </div>
1721
1722 <div class="method">
1723 <code class="details" id="list_next">list_next()</code>
1724 <pre>Retrieves the next page of results.
1725
1726 Args:
1727 previous_request: The request for the previous page. (required)
1728 previous_response: The response from the request for the previous page. (required)
1729
1730 Returns:
1731 A request object that you can call &#x27;execute()&#x27; on to request the next
1732 page. Returns None if there are no more items in the collection.
1733 </pre>
1734 </div>
1735
1736 <div class="method">
1737 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
1738 <pre>Sets the access control policy on the specified resource.
1739 Replaces any existing policy.
1740
1741 Args:
1742 project: string, Project ID for this request. (required)
1743 region: string, The name of the region for this request. (required)
1744 resource: string, Name or id of the resource for this request. (required)
1745 body: object, The request body.
1746 The object takes the form of:
1747
1748 {
1749 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
1750 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
1751 { # Associates `members`, or principals, with a `role`.
1752 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1753 #
1754 # If the condition evaluates to `true`, then this binding applies to the
1755 # current request.
1756 #
1757 # If the condition evaluates to `false`, then this binding does not apply to
1758 # the current request. However, a different role binding might grant the same
1759 # role to one or more of the principals in this binding.
1760 #
1761 # To learn which resources support conditions in their IAM policies, see the
1762 # [IAM
1763 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1764 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1765 # are documented at https://github.com/google/cel-spec.
1766 #
1767 # Example (Comparison):
1768 #
1769 # title: &quot;Summary size limit&quot;
1770 # description: &quot;Determines if a summary is less than 100 chars&quot;
1771 # expression: &quot;document.summary.size() &lt; 100&quot;
1772 #
1773 # Example (Equality):
1774 #
1775 # title: &quot;Requestor is owner&quot;
1776 # description: &quot;Determines if requestor is the document owner&quot;
1777 # expression: &quot;document.owner == request.auth.claims.email&quot;
1778 #
1779 # Example (Logic):
1780 #
1781 # title: &quot;Public documents&quot;
1782 # description: &quot;Determine whether the document should be publicly visible&quot;
1783 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1784 #
1785 # Example (Data Manipulation):
1786 #
1787 # title: &quot;Notification string&quot;
1788 # description: &quot;Create a notification string with a timestamp.&quot;
1789 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1790 #
1791 # The exact variables and functions that may be referenced within an expression
1792 # are determined by the service that evaluates it. See the service
1793 # documentation for additional information.
1794 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1795 # describes the expression, e.g. when hovered over it in a UI.
1796 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1797 # syntax.
1798 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1799 # reporting, e.g. a file name and a position in the file.
1800 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1801 # its purpose. This can be used e.g. in UIs which allow to enter the
1802 # expression.
1803 },
1804 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1805 # `members` can have the following values:
1806 #
1807 # * `allUsers`: A special identifier that represents anyone who is
1808 # on the internet; with or without a Google account.
1809 #
1810 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1811 # who is authenticated with a Google account or a service account.
1812 # Does not include identities that come from external identity providers
1813 # (IdPs) through identity federation.
1814 #
1815 # * `user:{emailid}`: An email address that represents a specific Google
1816 # account. For example, `[email protected]` .
1817 #
1818 #
1819 # * `serviceAccount:{emailid}`: An email address that represents a Google
1820 # service account. For example,
1821 # `[email protected]`.
1822 #
1823 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1824 # identifier for a
1825 # [Kubernetes service
1826 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1827 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1828 #
1829 # * `group:{emailid}`: An email address that represents a Google group.
1830 # For example, `[email protected]`.
1831 #
1832 #
1833 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1834 # users of that domain. For example, `google.com` or `example.com`.
1835 #
1836 #
1837 #
1838 #
1839 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1840 # A single identity in a workforce identity pool.
1841 #
1842 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1843 # All workforce identities in a group.
1844 #
1845 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1846 # All workforce identities with a specific attribute value.
1847 #
1848 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1849 # All identities in a workforce identity pool.
1850 #
1851 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1852 # A single identity in a workload identity pool.
1853 #
1854 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1855 # A workload identity pool group.
1856 #
1857 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1858 # All identities in a workload identity pool with a certain attribute.
1859 #
1860 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1861 # All identities in a workload identity pool.
1862 #
1863 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1864 # identifier) representing a user that has been recently deleted. For
1865 # example, `[email protected]?uid=123456789012345678901`. If the user is
1866 # recovered, this value reverts to `user:{emailid}` and the recovered user
1867 # retains the role in the binding.
1868 #
1869 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1870 # unique identifier) representing a service account that has been recently
1871 # deleted. For example,
1872 # `[email protected]?uid=123456789012345678901`.
1873 # If the service account is undeleted, this value reverts to
1874 # `serviceAccount:{emailid}` and the undeleted service account retains the
1875 # role in the binding.
1876 #
1877 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1878 # identifier) representing a Google group that has been recently
1879 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1880 # the group is recovered, this value reverts to `group:{emailid}` and the
1881 # recovered group retains the role in the binding.
1882 #
1883 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1884 # Deleted single identity in a workforce identity pool. For example,
1885 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1886 &quot;A String&quot;,
1887 ],
1888 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1889 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1890 #
1891 # For an overview of the IAM roles and permissions, see the
1892 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1893 # a list of the available pre-defined roles, see
1894 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1895 },
1896 ],
1897 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
1898 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
1899 &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
1900 # the policy is limited to a few 10s of KB. An empty policy is in general a
1901 # valid policy but certain services (like Projects) might reject them.
1902 # controls for Google Cloud resources.
1903 #
1904 #
1905 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1906 # `members`, or principals, to a single `role`. Principals can be user
1907 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1908 # `role` is a named list of permissions; each `role` can be an IAM predefined
1909 # role or a user-created custom role.
1910 #
1911 # For some types of Google Cloud resources, a `binding` can also specify a
1912 # `condition`, which is a logical expression that allows access to a resource
1913 # only if the expression evaluates to `true`. A condition can add constraints
1914 # based on attributes of the request, the resource, or both. To learn which
1915 # resources support conditions in their IAM policies, see the
1916 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1917 #
1918 # **JSON example:**
1919 #
1920 # ```
1921 # {
1922 # &quot;bindings&quot;: [
1923 # {
1924 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1925 # &quot;members&quot;: [
1926 # &quot;user:[email protected]&quot;,
1927 # &quot;group:[email protected]&quot;,
1928 # &quot;domain:google.com&quot;,
1929 # &quot;serviceAccount:[email protected]&quot;
1930 # ]
1931 # },
1932 # {
1933 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1934 # &quot;members&quot;: [
1935 # &quot;user:[email protected]&quot;
1936 # ],
1937 # &quot;condition&quot;: {
1938 # &quot;title&quot;: &quot;expirable access&quot;,
1939 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1940 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1941 # }
1942 # }
1943 # ],
1944 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1945 # &quot;version&quot;: 3
1946 # }
1947 # ```
1948 #
1949 # **YAML example:**
1950 #
1951 # ```
1952 # bindings:
1953 # - members:
1954 # - user:[email protected]
1955 # - group:[email protected]
1956 # - domain:google.com
1957 # - serviceAccount:[email protected]
1958 # role: roles/resourcemanager.organizationAdmin
1959 # - members:
1960 # - user:[email protected]
1961 # role: roles/resourcemanager.organizationViewer
1962 # condition:
1963 # title: expirable access
1964 # description: Does not grant access after Sep 2020
1965 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1966 # etag: BwWWja0YfJA=
1967 # version: 3
1968 # ```
1969 #
1970 # For a description of IAM and its features, see the
1971 # [IAM documentation](https://cloud.google.com/iam/docs/).
1972 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1973 { # Specifies the audit configuration for a service.
1974 # The configuration determines which permission types are logged, and what
1975 # identities, if any, are exempted from logging.
1976 # An AuditConfig must have one or more AuditLogConfigs.
1977 #
1978 # If there are AuditConfigs for both `allServices` and a specific service,
1979 # the union of the two AuditConfigs is used for that service: the log_types
1980 # specified in each AuditConfig are enabled, and the exempted_members in each
1981 # AuditLogConfig are exempted.
1982 #
1983 # Example Policy with multiple AuditConfigs:
1984 #
1985 # {
1986 # &quot;audit_configs&quot;: [
1987 # {
1988 # &quot;service&quot;: &quot;allServices&quot;,
1989 # &quot;audit_log_configs&quot;: [
1990 # {
1991 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1992 # &quot;exempted_members&quot;: [
1993 # &quot;user:[email protected]&quot;
1994 # ]
1995 # },
1996 # {
1997 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1998 # },
1999 # {
2000 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2001 # }
2002 # ]
2003 # },
2004 # {
2005 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2006 # &quot;audit_log_configs&quot;: [
2007 # {
2008 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2009 # },
2010 # {
2011 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2012 # &quot;exempted_members&quot;: [
2013 # &quot;user:[email protected]&quot;
2014 # ]
2015 # }
2016 # ]
2017 # }
2018 # ]
2019 # }
2020 #
2021 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2022 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2023 # `[email protected]` from DATA_WRITE logging.
2024 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2025 { # Provides the configuration for logging a type of permissions.
2026 # Example:
2027 #
2028 # {
2029 # &quot;audit_log_configs&quot;: [
2030 # {
2031 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2032 # &quot;exempted_members&quot;: [
2033 # &quot;user:[email protected]&quot;
2034 # ]
2035 # },
2036 # {
2037 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2038 # }
2039 # ]
2040 # }
2041 #
2042 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2043 # [email protected] from DATA_READ logging.
2044 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2045 # permission.
2046 # Follows the same format of Binding.members.
2047 &quot;A String&quot;,
2048 ],
2049 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2050 },
2051 ],
2052 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2053 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2054 # `allServices` is a special value that covers all services.
2055 },
2056 ],
2057 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2058 # may specify a `condition` that determines how and when the `bindings` are
2059 # applied. Each of the `bindings` must contain at least one principal.
2060 #
2061 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2062 # of these principals can be Google groups. Each occurrence of a principal
2063 # counts towards these limits. For example, if the `bindings` grant 50
2064 # different roles to `user:[email protected]`, and not to any other
2065 # principal, then you can add another 1,450 principals to the `bindings` in
2066 # the `Policy`.
2067 { # Associates `members`, or principals, with a `role`.
2068 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2069 #
2070 # If the condition evaluates to `true`, then this binding applies to the
2071 # current request.
2072 #
2073 # If the condition evaluates to `false`, then this binding does not apply to
2074 # the current request. However, a different role binding might grant the same
2075 # role to one or more of the principals in this binding.
2076 #
2077 # To learn which resources support conditions in their IAM policies, see the
2078 # [IAM
2079 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2080 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2081 # are documented at https://github.com/google/cel-spec.
2082 #
2083 # Example (Comparison):
2084 #
2085 # title: &quot;Summary size limit&quot;
2086 # description: &quot;Determines if a summary is less than 100 chars&quot;
2087 # expression: &quot;document.summary.size() &lt; 100&quot;
2088 #
2089 # Example (Equality):
2090 #
2091 # title: &quot;Requestor is owner&quot;
2092 # description: &quot;Determines if requestor is the document owner&quot;
2093 # expression: &quot;document.owner == request.auth.claims.email&quot;
2094 #
2095 # Example (Logic):
2096 #
2097 # title: &quot;Public documents&quot;
2098 # description: &quot;Determine whether the document should be publicly visible&quot;
2099 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2100 #
2101 # Example (Data Manipulation):
2102 #
2103 # title: &quot;Notification string&quot;
2104 # description: &quot;Create a notification string with a timestamp.&quot;
2105 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2106 #
2107 # The exact variables and functions that may be referenced within an expression
2108 # are determined by the service that evaluates it. See the service
2109 # documentation for additional information.
2110 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2111 # describes the expression, e.g. when hovered over it in a UI.
2112 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2113 # syntax.
2114 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2115 # reporting, e.g. a file name and a position in the file.
2116 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2117 # its purpose. This can be used e.g. in UIs which allow to enter the
2118 # expression.
2119 },
2120 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2121 # `members` can have the following values:
2122 #
2123 # * `allUsers`: A special identifier that represents anyone who is
2124 # on the internet; with or without a Google account.
2125 #
2126 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2127 # who is authenticated with a Google account or a service account.
2128 # Does not include identities that come from external identity providers
2129 # (IdPs) through identity federation.
2130 #
2131 # * `user:{emailid}`: An email address that represents a specific Google
2132 # account. For example, `[email protected]` .
2133 #
2134 #
2135 # * `serviceAccount:{emailid}`: An email address that represents a Google
2136 # service account. For example,
2137 # `[email protected]`.
2138 #
2139 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2140 # identifier for a
2141 # [Kubernetes service
2142 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2143 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2144 #
2145 # * `group:{emailid}`: An email address that represents a Google group.
2146 # For example, `[email protected]`.
2147 #
2148 #
2149 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2150 # users of that domain. For example, `google.com` or `example.com`.
2151 #
2152 #
2153 #
2154 #
2155 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2156 # A single identity in a workforce identity pool.
2157 #
2158 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2159 # All workforce identities in a group.
2160 #
2161 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2162 # All workforce identities with a specific attribute value.
2163 #
2164 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2165 # All identities in a workforce identity pool.
2166 #
2167 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2168 # A single identity in a workload identity pool.
2169 #
2170 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2171 # A workload identity pool group.
2172 #
2173 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2174 # All identities in a workload identity pool with a certain attribute.
2175 #
2176 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2177 # All identities in a workload identity pool.
2178 #
2179 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2180 # identifier) representing a user that has been recently deleted. For
2181 # example, `[email protected]?uid=123456789012345678901`. If the user is
2182 # recovered, this value reverts to `user:{emailid}` and the recovered user
2183 # retains the role in the binding.
2184 #
2185 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2186 # unique identifier) representing a service account that has been recently
2187 # deleted. For example,
2188 # `[email protected]?uid=123456789012345678901`.
2189 # If the service account is undeleted, this value reverts to
2190 # `serviceAccount:{emailid}` and the undeleted service account retains the
2191 # role in the binding.
2192 #
2193 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2194 # identifier) representing a Google group that has been recently
2195 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2196 # the group is recovered, this value reverts to `group:{emailid}` and the
2197 # recovered group retains the role in the binding.
2198 #
2199 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2200 # Deleted single identity in a workforce identity pool. For example,
2201 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2202 &quot;A String&quot;,
2203 ],
2204 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2205 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2206 #
2207 # For an overview of the IAM roles and permissions, see the
2208 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2209 # a list of the available pre-defined roles, see
2210 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2211 },
2212 ],
2213 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2214 # prevent simultaneous updates of a policy from overwriting each other.
2215 # It is strongly suggested that systems make use of the `etag` in the
2216 # read-modify-write cycle to perform policy updates in order to avoid race
2217 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2218 # systems are expected to put that etag in the request to `setIamPolicy` to
2219 # ensure that their change will be applied to the same version of the policy.
2220 #
2221 # **Important:** If you use IAM Conditions, you must include the `etag` field
2222 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2223 # you to overwrite a version `3` policy with a version `1` policy, and all of
2224 # the conditions in the version `3` policy are lost.
2225 &quot;version&quot;: 42, # Specifies the format of the policy.
2226 #
2227 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2228 # are rejected.
2229 #
2230 # Any operation that affects conditional role bindings must specify version
2231 # `3`. This requirement applies to the following operations:
2232 #
2233 # * Getting a policy that includes a conditional role binding
2234 # * Adding a conditional role binding to a policy
2235 # * Changing a conditional role binding in a policy
2236 # * Removing any role binding, with or without a condition, from a policy
2237 # that includes conditions
2238 #
2239 # **Important:** If you use IAM Conditions, you must include the `etag` field
2240 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2241 # you to overwrite a version `3` policy with a version `1` policy, and all of
2242 # the conditions in the version `3` policy are lost.
2243 #
2244 # If a policy does not include any conditions, operations on that policy may
2245 # specify any valid version or leave the field unset.
2246 #
2247 # To learn which resources support conditions in their IAM policies, see the
2248 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2249 },
2250 }
2251
2252 x__xgafv: string, V1 error format.
2253 Allowed values
2254 1 - v1 error format
2255 2 - v2 error format
2256
2257 Returns:
2258 An object of the form:
2259
2260 { # An Identity and Access Management (IAM) policy, which specifies access
2261 # controls for Google Cloud resources.
2262 #
2263 #
2264 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2265 # `members`, or principals, to a single `role`. Principals can be user
2266 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2267 # `role` is a named list of permissions; each `role` can be an IAM predefined
2268 # role or a user-created custom role.
2269 #
2270 # For some types of Google Cloud resources, a `binding` can also specify a
2271 # `condition`, which is a logical expression that allows access to a resource
2272 # only if the expression evaluates to `true`. A condition can add constraints
2273 # based on attributes of the request, the resource, or both. To learn which
2274 # resources support conditions in their IAM policies, see the
2275 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2276 #
2277 # **JSON example:**
2278 #
2279 # ```
2280 # {
2281 # &quot;bindings&quot;: [
2282 # {
2283 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2284 # &quot;members&quot;: [
2285 # &quot;user:[email protected]&quot;,
2286 # &quot;group:[email protected]&quot;,
2287 # &quot;domain:google.com&quot;,
2288 # &quot;serviceAccount:[email protected]&quot;
2289 # ]
2290 # },
2291 # {
2292 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2293 # &quot;members&quot;: [
2294 # &quot;user:[email protected]&quot;
2295 # ],
2296 # &quot;condition&quot;: {
2297 # &quot;title&quot;: &quot;expirable access&quot;,
2298 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2299 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2300 # }
2301 # }
2302 # ],
2303 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2304 # &quot;version&quot;: 3
2305 # }
2306 # ```
2307 #
2308 # **YAML example:**
2309 #
2310 # ```
2311 # bindings:
2312 # - members:
2313 # - user:[email protected]
2314 # - group:[email protected]
2315 # - domain:google.com
2316 # - serviceAccount:[email protected]
2317 # role: roles/resourcemanager.organizationAdmin
2318 # - members:
2319 # - user:[email protected]
2320 # role: roles/resourcemanager.organizationViewer
2321 # condition:
2322 # title: expirable access
2323 # description: Does not grant access after Sep 2020
2324 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2325 # etag: BwWWja0YfJA=
2326 # version: 3
2327 # ```
2328 #
2329 # For a description of IAM and its features, see the
2330 # [IAM documentation](https://cloud.google.com/iam/docs/).
2331 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2332 { # Specifies the audit configuration for a service.
2333 # The configuration determines which permission types are logged, and what
2334 # identities, if any, are exempted from logging.
2335 # An AuditConfig must have one or more AuditLogConfigs.
2336 #
2337 # If there are AuditConfigs for both `allServices` and a specific service,
2338 # the union of the two AuditConfigs is used for that service: the log_types
2339 # specified in each AuditConfig are enabled, and the exempted_members in each
2340 # AuditLogConfig are exempted.
2341 #
2342 # Example Policy with multiple AuditConfigs:
2343 #
2344 # {
2345 # &quot;audit_configs&quot;: [
2346 # {
2347 # &quot;service&quot;: &quot;allServices&quot;,
2348 # &quot;audit_log_configs&quot;: [
2349 # {
2350 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2351 # &quot;exempted_members&quot;: [
2352 # &quot;user:[email protected]&quot;
2353 # ]
2354 # },
2355 # {
2356 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2357 # },
2358 # {
2359 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2360 # }
2361 # ]
2362 # },
2363 # {
2364 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2365 # &quot;audit_log_configs&quot;: [
2366 # {
2367 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2368 # },
2369 # {
2370 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2371 # &quot;exempted_members&quot;: [
2372 # &quot;user:[email protected]&quot;
2373 # ]
2374 # }
2375 # ]
2376 # }
2377 # ]
2378 # }
2379 #
2380 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2381 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2382 # `[email protected]` from DATA_WRITE logging.
2383 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2384 { # Provides the configuration for logging a type of permissions.
2385 # Example:
2386 #
2387 # {
2388 # &quot;audit_log_configs&quot;: [
2389 # {
2390 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2391 # &quot;exempted_members&quot;: [
2392 # &quot;user:[email protected]&quot;
2393 # ]
2394 # },
2395 # {
2396 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2397 # }
2398 # ]
2399 # }
2400 #
2401 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2402 # [email protected] from DATA_READ logging.
2403 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2404 # permission.
2405 # Follows the same format of Binding.members.
2406 &quot;A String&quot;,
2407 ],
2408 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2409 },
2410 ],
2411 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2412 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2413 # `allServices` is a special value that covers all services.
2414 },
2415 ],
2416 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2417 # may specify a `condition` that determines how and when the `bindings` are
2418 # applied. Each of the `bindings` must contain at least one principal.
2419 #
2420 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2421 # of these principals can be Google groups. Each occurrence of a principal
2422 # counts towards these limits. For example, if the `bindings` grant 50
2423 # different roles to `user:[email protected]`, and not to any other
2424 # principal, then you can add another 1,450 principals to the `bindings` in
2425 # the `Policy`.
2426 { # Associates `members`, or principals, with a `role`.
2427 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2428 #
2429 # If the condition evaluates to `true`, then this binding applies to the
2430 # current request.
2431 #
2432 # If the condition evaluates to `false`, then this binding does not apply to
2433 # the current request. However, a different role binding might grant the same
2434 # role to one or more of the principals in this binding.
2435 #
2436 # To learn which resources support conditions in their IAM policies, see the
2437 # [IAM
2438 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2439 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2440 # are documented at https://github.com/google/cel-spec.
2441 #
2442 # Example (Comparison):
2443 #
2444 # title: &quot;Summary size limit&quot;
2445 # description: &quot;Determines if a summary is less than 100 chars&quot;
2446 # expression: &quot;document.summary.size() &lt; 100&quot;
2447 #
2448 # Example (Equality):
2449 #
2450 # title: &quot;Requestor is owner&quot;
2451 # description: &quot;Determines if requestor is the document owner&quot;
2452 # expression: &quot;document.owner == request.auth.claims.email&quot;
2453 #
2454 # Example (Logic):
2455 #
2456 # title: &quot;Public documents&quot;
2457 # description: &quot;Determine whether the document should be publicly visible&quot;
2458 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2459 #
2460 # Example (Data Manipulation):
2461 #
2462 # title: &quot;Notification string&quot;
2463 # description: &quot;Create a notification string with a timestamp.&quot;
2464 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2465 #
2466 # The exact variables and functions that may be referenced within an expression
2467 # are determined by the service that evaluates it. See the service
2468 # documentation for additional information.
2469 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2470 # describes the expression, e.g. when hovered over it in a UI.
2471 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2472 # syntax.
2473 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2474 # reporting, e.g. a file name and a position in the file.
2475 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2476 # its purpose. This can be used e.g. in UIs which allow to enter the
2477 # expression.
2478 },
2479 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2480 # `members` can have the following values:
2481 #
2482 # * `allUsers`: A special identifier that represents anyone who is
2483 # on the internet; with or without a Google account.
2484 #
2485 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2486 # who is authenticated with a Google account or a service account.
2487 # Does not include identities that come from external identity providers
2488 # (IdPs) through identity federation.
2489 #
2490 # * `user:{emailid}`: An email address that represents a specific Google
2491 # account. For example, `[email protected]` .
2492 #
2493 #
2494 # * `serviceAccount:{emailid}`: An email address that represents a Google
2495 # service account. For example,
2496 # `[email protected]`.
2497 #
2498 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2499 # identifier for a
2500 # [Kubernetes service
2501 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2502 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2503 #
2504 # * `group:{emailid}`: An email address that represents a Google group.
2505 # For example, `[email protected]`.
2506 #
2507 #
2508 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2509 # users of that domain. For example, `google.com` or `example.com`.
2510 #
2511 #
2512 #
2513 #
2514 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2515 # A single identity in a workforce identity pool.
2516 #
2517 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2518 # All workforce identities in a group.
2519 #
2520 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2521 # All workforce identities with a specific attribute value.
2522 #
2523 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2524 # All identities in a workforce identity pool.
2525 #
2526 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2527 # A single identity in a workload identity pool.
2528 #
2529 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2530 # A workload identity pool group.
2531 #
2532 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2533 # All identities in a workload identity pool with a certain attribute.
2534 #
2535 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2536 # All identities in a workload identity pool.
2537 #
2538 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2539 # identifier) representing a user that has been recently deleted. For
2540 # example, `[email protected]?uid=123456789012345678901`. If the user is
2541 # recovered, this value reverts to `user:{emailid}` and the recovered user
2542 # retains the role in the binding.
2543 #
2544 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2545 # unique identifier) representing a service account that has been recently
2546 # deleted. For example,
2547 # `[email protected]?uid=123456789012345678901`.
2548 # If the service account is undeleted, this value reverts to
2549 # `serviceAccount:{emailid}` and the undeleted service account retains the
2550 # role in the binding.
2551 #
2552 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2553 # identifier) representing a Google group that has been recently
2554 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2555 # the group is recovered, this value reverts to `group:{emailid}` and the
2556 # recovered group retains the role in the binding.
2557 #
2558 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2559 # Deleted single identity in a workforce identity pool. For example,
2560 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2561 &quot;A String&quot;,
2562 ],
2563 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2564 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2565 #
2566 # For an overview of the IAM roles and permissions, see the
2567 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2568 # a list of the available pre-defined roles, see
2569 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2570 },
2571 ],
2572 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2573 # prevent simultaneous updates of a policy from overwriting each other.
2574 # It is strongly suggested that systems make use of the `etag` in the
2575 # read-modify-write cycle to perform policy updates in order to avoid race
2576 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2577 # systems are expected to put that etag in the request to `setIamPolicy` to
2578 # ensure that their change will be applied to the same version of the policy.
2579 #
2580 # **Important:** If you use IAM Conditions, you must include the `etag` field
2581 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2582 # you to overwrite a version `3` policy with a version `1` policy, and all of
2583 # the conditions in the version `3` policy are lost.
2584 &quot;version&quot;: 42, # Specifies the format of the policy.
2585 #
2586 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2587 # are rejected.
2588 #
2589 # Any operation that affects conditional role bindings must specify version
2590 # `3`. This requirement applies to the following operations:
2591 #
2592 # * Getting a policy that includes a conditional role binding
2593 # * Adding a conditional role binding to a policy
2594 # * Changing a conditional role binding in a policy
2595 # * Removing any role binding, with or without a condition, from a policy
2596 # that includes conditions
2597 #
2598 # **Important:** If you use IAM Conditions, you must include the `etag` field
2599 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2600 # you to overwrite a version `3` policy with a version `1` policy, and all of
2601 # the conditions in the version `3` policy are lost.
2602 #
2603 # If a policy does not include any conditions, operations on that policy may
2604 # specify any valid version or leave the field unset.
2605 #
2606 # To learn which resources support conditions in their IAM policies, see the
2607 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2608 }</pre>
2609 </div>
2610
2611 <div class="method">
2612 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
2613 <pre>Returns permissions that a caller has on the specified resource.
2614
2615 Args:
2616 project: string, Project ID for this request. (required)
2617 region: string, The name of the region for this request. (required)
2618 resource: string, Name or id of the resource for this request. (required)
2619 body: object, The request body.
2620 The object takes the form of:
2621
2622 {
2623 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2624 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2625 &quot;A String&quot;,
2626 ],
2627 }
2628
2629 x__xgafv: string, V1 error format.
2630 Allowed values
2631 1 - v1 error format
2632 2 - v2 error format
2633
2634 Returns:
2635 An object of the form:
2636
2637 {
2638 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2639 # allowed.
2640 &quot;A String&quot;,
2641 ],
2642 }</pre>
2643 </div>
2644
2645 </body></html>