Debian Codegraph @

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