Debian Codegraph @

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