Debian Codegraph @

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