Debian Codegraph @

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