Debian Codegraph @

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