Debian Codegraph @

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