Debian Codegraph @

docs/dyn/compute_alpha.interconnects.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.interconnects.html">interconnects</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, interconnect, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified Interconnect.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, interconnect, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified Interconnect. Get a list of available Interconnects</p>
86 <p class="toc_element">
87 <code><a href="#getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</a></code></p>
88 <p class="firstline">Returns the interconnectDiagnostics for the specified</p>
89 <p class="toc_element">
90 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
92 <p class="toc_element">
93 <code><a href="#getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the interconnectMacsecConfig for the specified</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates an Interconnect in the specified project using</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves the list of Interconnects available to the specified project.</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, interconnect, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates the specified Interconnect with the data included in the request.</p>
107 <p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(project, 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="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the labels on an Interconnect. To learn more about labels,</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <h3>Method Details</h3>
117 <div class="method">
118 <code class="details" id="close">close()</code>
119 <pre>Close httplib2 connections.</pre>
120 </div>
121
122 <div class="method">
123 <code class="details" id="delete">delete(project, interconnect, requestId=None, x__xgafv=None)</code>
124 <pre>Deletes the specified Interconnect.
125
126 Args:
127 project: string, Project ID for this request. (required)
128 interconnect: string, Name of the interconnect to delete. (required)
129 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
130 that if you must retry your request, the server will know to ignore the
131 request if it has already been completed.
132
133 For example, consider a situation where you make an initial request and
134 the request times out. If you make the request again with the same
135 request ID, the server can check if original operation with the same
136 request ID was received, and if so, will ignore the second request. This
137 prevents clients from accidentally creating duplicate commitments.
138
139 The request ID must be
140 a valid UUID with the exception that zero UUID is not supported
141 (00000000-0000-0000-0000-000000000000).
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147 Returns:
148 An object of the form:
149
150 { # Represents an Operation resource.
151 #
152 # Google Compute Engine has three Operation resources:
153 #
154 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
155 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
156 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
157 #
158 # You can use an operation resource to manage asynchronous API requests.
159 # For more information, readHandling
160 # API responses.
161 #
162 # Operations can be global, regional or zonal.
163 #
164 # - For global operations, use the `globalOperations`
165 # resource.
166 # - For regional operations, use the
167 # `regionOperations` resource.
168 # - For zonal operations, use
169 # the `zoneOperations` resource.
170 #
171 #
172 #
173 # For more information, read
174 # Global, Regional, and Zonal Resources.
175 #
176 # Note that completed Operation resources have a limited
177 # retention period.
178 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
179 # Not present otherwise.
180 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
181 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
182 # set when the operation is created.
183 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
184 # text format.
185 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
186 # this field will be populated.
187 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
188 # operation.
189 {
190 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
191 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
192 # details. There is a set of defined message types to use for providing
193 # details.The syntax depends on the error code. For example,
194 # QuotaExceededInfo will have details when the error code is
195 # QUOTA_EXCEEDED.
196 {
197 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
198 #
199 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
200 # is not enabled:
201 #
202 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
203 # &quot;domain&quot;: &quot;googleapis.com&quot;
204 # &quot;metadata&quot;: {
205 # &quot;resource&quot;: &quot;projects/123&quot;,
206 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
207 # }
208 # }
209 #
210 # This response indicates that the pubsub.googleapis.com API is not enabled.
211 #
212 # Example of an error that is returned when attempting to create a Spanner
213 # instance in a region that is out of stock:
214 #
215 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
216 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
217 # &quot;metadata&quot;: {
218 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
219 # }
220 # }
221 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
222 # is typically the registered service name of the tool or product that
223 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
224 # generated by some common infrastructure, the error domain must be a
225 # globally unique value that identifies the infrastructure. For Google API
226 # infrastructure, the error domain is &quot;googleapis.com&quot;.
227 &quot;metadatas&quot;: { # Additional structured details about this error.
228 #
229 # Keys must match a regular expression of `a-z+` but should
230 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
231 # length. When identifying the current value of an exceeded limit, the units
232 # should be contained in the key, not the value. For example, rather than
233 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
234 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
235 # instances that can be created in a single (batch) request.
236 &quot;a_key&quot;: &quot;A String&quot;,
237 },
238 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
239 # proximate cause of the error. Error reasons are unique within a particular
240 # domain of errors. This should be at most 63 characters and match a
241 # regular expression of `A-Z+[A-Z0-9]`, which represents
242 # UPPER_SNAKE_CASE.
243 },
244 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
245 #
246 # For example, if a quota check failed with an error indicating the calling
247 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
248 # directly to the right place in the developer console to flip the bit.
249 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
250 { # Describes a URL link.
251 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
252 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
253 },
254 ],
255 },
256 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
257 # which can be attached to an RPC error.
258 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
259 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
260 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
261 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
262 },
263 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
264 &quot;dimensions&quot;: { # The map holding related quota dimensions.
265 &quot;a_key&quot;: &quot;A String&quot;,
266 },
267 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
268 # type or metric.
269 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
270 # or metric.
271 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
272 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
273 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
274 },
275 },
276 ],
277 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
278 # This property is optional.
279 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
280 },
281 ],
282 },
283 &quot;getVersionOperationMetadata&quot;: {
284 &quot;inlineSbomInfo&quot;: {
285 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
286 # appropriate identifiers.
287 &quot;a_key&quot;: &quot;A String&quot;,
288 },
289 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
290 # identifiers.
291 &quot;a_key&quot;: &quot;A String&quot;,
292 },
293 },
294 },
295 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
296 # message that was returned, such as `NOT FOUND`.
297 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
298 # status code that was returned. For example, a `404` means the
299 # resource was not found.
300 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
301 # defined by the server.
302 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
303 # This value is inRFC3339
304 # text format.
305 &quot;instancesBulkInsertOperationMetadata&quot;: {
306 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
307 # Example key: zones/us-central1-a
308 &quot;a_key&quot;: {
309 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
310 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
311 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
312 # error.
313 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
314 # if the flow is rolling forward or rolling back.
315 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
316 },
317 },
318 },
319 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
320 # Operation resources.
321 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
322 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
323 # group of operations results from a `bulkInsert` API request.
324 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
325 # `update`, or `delete`, and so on.
326 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
327 # There is no requirement that this be linear or support any granularity of
328 # operations. This should not be used to guess when the operation will be
329 # complete. This number should monotonically increase as the operation
330 # progresses.
331 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
332 # applicable when performing regional operations.
333 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
334 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
335 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
336 # this field will contain information on all underlying zonal actions and
337 # their state.
338 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
339 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
340 # Example key: zones/us-central1-a
341 &quot;a_key&quot;: {
342 &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
343 # populated.
344 # different programming environments, including REST APIs and RPC APIs. It is
345 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
346 # three pieces of data: error code, error message, and error details.
347 #
348 # You can find out more about this error model and how to work with it in the
349 # [API Design Guide](https://cloud.google.com/apis/design/errors).
350 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
351 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
352 # message types for APIs to use.
353 {
354 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
355 },
356 ],
357 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
358 # user-facing error message should be localized and sent in the
359 # google.rpc.Status.details field, or localized by the client.
360 },
361 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
362 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
363 },
364 },
365 },
366 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
367 # This value is inRFC3339
368 # text format.
369 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
370 # following:
371 # `PENDING`, `RUNNING`, or `DONE`.
372 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
373 # operation.
374 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
375 # of the target resource.
376 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
377 # operations related to creating a snapshot, this points to the disk
378 # that the snapshot was created from.
379 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
380 # `[email protected]` or
381 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
382 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
383 # operation, this field will be populated.
384 {
385 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
386 # Engine returns NO_RESULTS_ON_PAGE if there
387 # are no results in the response.
388 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
389 # value format. For example:
390 #
391 # &quot;data&quot;: [
392 # {
393 # &quot;key&quot;: &quot;scope&quot;,
394 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
395 # }
396 {
397 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
398 # returned. For example, for warnings where there are no results in a list
399 # request for a particular zone, this key might be scope and
400 # the key value might be the zone name. Other examples might be a key
401 # indicating a deprecated resource and a suggested replacement, or a
402 # warning about invalid network settings (for example, if an instance
403 # attempts to perform IP forwarding but is not enabled for IP forwarding).
404 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
405 },
406 ],
407 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
408 },
409 ],
410 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
411 # applicable when performing per-zone operations.
412 }</pre>
413 </div>
414
415 <div class="method">
416 <code class="details" id="get">get(project, interconnect, x__xgafv=None)</code>
417 <pre>Returns the specified Interconnect. Get a list of available Interconnects
418 by making a list() request.
419
420 Args:
421 project: string, Project ID for this request. (required)
422 interconnect: string, Name of the interconnect to return. (required)
423 x__xgafv: string, V1 error format.
424 Allowed values
425 1 - v1 error format
426 2 - v2 error format
427
428 Returns:
429 An object of the form:
430
431 { # Represents an Interconnect resource.
432 #
433 # An Interconnect resource is a dedicated connection between the Google
434 # Cloud network and your on-premises network. For more information, read the
435 # Dedicated Interconnect Overview.
436 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
437 # Interconnect.
438 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
439 # Interconnect is functional and can carry traffic.
440 # When set to false, no packets can be carried over the interconnect and
441 # no BGP routes are exchanged over it. By default, the status is set to true.
442 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
443 # Interconnect.
444 # Interconnect.
445 &quot;bandwidthPercentagePolicy&quot;: {
446 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
447 # type Bandwidth Percent.
448 { # Specify bandwidth percentages [1-100] for various traffic classes in
449 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
450 # All traffic classes must have a percentage value specified.
451 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
452 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
453 },
454 ],
455 },
456 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
457 # Interconnect.
458 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
459 # applied in conjunction with StrictPriorityPolicy or
460 # BandwidthPercentagePolicy.
461 { # Specify bandwidth percentages [1-100] for various traffic classes in
462 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
463 # All traffic classes must have a percentage value specified.
464 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
465 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
466 },
467 ],
468 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
469 },
470 },
471 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
472 # which can take one of the following values:
473 #
474 # - IF_MACSEC: If present, then the Interconnect connection is
475 # provisioned on MACsec capable hardware ports. If not present, then the
476 # Interconnect connection is provisioned on non-MACsec capable ports. Any
477 # attempt to enable MACsec will fail.
478 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
479 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
480 # VLAN attachments will fail. If not present, then the Interconnect
481 # connection is not provisioned for Cross-Site Networking. Any attempt to use
482 # it for Cross-Site Networking will fail.
483 &quot;A String&quot;,
484 ],
485 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
486 # circuits in this LAG.
487 { # Describes a single physical circuit between the Customer and Google.
488 # CircuitInfo objects are created by Google, so all fields are output only.
489 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
490 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
491 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
492 # provided by Google to the customer in the LOA.
493 },
494 ],
495 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
496 # text format.
497 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
498 # authorized to request a crossconnect.
499 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
500 # create the resource.
501 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
502 # this connection is to be provisioned. By default it will be the same as the
503 # location field.
504 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
505 { # Description of a planned outage on this Interconnect.
506 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
507 # IDs that will be affected.
508 &quot;A String&quot;,
509 ],
510 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
511 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
512 # epoch).
513 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
514 # values:
515 #
516 # - OUTAGE: The Interconnect may be completely out of service for
517 # some or all of the specified window.
518 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
519 # should remain up, but with reduced bandwidth.
520 #
521 #
522 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
523 # deprecated in favor of the unprefixed values.
524 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
525 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
526 # value:
527 #
528 # - GOOGLE: this notification as generated by Google.
529 #
530 #
531 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
532 # GOOGLE.
533 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
534 # epoch).
535 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
536 #
537 # - ACTIVE: This outage notification is active. The event could be in
538 # the past, present, or future. See start_time and end_time for
539 # scheduling.
540 # - CANCELLED: The outage associated with this notification was cancelled
541 # before the outage was due to start.
542 # - COMPLETED: The outage associated with this notification is complete.
543 #
544 #
545 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
546 # deprecated in favor of the unprefixed values.
547 },
548 ],
549 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
550 # link. This can be used only for ping tests.
551 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
552 # with Google or otherwise to debug backend connectivity issues.
553 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
554 # defined by the server.
555 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
556 # to use this Interconnect.
557 &quot;A String&quot;,
558 ],
559 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
560 # Order is arbitrary and items are unique.
561 &quot;A String&quot;,
562 ],
563 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
564 #
565 # - PARTNER: A partner-managed interconnection shared between customers
566 # though a partner.
567 # - DEDICATED: A dedicated physical interconnection with the
568 # customer.
569 #
570 #
571 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
572 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
573 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
574 # is essentially a hash of the labels set used for optimistic locking. The
575 # fingerprint is initially generated by Compute Engine and changes after
576 # every request to modify or update labels. You must always provide an
577 # up-to-date fingerprint hash in order to update or change labels,
578 # otherwise the request will fail with error412 conditionNotMet.
579 #
580 # To see the latest fingerprint, make a get() request to
581 # retrieve an Interconnect.
582 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
583 # Label values may be empty.
584 &quot;a_key&quot;: &quot;A String&quot;,
585 },
586 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
587 #
588 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
589 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
590 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
591 #
592 #
593 # Note that this field indicates the speed of each of
594 # the links in the bundle, not the speed of the entire bundle.
595 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
596 # connection is to be provisioned.
597 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
598 # Cloud Interconnect connection between Google and your on-premises router.
599 # (MACsec) on this Cloud Interconnect connection between Google and your
600 # on-premises router.
601 &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
602 # router to fallback to cleartext traffic if the MKA session cannot be
603 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
604 # MKA session cannot be established with your router.
605 &quot;interconnectKeyGroup&quot;: &quot;A String&quot;, # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the
606 # format:
607 # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}.
608 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
609 # along with their start times. A MACsec CKN/CAK is generated for each
610 # key in the key chain. Google router automatically picks the key with
611 # the most recent startTime when establishing or re-establishing a MACsec
612 # secure link.
613 { # Describes a pre-shared key used to setup MACsec in static connectivity
614 # association key (CAK) mode.
615 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
616 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
617 # characters long and match the regular expression
618 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
619 # lowercase letter, and all following characters must be a dash,
620 # lowercase letter, or digit, except the last character, which cannot be
621 # a dash.
622 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
623 # valid. startTime can be in the future. If the keychain has a single
624 # key, startTime can be omitted. If the keychain has multiple keys,
625 # startTime is mandatory for each key. The start times of keys must be in
626 # increasing order. The start times of two consecutive keys must be
627 # at least 6 hours apart.
628 },
629 ],
630 },
631 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
632 # fails if the MACsec object is not specified.
633 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
634 # The name must be 1-63 characters long, and comply withRFC1035.
635 # Specifically, the name must be 1-63 characters long and match the regular
636 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
637 # character must be a lowercase letter, and all following characters must be
638 # a dash, lowercase letter, or digit, except the last character, which cannot
639 # be a dash.
640 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
641 # notifications regarding this Interconnect. If specified, this will be used
642 # for notifications in addition to all other forms described, such as
643 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
644 # required for users who sign up for Cloud Interconnect using
645 # workforce identity federation.
646 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
647 # which can take one of the following values:
648 #
649 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
650 # use. Attachments may be provisioned on this Interconnect.
651 #
652 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
653 # attachments may be provisioned on this Interconnect.
654 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
655 # maintenance. No attachments may be provisioned or updated on this
656 # Interconnect.
657 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
658 # as part of resource payload.
659 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
660 # Tag keys and values have the same definition as resource
661 # manager tags. The field is allowed for INSERT
662 # only. The keys/values to set on the resource should be specified in
663 # either ID { : } or Namespaced format
664 # { : }.
665 # For example the following are valid inputs:
666 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
667 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
668 # Note:
669 # * Invalid combinations of ID &amp; namespaced format is not supported. For
670 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
671 # * Inconsistent format is not supported. For instance:
672 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
673 &quot;a_key&quot;: &quot;A String&quot;,
674 },
675 },
676 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
677 # Interconnect link. The customer should configure this IP address during
678 # turnup when prompted by Google NOC. This can be used only for ping tests.
679 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
680 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
681 # location outside of Google&#x27;s network that the interconnect is connected to.
682 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
683 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
684 # Interconnect connection, which can take one of the following values:
685 #
686 # - IF_MACSEC: If specified, then the connection is created on MACsec
687 # capable hardware ports. If not specified, non-MACsec capable ports will
688 # also be considered.
689 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
690 # exclusively for Cross-Site Networking. The connection can not be used for
691 # Cross-Site Networking unless this feature is specified.
692 &quot;A String&quot;,
693 ],
694 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
695 # customer.
696 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
697 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
698 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
699 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
700 # take one of the following values:
701 #
702 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
703 # Attachments may be provisioned on this Interconnect.
704 # - UNPROVISIONED: The Interconnect has not completed turnup. No
705 # attachments may be provisioned on this Interconnect.
706 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
707 # No attachments may be provisioned or updated on this
708 # Interconnect.
709 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
710 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
711 # configured to use this Interconnect. The Interconnect cannot be deleted if
712 # this list is non-empty.
713 &quot;A String&quot;,
714 ],
715 }</pre>
716 </div>
717
718 <div class="method">
719 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</code>
720 <pre>Returns the interconnectDiagnostics for the specified
721 Interconnect.
722
723 In the event of a
724 global outage, do not use this API to make decisions about where to
725 redirect your network traffic.
726
727 Unlike a VLAN attachment, which is regional, a Cloud Interconnect
728 connection is a global resource. A global outage can prevent this
729 API from functioning properly.
730
731 Args:
732 project: string, Project ID for this request. (required)
733 interconnect: string, Name of the interconnect resource to query. (required)
734 x__xgafv: string, V1 error format.
735 Allowed values
736 1 - v1 error format
737 2 - v2 error format
738
739 Returns:
740 An object of the form:
741
742 { # Response for the InterconnectsGetDiagnosticsRequest.
743 &quot;result&quot;: { # Diagnostics information about the Interconnect connection, which contains
744 # detailed and current technical information about Google&#x27;s side of the
745 # connection.
746 &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
747 # describing individual neighbors currently seen by the Google router in
748 # the ARP cache for the Interconnect.
749 # This will be empty when the Interconnect is not bundled.
750 { # Describing the ARP neighbor entries seen on this link
751 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
752 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
753 },
754 ],
755 &quot;bundleAggregationType&quot;: &quot;A String&quot;, # The aggregation type of the bundle interface.
756 &quot;bundleOperationalStatus&quot;: &quot;A String&quot;, # The operational status of the bundle interface.
757 &quot;links&quot;: [ # A list of InterconnectDiagnostics.LinkStatus objects,
758 # describing the status for each link on the Interconnect.
759 {
760 &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
761 # describing the ARP neighbor entries seen on this link.
762 # This will be empty if the link is bundled
763 { # Describing the ARP neighbor entries seen on this link
764 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
765 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
766 },
767 ],
768 &quot;circuitId&quot;: &quot;A String&quot;, # The unique ID for this link assigned during turn up by Google.
769 &quot;googleDemarc&quot;: &quot;A String&quot;, # The Demarc address assigned by Google and provided in the LoA.
770 &quot;lacpStatus&quot;: {
771 &quot;googleSystemId&quot;: &quot;A String&quot;, # System ID of the port on Google&#x27;s side of the LACP exchange.
772 &quot;neighborSystemId&quot;: &quot;A String&quot;, # System ID of the port on the neighbor&#x27;s side of the LACP exchange.
773 &quot;state&quot;: &quot;A String&quot;, # The state of a LACP link, which can take one of the following values:
774 #
775 # - ACTIVE: The link is configured and active within the bundle.
776 # - DETACHED: The link is not configured within the bundle. This means
777 # that the rest of the object should be empty.
778 },
779 &quot;macsec&quot;: { # Describes the status of MACsec encryption on the link. # Describes the status of MACsec encryption on this link.
780 &quot;ckn&quot;: &quot;A String&quot;, # Indicates the Connectivity Association Key Name (CKN)
781 # currently being used if MACsec is operational.
782 &quot;operational&quot;: True or False, # Indicates whether or not MACsec is operational on this link.
783 },
784 &quot;operationalStatus&quot;: &quot;A String&quot;, # The operational status of the link.
785 &quot;receivingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
786 # describing the current value and status of the received light level.
787 &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
788 # levels for the receiving or transmitting transceiver. Possible states
789 # include:
790 #
791 #
792 # - OK: The value has not crossed a warning threshold.
793 # - LOW_WARNING: The value has crossed below the low
794 # warning threshold.
795 # - HIGH_WARNING: The value has
796 # crossed above the high warning threshold.
797 # - LOW_ALARM: The value has crossed below the low alarm
798 # threshold.
799 # - HIGH_ALARM: The value has crossed above the high alarm
800 # threshold.
801 &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
802 # dBm. Take a known good optical value, give it a 10% margin and trigger
803 # warnings relative to that value. In general, a -7dBm warning and a -11dBm
804 # alarm are good optical value estimates for most links.
805 },
806 &quot;transmittingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
807 # describing the current value and status of the transmitted light level.
808 &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
809 # levels for the receiving or transmitting transceiver. Possible states
810 # include:
811 #
812 #
813 # - OK: The value has not crossed a warning threshold.
814 # - LOW_WARNING: The value has crossed below the low
815 # warning threshold.
816 # - HIGH_WARNING: The value has
817 # crossed above the high warning threshold.
818 # - LOW_ALARM: The value has crossed below the low alarm
819 # threshold.
820 # - HIGH_ALARM: The value has crossed above the high alarm
821 # threshold.
822 &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
823 # dBm. Take a known good optical value, give it a 10% margin and trigger
824 # warnings relative to that value. In general, a -7dBm warning and a -11dBm
825 # alarm are good optical value estimates for most links.
826 },
827 },
828 ],
829 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of the Interconnect&#x27;s bundle interface.
830 },
831 }</pre>
832 </div>
833
834 <div class="method">
835 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
836 <pre>Gets the access control policy for a resource. May be empty if no such
837 policy or resource exists.
838
839 Args:
840 project: string, Project ID for this request. (required)
841 resource: string, Name or id of the resource for this request. (required)
842 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
843 x__xgafv: string, V1 error format.
844 Allowed values
845 1 - v1 error format
846 2 - v2 error format
847
848 Returns:
849 An object of the form:
850
851 { # An Identity and Access Management (IAM) policy, which specifies access
852 # controls for Google Cloud resources.
853 #
854 #
855 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
856 # `members`, or principals, to a single `role`. Principals can be user
857 # accounts, service accounts, Google groups, and domains (such as G Suite). A
858 # `role` is a named list of permissions; each `role` can be an IAM predefined
859 # role or a user-created custom role.
860 #
861 # For some types of Google Cloud resources, a `binding` can also specify a
862 # `condition`, which is a logical expression that allows access to a resource
863 # only if the expression evaluates to `true`. A condition can add constraints
864 # based on attributes of the request, the resource, or both. To learn which
865 # resources support conditions in their IAM policies, see the
866 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
867 #
868 # **JSON example:**
869 #
870 # ```
871 # {
872 # &quot;bindings&quot;: [
873 # {
874 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
875 # &quot;members&quot;: [
876 # &quot;user:[email protected]&quot;,
877 # &quot;group:[email protected]&quot;,
878 # &quot;domain:google.com&quot;,
879 # &quot;serviceAccount:[email protected]&quot;
880 # ]
881 # },
882 # {
883 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
884 # &quot;members&quot;: [
885 # &quot;user:[email protected]&quot;
886 # ],
887 # &quot;condition&quot;: {
888 # &quot;title&quot;: &quot;expirable access&quot;,
889 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
890 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
891 # }
892 # }
893 # ],
894 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
895 # &quot;version&quot;: 3
896 # }
897 # ```
898 #
899 # **YAML example:**
900 #
901 # ```
902 # bindings:
903 # - members:
904 # - user:[email protected]
905 # - group:[email protected]
906 # - domain:google.com
907 # - serviceAccount:[email protected]
908 # role: roles/resourcemanager.organizationAdmin
909 # - members:
910 # - user:[email protected]
911 # role: roles/resourcemanager.organizationViewer
912 # condition:
913 # title: expirable access
914 # description: Does not grant access after Sep 2020
915 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
916 # etag: BwWWja0YfJA=
917 # version: 3
918 # ```
919 #
920 # For a description of IAM and its features, see the
921 # [IAM documentation](https://cloud.google.com/iam/docs/).
922 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
923 { # Specifies the audit configuration for a service.
924 # The configuration determines which permission types are logged, and what
925 # identities, if any, are exempted from logging.
926 # An AuditConfig must have one or more AuditLogConfigs.
927 #
928 # If there are AuditConfigs for both `allServices` and a specific service,
929 # the union of the two AuditConfigs is used for that service: the log_types
930 # specified in each AuditConfig are enabled, and the exempted_members in each
931 # AuditLogConfig are exempted.
932 #
933 # Example Policy with multiple AuditConfigs:
934 #
935 # {
936 # &quot;audit_configs&quot;: [
937 # {
938 # &quot;service&quot;: &quot;allServices&quot;,
939 # &quot;audit_log_configs&quot;: [
940 # {
941 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
942 # &quot;exempted_members&quot;: [
943 # &quot;user:[email protected]&quot;
944 # ]
945 # },
946 # {
947 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
948 # },
949 # {
950 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
951 # }
952 # ]
953 # },
954 # {
955 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
956 # &quot;audit_log_configs&quot;: [
957 # {
958 # &quot;log_type&quot;: &quot;DATA_READ&quot;
959 # },
960 # {
961 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
962 # &quot;exempted_members&quot;: [
963 # &quot;user:[email protected]&quot;
964 # ]
965 # }
966 # ]
967 # }
968 # ]
969 # }
970 #
971 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
972 # logging. It also exempts `[email protected]` from DATA_READ logging, and
973 # `[email protected]` from DATA_WRITE logging.
974 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
975 { # Provides the configuration for logging a type of permissions.
976 # Example:
977 #
978 # {
979 # &quot;audit_log_configs&quot;: [
980 # {
981 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
982 # &quot;exempted_members&quot;: [
983 # &quot;user:[email protected]&quot;
984 # ]
985 # },
986 # {
987 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
988 # }
989 # ]
990 # }
991 #
992 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
993 # [email protected] from DATA_READ logging.
994 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
995 # permission.
996 # Follows the same format of Binding.members.
997 &quot;A String&quot;,
998 ],
999 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1000 },
1001 ],
1002 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1003 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1004 # `allServices` is a special value that covers all services.
1005 },
1006 ],
1007 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1008 # may specify a `condition` that determines how and when the `bindings` are
1009 # applied. Each of the `bindings` must contain at least one principal.
1010 #
1011 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1012 # of these principals can be Google groups. Each occurrence of a principal
1013 # counts towards these limits. For example, if the `bindings` grant 50
1014 # different roles to `user:[email protected]`, and not to any other
1015 # principal, then you can add another 1,450 principals to the `bindings` in
1016 # the `Policy`.
1017 { # Associates `members`, or principals, with a `role`.
1018 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1019 #
1020 # If the condition evaluates to `true`, then this binding applies to the
1021 # current request.
1022 #
1023 # If the condition evaluates to `false`, then this binding does not apply to
1024 # the current request. However, a different role binding might grant the same
1025 # role to one or more of the principals in this binding.
1026 #
1027 # To learn which resources support conditions in their IAM policies, see the
1028 # [IAM
1029 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1030 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1031 # are documented at https://github.com/google/cel-spec.
1032 #
1033 # Example (Comparison):
1034 #
1035 # title: &quot;Summary size limit&quot;
1036 # description: &quot;Determines if a summary is less than 100 chars&quot;
1037 # expression: &quot;document.summary.size() &lt; 100&quot;
1038 #
1039 # Example (Equality):
1040 #
1041 # title: &quot;Requestor is owner&quot;
1042 # description: &quot;Determines if requestor is the document owner&quot;
1043 # expression: &quot;document.owner == request.auth.claims.email&quot;
1044 #
1045 # Example (Logic):
1046 #
1047 # title: &quot;Public documents&quot;
1048 # description: &quot;Determine whether the document should be publicly visible&quot;
1049 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1050 #
1051 # Example (Data Manipulation):
1052 #
1053 # title: &quot;Notification string&quot;
1054 # description: &quot;Create a notification string with a timestamp.&quot;
1055 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1056 #
1057 # The exact variables and functions that may be referenced within an expression
1058 # are determined by the service that evaluates it. See the service
1059 # documentation for additional information.
1060 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1061 # describes the expression, e.g. when hovered over it in a UI.
1062 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1063 # syntax.
1064 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1065 # reporting, e.g. a file name and a position in the file.
1066 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1067 # its purpose. This can be used e.g. in UIs which allow to enter the
1068 # expression.
1069 },
1070 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1071 # `members` can have the following values:
1072 #
1073 # * `allUsers`: A special identifier that represents anyone who is
1074 # on the internet; with or without a Google account.
1075 #
1076 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1077 # who is authenticated with a Google account or a service account.
1078 # Does not include identities that come from external identity providers
1079 # (IdPs) through identity federation.
1080 #
1081 # * `user:{emailid}`: An email address that represents a specific Google
1082 # account. For example, `[email protected]` .
1083 #
1084 #
1085 # * `serviceAccount:{emailid}`: An email address that represents a Google
1086 # service account. For example,
1087 # `[email protected]`.
1088 #
1089 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1090 # identifier for a
1091 # [Kubernetes service
1092 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1093 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1094 #
1095 # * `group:{emailid}`: An email address that represents a Google group.
1096 # For example, `[email protected]`.
1097 #
1098 #
1099 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1100 # users of that domain. For example, `google.com` or `example.com`.
1101 #
1102 #
1103 #
1104 #
1105 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1106 # A single identity in a workforce identity pool.
1107 #
1108 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1109 # All workforce identities in a group.
1110 #
1111 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1112 # All workforce identities with a specific attribute value.
1113 #
1114 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1115 # All identities in a workforce identity pool.
1116 #
1117 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1118 # A single identity in a workload identity pool.
1119 #
1120 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1121 # A workload identity pool group.
1122 #
1123 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1124 # All identities in a workload identity pool with a certain attribute.
1125 #
1126 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1127 # All identities in a workload identity pool.
1128 #
1129 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1130 # identifier) representing a user that has been recently deleted. For
1131 # example, `[email protected]?uid=123456789012345678901`. If the user is
1132 # recovered, this value reverts to `user:{emailid}` and the recovered user
1133 # retains the role in the binding.
1134 #
1135 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1136 # unique identifier) representing a service account that has been recently
1137 # deleted. For example,
1138 # `[email protected]?uid=123456789012345678901`.
1139 # If the service account is undeleted, this value reverts to
1140 # `serviceAccount:{emailid}` and the undeleted service account retains the
1141 # role in the binding.
1142 #
1143 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1144 # identifier) representing a Google group that has been recently
1145 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1146 # the group is recovered, this value reverts to `group:{emailid}` and the
1147 # recovered group retains the role in the binding.
1148 #
1149 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1150 # Deleted single identity in a workforce identity pool. For example,
1151 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1152 &quot;A String&quot;,
1153 ],
1154 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1155 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1156 #
1157 # For an overview of the IAM roles and permissions, see the
1158 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1159 # a list of the available pre-defined roles, see
1160 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1161 },
1162 ],
1163 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1164 # prevent simultaneous updates of a policy from overwriting each other.
1165 # It is strongly suggested that systems make use of the `etag` in the
1166 # read-modify-write cycle to perform policy updates in order to avoid race
1167 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1168 # systems are expected to put that etag in the request to `setIamPolicy` to
1169 # ensure that their change will be applied to the same version of the policy.
1170 #
1171 # **Important:** If you use IAM Conditions, you must include the `etag` field
1172 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1173 # you to overwrite a version `3` policy with a version `1` policy, and all of
1174 # the conditions in the version `3` policy are lost.
1175 &quot;version&quot;: 42, # Specifies the format of the policy.
1176 #
1177 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1178 # are rejected.
1179 #
1180 # Any operation that affects conditional role bindings must specify version
1181 # `3`. This requirement applies to the following operations:
1182 #
1183 # * Getting a policy that includes a conditional role binding
1184 # * Adding a conditional role binding to a policy
1185 # * Changing a conditional role binding in a policy
1186 # * Removing any role binding, with or without a condition, from a policy
1187 # that includes conditions
1188 #
1189 # **Important:** If you use IAM Conditions, you must include the `etag` field
1190 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1191 # you to overwrite a version `3` policy with a version `1` policy, and all of
1192 # the conditions in the version `3` policy are lost.
1193 #
1194 # If a policy does not include any conditions, operations on that policy may
1195 # specify any valid version or leave the field unset.
1196 #
1197 # To learn which resources support conditions in their IAM policies, see the
1198 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1199 }</pre>
1200 </div>
1201
1202 <div class="method">
1203 <code class="details" id="getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</code>
1204 <pre>Returns the interconnectMacsecConfig for the specified
1205 Interconnect.
1206
1207 Args:
1208 project: string, Project ID for this request. (required)
1209 interconnect: string, Name of the interconnect resource to query. (required)
1210 x__xgafv: string, V1 error format.
1211 Allowed values
1212 1 - v1 error format
1213 2 - v2 error format
1214
1215 Returns:
1216 An object of the form:
1217
1218 { # Response for the InterconnectsGetMacsecConfigRequest.
1219 &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
1220 &quot;result&quot;: { # MACsec configuration information for the Interconnect connection. Contains
1221 # the generated Connectivity Association Key Name (CKN) and the key (CAK) for
1222 # this Interconnect connection.
1223 &quot;preSharedKeys&quot;: [ # A keychain placeholder describing a set of named key objects
1224 # along with their start times. A MACsec CKN/CAK is generated for each key in
1225 # the key chain. Google router automatically picks the key with the most
1226 # recent startTime when establishing or re-establishing a MACsec secure link.
1227 { # Describes a pre-shared key used to setup MACsec in static connectivity
1228 # association key (CAK) mode.
1229 &quot;cak&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key (CAK) for this key.
1230 &quot;ckn&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key Name (CKN) for this key.
1231 &quot;name&quot;: &quot;A String&quot;, # User provided name for this pre-shared key.
1232 &quot;startTime&quot;: &quot;A String&quot;, # User provided timestamp on or after which this key is valid.
1233 },
1234 ],
1235 },
1236 }</pre>
1237 </div>
1238
1239 <div class="method">
1240 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
1241 <pre>Creates an Interconnect in the specified project using
1242 the data included in the request.
1243
1244 Args:
1245 project: string, Project ID for this request. (required)
1246 body: object, The request body.
1247 The object takes the form of:
1248
1249 { # Represents an Interconnect resource.
1250 #
1251 # An Interconnect resource is a dedicated connection between the Google
1252 # Cloud network and your on-premises network. For more information, read the
1253 # Dedicated Interconnect Overview.
1254 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
1255 # Interconnect.
1256 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
1257 # Interconnect is functional and can carry traffic.
1258 # When set to false, no packets can be carried over the interconnect and
1259 # no BGP routes are exchanged over it. By default, the status is set to true.
1260 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
1261 # Interconnect.
1262 # Interconnect.
1263 &quot;bandwidthPercentagePolicy&quot;: {
1264 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
1265 # type Bandwidth Percent.
1266 { # Specify bandwidth percentages [1-100] for various traffic classes in
1267 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1268 # All traffic classes must have a percentage value specified.
1269 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1270 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1271 },
1272 ],
1273 },
1274 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
1275 # Interconnect.
1276 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
1277 # applied in conjunction with StrictPriorityPolicy or
1278 # BandwidthPercentagePolicy.
1279 { # Specify bandwidth percentages [1-100] for various traffic classes in
1280 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1281 # All traffic classes must have a percentage value specified.
1282 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1283 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1284 },
1285 ],
1286 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
1287 },
1288 },
1289 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
1290 # which can take one of the following values:
1291 #
1292 # - IF_MACSEC: If present, then the Interconnect connection is
1293 # provisioned on MACsec capable hardware ports. If not present, then the
1294 # Interconnect connection is provisioned on non-MACsec capable ports. Any
1295 # attempt to enable MACsec will fail.
1296 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
1297 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
1298 # VLAN attachments will fail. If not present, then the Interconnect
1299 # connection is not provisioned for Cross-Site Networking. Any attempt to use
1300 # it for Cross-Site Networking will fail.
1301 &quot;A String&quot;,
1302 ],
1303 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
1304 # circuits in this LAG.
1305 { # Describes a single physical circuit between the Customer and Google.
1306 # CircuitInfo objects are created by Google, so all fields are output only.
1307 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
1308 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
1309 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
1310 # provided by Google to the customer in the LOA.
1311 },
1312 ],
1313 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1314 # text format.
1315 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
1316 # authorized to request a crossconnect.
1317 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1318 # create the resource.
1319 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
1320 # this connection is to be provisioned. By default it will be the same as the
1321 # location field.
1322 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
1323 { # Description of a planned outage on this Interconnect.
1324 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
1325 # IDs that will be affected.
1326 &quot;A String&quot;,
1327 ],
1328 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
1329 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
1330 # epoch).
1331 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
1332 # values:
1333 #
1334 # - OUTAGE: The Interconnect may be completely out of service for
1335 # some or all of the specified window.
1336 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
1337 # should remain up, but with reduced bandwidth.
1338 #
1339 #
1340 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
1341 # deprecated in favor of the unprefixed values.
1342 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
1343 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
1344 # value:
1345 #
1346 # - GOOGLE: this notification as generated by Google.
1347 #
1348 #
1349 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
1350 # GOOGLE.
1351 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
1352 # epoch).
1353 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
1354 #
1355 # - ACTIVE: This outage notification is active. The event could be in
1356 # the past, present, or future. See start_time and end_time for
1357 # scheduling.
1358 # - CANCELLED: The outage associated with this notification was cancelled
1359 # before the outage was due to start.
1360 # - COMPLETED: The outage associated with this notification is complete.
1361 #
1362 #
1363 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
1364 # deprecated in favor of the unprefixed values.
1365 },
1366 ],
1367 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
1368 # link. This can be used only for ping tests.
1369 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
1370 # with Google or otherwise to debug backend connectivity issues.
1371 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1372 # defined by the server.
1373 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
1374 # to use this Interconnect.
1375 &quot;A String&quot;,
1376 ],
1377 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
1378 # Order is arbitrary and items are unique.
1379 &quot;A String&quot;,
1380 ],
1381 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
1382 #
1383 # - PARTNER: A partner-managed interconnection shared between customers
1384 # though a partner.
1385 # - DEDICATED: A dedicated physical interconnection with the
1386 # customer.
1387 #
1388 #
1389 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
1390 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
1391 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
1392 # is essentially a hash of the labels set used for optimistic locking. The
1393 # fingerprint is initially generated by Compute Engine and changes after
1394 # every request to modify or update labels. You must always provide an
1395 # up-to-date fingerprint hash in order to update or change labels,
1396 # otherwise the request will fail with error412 conditionNotMet.
1397 #
1398 # To see the latest fingerprint, make a get() request to
1399 # retrieve an Interconnect.
1400 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
1401 # Label values may be empty.
1402 &quot;a_key&quot;: &quot;A String&quot;,
1403 },
1404 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
1405 #
1406 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
1407 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
1408 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
1409 #
1410 #
1411 # Note that this field indicates the speed of each of
1412 # the links in the bundle, not the speed of the entire bundle.
1413 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
1414 # connection is to be provisioned.
1415 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
1416 # Cloud Interconnect connection between Google and your on-premises router.
1417 # (MACsec) on this Cloud Interconnect connection between Google and your
1418 # on-premises router.
1419 &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
1420 # router to fallback to cleartext traffic if the MKA session cannot be
1421 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
1422 # MKA session cannot be established with your router.
1423 &quot;interconnectKeyGroup&quot;: &quot;A String&quot;, # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the
1424 # format:
1425 # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}.
1426 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
1427 # along with their start times. A MACsec CKN/CAK is generated for each
1428 # key in the key chain. Google router automatically picks the key with
1429 # the most recent startTime when establishing or re-establishing a MACsec
1430 # secure link.
1431 { # Describes a pre-shared key used to setup MACsec in static connectivity
1432 # association key (CAK) mode.
1433 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
1434 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1435 # characters long and match the regular expression
1436 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1437 # lowercase letter, and all following characters must be a dash,
1438 # lowercase letter, or digit, except the last character, which cannot be
1439 # a dash.
1440 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
1441 # valid. startTime can be in the future. If the keychain has a single
1442 # key, startTime can be omitted. If the keychain has multiple keys,
1443 # startTime is mandatory for each key. The start times of keys must be in
1444 # increasing order. The start times of two consecutive keys must be
1445 # at least 6 hours apart.
1446 },
1447 ],
1448 },
1449 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
1450 # fails if the MACsec object is not specified.
1451 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1452 # The name must be 1-63 characters long, and comply withRFC1035.
1453 # Specifically, the name must be 1-63 characters long and match the regular
1454 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1455 # character must be a lowercase letter, and all following characters must be
1456 # a dash, lowercase letter, or digit, except the last character, which cannot
1457 # be a dash.
1458 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
1459 # notifications regarding this Interconnect. If specified, this will be used
1460 # for notifications in addition to all other forms described, such as
1461 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
1462 # required for users who sign up for Cloud Interconnect using
1463 # workforce identity federation.
1464 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
1465 # which can take one of the following values:
1466 #
1467 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
1468 # use. Attachments may be provisioned on this Interconnect.
1469 #
1470 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
1471 # attachments may be provisioned on this Interconnect.
1472 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
1473 # maintenance. No attachments may be provisioned or updated on this
1474 # Interconnect.
1475 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1476 # as part of resource payload.
1477 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1478 # Tag keys and values have the same definition as resource
1479 # manager tags. The field is allowed for INSERT
1480 # only. The keys/values to set on the resource should be specified in
1481 # either ID { : } or Namespaced format
1482 # { : }.
1483 # For example the following are valid inputs:
1484 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1485 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1486 # Note:
1487 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1488 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1489 # * Inconsistent format is not supported. For instance:
1490 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1491 &quot;a_key&quot;: &quot;A String&quot;,
1492 },
1493 },
1494 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
1495 # Interconnect link. The customer should configure this IP address during
1496 # turnup when prompted by Google NOC. This can be used only for ping tests.
1497 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
1498 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
1499 # location outside of Google&#x27;s network that the interconnect is connected to.
1500 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
1501 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
1502 # Interconnect connection, which can take one of the following values:
1503 #
1504 # - IF_MACSEC: If specified, then the connection is created on MACsec
1505 # capable hardware ports. If not specified, non-MACsec capable ports will
1506 # also be considered.
1507 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
1508 # exclusively for Cross-Site Networking. The connection can not be used for
1509 # Cross-Site Networking unless this feature is specified.
1510 &quot;A String&quot;,
1511 ],
1512 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
1513 # customer.
1514 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1515 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1516 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1517 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
1518 # take one of the following values:
1519 #
1520 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
1521 # Attachments may be provisioned on this Interconnect.
1522 # - UNPROVISIONED: The Interconnect has not completed turnup. No
1523 # attachments may be provisioned on this Interconnect.
1524 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
1525 # No attachments may be provisioned or updated on this
1526 # Interconnect.
1527 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
1528 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
1529 # configured to use this Interconnect. The Interconnect cannot be deleted if
1530 # this list is non-empty.
1531 &quot;A String&quot;,
1532 ],
1533 }
1534
1535 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1536 that if you must retry your request, the server will know to ignore the
1537 request if it has already been completed.
1538
1539 For example, consider a situation where you make an initial request and
1540 the request times out. If you make the request again with the same
1541 request ID, the server can check if original operation with the same
1542 request ID was received, and if so, will ignore the second request. This
1543 prevents clients from accidentally creating duplicate commitments.
1544
1545 The request ID must be
1546 a valid UUID with the exception that zero UUID is not supported
1547 (00000000-0000-0000-0000-000000000000).
1548 x__xgafv: string, V1 error format.
1549 Allowed values
1550 1 - v1 error format
1551 2 - v2 error format
1552
1553 Returns:
1554 An object of the form:
1555
1556 { # Represents an Operation resource.
1557 #
1558 # Google Compute Engine has three Operation resources:
1559 #
1560 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1561 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1562 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1563 #
1564 # You can use an operation resource to manage asynchronous API requests.
1565 # For more information, readHandling
1566 # API responses.
1567 #
1568 # Operations can be global, regional or zonal.
1569 #
1570 # - For global operations, use the `globalOperations`
1571 # resource.
1572 # - For regional operations, use the
1573 # `regionOperations` resource.
1574 # - For zonal operations, use
1575 # the `zoneOperations` resource.
1576 #
1577 #
1578 #
1579 # For more information, read
1580 # Global, Regional, and Zonal Resources.
1581 #
1582 # Note that completed Operation resources have a limited
1583 # retention period.
1584 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1585 # Not present otherwise.
1586 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1587 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1588 # set when the operation is created.
1589 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1590 # text format.
1591 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1592 # this field will be populated.
1593 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1594 # operation.
1595 {
1596 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1597 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1598 # details. There is a set of defined message types to use for providing
1599 # details.The syntax depends on the error code. For example,
1600 # QuotaExceededInfo will have details when the error code is
1601 # QUOTA_EXCEEDED.
1602 {
1603 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1604 #
1605 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1606 # is not enabled:
1607 #
1608 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1609 # &quot;domain&quot;: &quot;googleapis.com&quot;
1610 # &quot;metadata&quot;: {
1611 # &quot;resource&quot;: &quot;projects/123&quot;,
1612 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1613 # }
1614 # }
1615 #
1616 # This response indicates that the pubsub.googleapis.com API is not enabled.
1617 #
1618 # Example of an error that is returned when attempting to create a Spanner
1619 # instance in a region that is out of stock:
1620 #
1621 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1622 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1623 # &quot;metadata&quot;: {
1624 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1625 # }
1626 # }
1627 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1628 # is typically the registered service name of the tool or product that
1629 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1630 # generated by some common infrastructure, the error domain must be a
1631 # globally unique value that identifies the infrastructure. For Google API
1632 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1633 &quot;metadatas&quot;: { # Additional structured details about this error.
1634 #
1635 # Keys must match a regular expression of `a-z+` but should
1636 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1637 # length. When identifying the current value of an exceeded limit, the units
1638 # should be contained in the key, not the value. For example, rather than
1639 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1640 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1641 # instances that can be created in a single (batch) request.
1642 &quot;a_key&quot;: &quot;A String&quot;,
1643 },
1644 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1645 # proximate cause of the error. Error reasons are unique within a particular
1646 # domain of errors. This should be at most 63 characters and match a
1647 # regular expression of `A-Z+[A-Z0-9]`, which represents
1648 # UPPER_SNAKE_CASE.
1649 },
1650 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1651 #
1652 # For example, if a quota check failed with an error indicating the calling
1653 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1654 # directly to the right place in the developer console to flip the bit.
1655 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1656 { # Describes a URL link.
1657 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1658 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1659 },
1660 ],
1661 },
1662 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1663 # which can be attached to an RPC error.
1664 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1665 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1666 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1667 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1668 },
1669 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1670 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1671 &quot;a_key&quot;: &quot;A String&quot;,
1672 },
1673 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1674 # type or metric.
1675 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1676 # or metric.
1677 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1678 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1679 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1680 },
1681 },
1682 ],
1683 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1684 # This property is optional.
1685 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1686 },
1687 ],
1688 },
1689 &quot;getVersionOperationMetadata&quot;: {
1690 &quot;inlineSbomInfo&quot;: {
1691 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1692 # appropriate identifiers.
1693 &quot;a_key&quot;: &quot;A String&quot;,
1694 },
1695 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1696 # identifiers.
1697 &quot;a_key&quot;: &quot;A String&quot;,
1698 },
1699 },
1700 },
1701 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1702 # message that was returned, such as `NOT FOUND`.
1703 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1704 # status code that was returned. For example, a `404` means the
1705 # resource was not found.
1706 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1707 # defined by the server.
1708 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1709 # This value is inRFC3339
1710 # text format.
1711 &quot;instancesBulkInsertOperationMetadata&quot;: {
1712 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1713 # Example key: zones/us-central1-a
1714 &quot;a_key&quot;: {
1715 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1716 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1717 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1718 # error.
1719 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1720 # if the flow is rolling forward or rolling back.
1721 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1722 },
1723 },
1724 },
1725 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1726 # Operation resources.
1727 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1728 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1729 # group of operations results from a `bulkInsert` API request.
1730 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1731 # `update`, or `delete`, and so on.
1732 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1733 # There is no requirement that this be linear or support any granularity of
1734 # operations. This should not be used to guess when the operation will be
1735 # complete. This number should monotonically increase as the operation
1736 # progresses.
1737 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1738 # applicable when performing regional operations.
1739 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1740 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1741 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1742 # this field will contain information on all underlying zonal actions and
1743 # their state.
1744 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1745 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1746 # Example key: zones/us-central1-a
1747 &quot;a_key&quot;: {
1748 &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
1749 # populated.
1750 # different programming environments, including REST APIs and RPC APIs. It is
1751 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1752 # three pieces of data: error code, error message, and error details.
1753 #
1754 # You can find out more about this error model and how to work with it in the
1755 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1756 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1757 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1758 # message types for APIs to use.
1759 {
1760 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1761 },
1762 ],
1763 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1764 # user-facing error message should be localized and sent in the
1765 # google.rpc.Status.details field, or localized by the client.
1766 },
1767 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1768 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1769 },
1770 },
1771 },
1772 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1773 # This value is inRFC3339
1774 # text format.
1775 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1776 # following:
1777 # `PENDING`, `RUNNING`, or `DONE`.
1778 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1779 # operation.
1780 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1781 # of the target resource.
1782 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1783 # operations related to creating a snapshot, this points to the disk
1784 # that the snapshot was created from.
1785 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1786 # `[email protected]` or
1787 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1788 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1789 # operation, this field will be populated.
1790 {
1791 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1792 # Engine returns NO_RESULTS_ON_PAGE if there
1793 # are no results in the response.
1794 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1795 # value format. For example:
1796 #
1797 # &quot;data&quot;: [
1798 # {
1799 # &quot;key&quot;: &quot;scope&quot;,
1800 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1801 # }
1802 {
1803 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1804 # returned. For example, for warnings where there are no results in a list
1805 # request for a particular zone, this key might be scope and
1806 # the key value might be the zone name. Other examples might be a key
1807 # indicating a deprecated resource and a suggested replacement, or a
1808 # warning about invalid network settings (for example, if an instance
1809 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1810 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1811 },
1812 ],
1813 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1814 },
1815 ],
1816 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1817 # applicable when performing per-zone operations.
1818 }</pre>
1819 </div>
1820
1821 <div class="method">
1822 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1823 <pre>Retrieves the list of Interconnects available to the specified project.
1824
1825 Args:
1826 project: string, Project ID for this request. (required)
1827 filter: string, A filter expression that filters resources listed in the response. Most
1828 Compute resources support two types of filter expressions:
1829 expressions that support regular expressions and expressions that follow
1830 API improvement proposal AIP-160.
1831 These two types of filter expressions cannot be mixed in one request.
1832
1833 If you want to use AIP-160, your expression must specify the field name, an
1834 operator, and the value that you want to use for filtering. The value
1835 must be a string, a number, or a boolean. The operator
1836 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1837
1838 For example, if you are filtering Compute Engine instances, you can
1839 exclude instances named `example-instance` by specifying
1840 `name != example-instance`.
1841
1842 The `:*` comparison can be used to test whether a key has been defined.
1843 For example, to find all objects with `owner` label use:
1844 ```
1845 labels.owner:*
1846 ```
1847
1848 You can also filter nested fields. For example, you could specify
1849 `scheduling.automaticRestart = false` to include instances only
1850 if they are not scheduled for automatic restarts. You can use filtering
1851 on nested fields to filter based onresource labels.
1852
1853 To filter on multiple expressions, provide each separate expression within
1854 parentheses. For example:
1855 ```
1856 (scheduling.automaticRestart = true)
1857 (cpuPlatform = &quot;Intel Skylake&quot;)
1858 ```
1859 By default, each expression is an `AND` expression. However, you
1860 can include `AND` and `OR` expressions explicitly.
1861 For example:
1862 ```
1863 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1864 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1865 (scheduling.automaticRestart = true)
1866 ```
1867
1868 If you want to use a regular expression, use the `eq` (equal) or `ne`
1869 (not equal) operator against a single un-parenthesized expression with or
1870 without quotes or against multiple parenthesized expressions. Examples:
1871
1872 `fieldname eq unquoted literal`
1873 `fieldname eq &#x27;single quoted literal&#x27;`
1874 `fieldname eq &quot;double quoted literal&quot;`
1875 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1876
1877 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1878 The literal value must match the entire field.
1879
1880 For example, to filter for instances that do not end with name &quot;instance&quot;,
1881 you would use `name ne .*instance`.
1882
1883 You cannot combine constraints on multiple fields using regular
1884 expressions.
1885 maxResults: integer, The maximum number of results per page that should be returned.
1886 If the number of available results is larger than `maxResults`,
1887 Compute Engine returns a `nextPageToken` that can be used to get
1888 the next page of results in subsequent list requests. Acceptable values are
1889 `0` to `500`, inclusive. (Default: `500`)
1890 orderBy: string, Sorts list results by a certain order. By default, results
1891 are returned in alphanumerical order based on the resource name.
1892
1893 You can also sort results in descending order based on the creation
1894 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1895 results based on the `creationTimestamp` field in
1896 reverse chronological order (newest result first). Use this to sort
1897 resources like operations so that the newest operation is returned first.
1898
1899 Currently, only sorting by `name` or
1900 `creationTimestamp desc` is supported.
1901 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1902 `nextPageToken` returned by a previous list request to get
1903 the next page of results.
1904 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1905 of failure. The default value is false.
1906
1907 For example, when partial success behavior is enabled, aggregatedList for a
1908 single zone scope either returns all resources in the zone or no resources,
1909 with an error code.
1910 x__xgafv: string, V1 error format.
1911 Allowed values
1912 1 - v1 error format
1913 2 - v2 error format
1914
1915 Returns:
1916 An object of the form:
1917
1918 { # Response to the list request, and contains a list of interconnects.
1919 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1920 &quot;items&quot;: [ # A list of Interconnect resources.
1921 { # Represents an Interconnect resource.
1922 #
1923 # An Interconnect resource is a dedicated connection between the Google
1924 # Cloud network and your on-premises network. For more information, read the
1925 # Dedicated Interconnect Overview.
1926 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
1927 # Interconnect.
1928 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
1929 # Interconnect is functional and can carry traffic.
1930 # When set to false, no packets can be carried over the interconnect and
1931 # no BGP routes are exchanged over it. By default, the status is set to true.
1932 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
1933 # Interconnect.
1934 # Interconnect.
1935 &quot;bandwidthPercentagePolicy&quot;: {
1936 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
1937 # type Bandwidth Percent.
1938 { # Specify bandwidth percentages [1-100] for various traffic classes in
1939 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1940 # All traffic classes must have a percentage value specified.
1941 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1942 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1943 },
1944 ],
1945 },
1946 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
1947 # Interconnect.
1948 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
1949 # applied in conjunction with StrictPriorityPolicy or
1950 # BandwidthPercentagePolicy.
1951 { # Specify bandwidth percentages [1-100] for various traffic classes in
1952 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1953 # All traffic classes must have a percentage value specified.
1954 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1955 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1956 },
1957 ],
1958 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
1959 },
1960 },
1961 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
1962 # which can take one of the following values:
1963 #
1964 # - IF_MACSEC: If present, then the Interconnect connection is
1965 # provisioned on MACsec capable hardware ports. If not present, then the
1966 # Interconnect connection is provisioned on non-MACsec capable ports. Any
1967 # attempt to enable MACsec will fail.
1968 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
1969 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
1970 # VLAN attachments will fail. If not present, then the Interconnect
1971 # connection is not provisioned for Cross-Site Networking. Any attempt to use
1972 # it for Cross-Site Networking will fail.
1973 &quot;A String&quot;,
1974 ],
1975 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
1976 # circuits in this LAG.
1977 { # Describes a single physical circuit between the Customer and Google.
1978 # CircuitInfo objects are created by Google, so all fields are output only.
1979 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
1980 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
1981 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
1982 # provided by Google to the customer in the LOA.
1983 },
1984 ],
1985 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1986 # text format.
1987 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
1988 # authorized to request a crossconnect.
1989 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1990 # create the resource.
1991 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
1992 # this connection is to be provisioned. By default it will be the same as the
1993 # location field.
1994 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
1995 { # Description of a planned outage on this Interconnect.
1996 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
1997 # IDs that will be affected.
1998 &quot;A String&quot;,
1999 ],
2000 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
2001 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
2002 # epoch).
2003 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
2004 # values:
2005 #
2006 # - OUTAGE: The Interconnect may be completely out of service for
2007 # some or all of the specified window.
2008 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
2009 # should remain up, but with reduced bandwidth.
2010 #
2011 #
2012 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
2013 # deprecated in favor of the unprefixed values.
2014 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
2015 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
2016 # value:
2017 #
2018 # - GOOGLE: this notification as generated by Google.
2019 #
2020 #
2021 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
2022 # GOOGLE.
2023 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
2024 # epoch).
2025 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
2026 #
2027 # - ACTIVE: This outage notification is active. The event could be in
2028 # the past, present, or future. See start_time and end_time for
2029 # scheduling.
2030 # - CANCELLED: The outage associated with this notification was cancelled
2031 # before the outage was due to start.
2032 # - COMPLETED: The outage associated with this notification is complete.
2033 #
2034 #
2035 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
2036 # deprecated in favor of the unprefixed values.
2037 },
2038 ],
2039 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
2040 # link. This can be used only for ping tests.
2041 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
2042 # with Google or otherwise to debug backend connectivity issues.
2043 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2044 # defined by the server.
2045 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
2046 # to use this Interconnect.
2047 &quot;A String&quot;,
2048 ],
2049 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
2050 # Order is arbitrary and items are unique.
2051 &quot;A String&quot;,
2052 ],
2053 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
2054 #
2055 # - PARTNER: A partner-managed interconnection shared between customers
2056 # though a partner.
2057 # - DEDICATED: A dedicated physical interconnection with the
2058 # customer.
2059 #
2060 #
2061 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
2062 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
2063 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
2064 # is essentially a hash of the labels set used for optimistic locking. The
2065 # fingerprint is initially generated by Compute Engine and changes after
2066 # every request to modify or update labels. You must always provide an
2067 # up-to-date fingerprint hash in order to update or change labels,
2068 # otherwise the request will fail with error412 conditionNotMet.
2069 #
2070 # To see the latest fingerprint, make a get() request to
2071 # retrieve an Interconnect.
2072 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
2073 # Label values may be empty.
2074 &quot;a_key&quot;: &quot;A String&quot;,
2075 },
2076 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
2077 #
2078 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
2079 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
2080 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
2081 #
2082 #
2083 # Note that this field indicates the speed of each of
2084 # the links in the bundle, not the speed of the entire bundle.
2085 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
2086 # connection is to be provisioned.
2087 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
2088 # Cloud Interconnect connection between Google and your on-premises router.
2089 # (MACsec) on this Cloud Interconnect connection between Google and your
2090 # on-premises router.
2091 &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
2092 # router to fallback to cleartext traffic if the MKA session cannot be
2093 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
2094 # MKA session cannot be established with your router.
2095 &quot;interconnectKeyGroup&quot;: &quot;A String&quot;, # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the
2096 # format:
2097 # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}.
2098 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
2099 # along with their start times. A MACsec CKN/CAK is generated for each
2100 # key in the key chain. Google router automatically picks the key with
2101 # the most recent startTime when establishing or re-establishing a MACsec
2102 # secure link.
2103 { # Describes a pre-shared key used to setup MACsec in static connectivity
2104 # association key (CAK) mode.
2105 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
2106 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2107 # characters long and match the regular expression
2108 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2109 # lowercase letter, and all following characters must be a dash,
2110 # lowercase letter, or digit, except the last character, which cannot be
2111 # a dash.
2112 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
2113 # valid. startTime can be in the future. If the keychain has a single
2114 # key, startTime can be omitted. If the keychain has multiple keys,
2115 # startTime is mandatory for each key. The start times of keys must be in
2116 # increasing order. The start times of two consecutive keys must be
2117 # at least 6 hours apart.
2118 },
2119 ],
2120 },
2121 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
2122 # fails if the MACsec object is not specified.
2123 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2124 # The name must be 1-63 characters long, and comply withRFC1035.
2125 # Specifically, the name must be 1-63 characters long and match the regular
2126 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2127 # character must be a lowercase letter, and all following characters must be
2128 # a dash, lowercase letter, or digit, except the last character, which cannot
2129 # be a dash.
2130 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
2131 # notifications regarding this Interconnect. If specified, this will be used
2132 # for notifications in addition to all other forms described, such as
2133 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
2134 # required for users who sign up for Cloud Interconnect using
2135 # workforce identity federation.
2136 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
2137 # which can take one of the following values:
2138 #
2139 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
2140 # use. Attachments may be provisioned on this Interconnect.
2141 #
2142 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
2143 # attachments may be provisioned on this Interconnect.
2144 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
2145 # maintenance. No attachments may be provisioned or updated on this
2146 # Interconnect.
2147 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2148 # as part of resource payload.
2149 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2150 # Tag keys and values have the same definition as resource
2151 # manager tags. The field is allowed for INSERT
2152 # only. The keys/values to set on the resource should be specified in
2153 # either ID { : } or Namespaced format
2154 # { : }.
2155 # For example the following are valid inputs:
2156 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2157 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2158 # Note:
2159 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2160 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2161 # * Inconsistent format is not supported. For instance:
2162 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2163 &quot;a_key&quot;: &quot;A String&quot;,
2164 },
2165 },
2166 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
2167 # Interconnect link. The customer should configure this IP address during
2168 # turnup when prompted by Google NOC. This can be used only for ping tests.
2169 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
2170 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
2171 # location outside of Google&#x27;s network that the interconnect is connected to.
2172 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
2173 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
2174 # Interconnect connection, which can take one of the following values:
2175 #
2176 # - IF_MACSEC: If specified, then the connection is created on MACsec
2177 # capable hardware ports. If not specified, non-MACsec capable ports will
2178 # also be considered.
2179 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
2180 # exclusively for Cross-Site Networking. The connection can not be used for
2181 # Cross-Site Networking unless this feature is specified.
2182 &quot;A String&quot;,
2183 ],
2184 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
2185 # customer.
2186 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2187 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2188 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2189 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
2190 # take one of the following values:
2191 #
2192 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
2193 # Attachments may be provisioned on this Interconnect.
2194 # - UNPROVISIONED: The Interconnect has not completed turnup. No
2195 # attachments may be provisioned on this Interconnect.
2196 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
2197 # No attachments may be provisioned or updated on this
2198 # Interconnect.
2199 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
2200 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
2201 # configured to use this Interconnect. The Interconnect cannot be deleted if
2202 # this list is non-empty.
2203 &quot;A String&quot;,
2204 ],
2205 },
2206 ],
2207 &quot;kind&quot;: &quot;compute#interconnectList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectList for lists of interconnects.
2208 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2209 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2210 # the query parameter pageToken in the next list request.
2211 # Subsequent list requests will have their own nextPageToken to
2212 # continue paging through the results.
2213 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2214 &quot;warning&quot;: { # [Output Only] Informational warning message.
2215 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2216 # Engine returns NO_RESULTS_ON_PAGE if there
2217 # are no results in the response.
2218 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2219 # value format. For example:
2220 #
2221 # &quot;data&quot;: [
2222 # {
2223 # &quot;key&quot;: &quot;scope&quot;,
2224 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2225 # }
2226 {
2227 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2228 # returned. For example, for warnings where there are no results in a list
2229 # request for a particular zone, this key might be scope and
2230 # the key value might be the zone name. Other examples might be a key
2231 # indicating a deprecated resource and a suggested replacement, or a
2232 # warning about invalid network settings (for example, if an instance
2233 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2234 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2235 },
2236 ],
2237 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2238 },
2239 }</pre>
2240 </div>
2241
2242 <div class="method">
2243 <code class="details" id="list_next">list_next()</code>
2244 <pre>Retrieves the next page of results.
2245
2246 Args:
2247 previous_request: The request for the previous page. (required)
2248 previous_response: The response from the request for the previous page. (required)
2249
2250 Returns:
2251 A request object that you can call &#x27;execute()&#x27; on to request the next
2252 page. Returns None if there are no more items in the collection.
2253 </pre>
2254 </div>
2255
2256 <div class="method">
2257 <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</code>
2258 <pre>Updates the specified Interconnect with the data included in the request.
2259 This method supportsPATCH
2260 semantics and uses theJSON merge
2261 patch format and processing rules.
2262
2263 Args:
2264 project: string, Project ID for this request. (required)
2265 interconnect: string, Name of the interconnect to update. (required)
2266 body: object, The request body.
2267 The object takes the form of:
2268
2269 { # Represents an Interconnect resource.
2270 #
2271 # An Interconnect resource is a dedicated connection between the Google
2272 # Cloud network and your on-premises network. For more information, read the
2273 # Dedicated Interconnect Overview.
2274 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
2275 # Interconnect.
2276 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
2277 # Interconnect is functional and can carry traffic.
2278 # When set to false, no packets can be carried over the interconnect and
2279 # no BGP routes are exchanged over it. By default, the status is set to true.
2280 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
2281 # Interconnect.
2282 # Interconnect.
2283 &quot;bandwidthPercentagePolicy&quot;: {
2284 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
2285 # type Bandwidth Percent.
2286 { # Specify bandwidth percentages [1-100] for various traffic classes in
2287 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
2288 # All traffic classes must have a percentage value specified.
2289 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
2290 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
2291 },
2292 ],
2293 },
2294 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
2295 # Interconnect.
2296 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
2297 # applied in conjunction with StrictPriorityPolicy or
2298 # BandwidthPercentagePolicy.
2299 { # Specify bandwidth percentages [1-100] for various traffic classes in
2300 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
2301 # All traffic classes must have a percentage value specified.
2302 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
2303 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
2304 },
2305 ],
2306 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
2307 },
2308 },
2309 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
2310 # which can take one of the following values:
2311 #
2312 # - IF_MACSEC: If present, then the Interconnect connection is
2313 # provisioned on MACsec capable hardware ports. If not present, then the
2314 # Interconnect connection is provisioned on non-MACsec capable ports. Any
2315 # attempt to enable MACsec will fail.
2316 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
2317 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
2318 # VLAN attachments will fail. If not present, then the Interconnect
2319 # connection is not provisioned for Cross-Site Networking. Any attempt to use
2320 # it for Cross-Site Networking will fail.
2321 &quot;A String&quot;,
2322 ],
2323 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
2324 # circuits in this LAG.
2325 { # Describes a single physical circuit between the Customer and Google.
2326 # CircuitInfo objects are created by Google, so all fields are output only.
2327 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
2328 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
2329 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
2330 # provided by Google to the customer in the LOA.
2331 },
2332 ],
2333 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2334 # text format.
2335 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
2336 # authorized to request a crossconnect.
2337 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2338 # create the resource.
2339 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
2340 # this connection is to be provisioned. By default it will be the same as the
2341 # location field.
2342 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
2343 { # Description of a planned outage on this Interconnect.
2344 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
2345 # IDs that will be affected.
2346 &quot;A String&quot;,
2347 ],
2348 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
2349 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
2350 # epoch).
2351 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
2352 # values:
2353 #
2354 # - OUTAGE: The Interconnect may be completely out of service for
2355 # some or all of the specified window.
2356 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
2357 # should remain up, but with reduced bandwidth.
2358 #
2359 #
2360 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
2361 # deprecated in favor of the unprefixed values.
2362 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
2363 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
2364 # value:
2365 #
2366 # - GOOGLE: this notification as generated by Google.
2367 #
2368 #
2369 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
2370 # GOOGLE.
2371 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
2372 # epoch).
2373 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
2374 #
2375 # - ACTIVE: This outage notification is active. The event could be in
2376 # the past, present, or future. See start_time and end_time for
2377 # scheduling.
2378 # - CANCELLED: The outage associated with this notification was cancelled
2379 # before the outage was due to start.
2380 # - COMPLETED: The outage associated with this notification is complete.
2381 #
2382 #
2383 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
2384 # deprecated in favor of the unprefixed values.
2385 },
2386 ],
2387 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
2388 # link. This can be used only for ping tests.
2389 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
2390 # with Google or otherwise to debug backend connectivity issues.
2391 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2392 # defined by the server.
2393 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
2394 # to use this Interconnect.
2395 &quot;A String&quot;,
2396 ],
2397 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
2398 # Order is arbitrary and items are unique.
2399 &quot;A String&quot;,
2400 ],
2401 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
2402 #
2403 # - PARTNER: A partner-managed interconnection shared between customers
2404 # though a partner.
2405 # - DEDICATED: A dedicated physical interconnection with the
2406 # customer.
2407 #
2408 #
2409 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
2410 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
2411 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
2412 # is essentially a hash of the labels set used for optimistic locking. The
2413 # fingerprint is initially generated by Compute Engine and changes after
2414 # every request to modify or update labels. You must always provide an
2415 # up-to-date fingerprint hash in order to update or change labels,
2416 # otherwise the request will fail with error412 conditionNotMet.
2417 #
2418 # To see the latest fingerprint, make a get() request to
2419 # retrieve an Interconnect.
2420 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
2421 # Label values may be empty.
2422 &quot;a_key&quot;: &quot;A String&quot;,
2423 },
2424 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
2425 #
2426 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
2427 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
2428 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
2429 #
2430 #
2431 # Note that this field indicates the speed of each of
2432 # the links in the bundle, not the speed of the entire bundle.
2433 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
2434 # connection is to be provisioned.
2435 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
2436 # Cloud Interconnect connection between Google and your on-premises router.
2437 # (MACsec) on this Cloud Interconnect connection between Google and your
2438 # on-premises router.
2439 &quot;failOpen&quot;: True or False, # If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google
2440 # router to fallback to cleartext traffic if the MKA session cannot be
2441 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
2442 # MKA session cannot be established with your router.
2443 &quot;interconnectKeyGroup&quot;: &quot;A String&quot;, # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the
2444 # format:
2445 # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}.
2446 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
2447 # along with their start times. A MACsec CKN/CAK is generated for each
2448 # key in the key chain. Google router automatically picks the key with
2449 # the most recent startTime when establishing or re-establishing a MACsec
2450 # secure link.
2451 { # Describes a pre-shared key used to setup MACsec in static connectivity
2452 # association key (CAK) mode.
2453 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
2454 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2455 # characters long and match the regular expression
2456 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2457 # lowercase letter, and all following characters must be a dash,
2458 # lowercase letter, or digit, except the last character, which cannot be
2459 # a dash.
2460 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
2461 # valid. startTime can be in the future. If the keychain has a single
2462 # key, startTime can be omitted. If the keychain has multiple keys,
2463 # startTime is mandatory for each key. The start times of keys must be in
2464 # increasing order. The start times of two consecutive keys must be
2465 # at least 6 hours apart.
2466 },
2467 ],
2468 },
2469 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
2470 # fails if the MACsec object is not specified.
2471 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2472 # The name must be 1-63 characters long, and comply withRFC1035.
2473 # Specifically, the name must be 1-63 characters long and match the regular
2474 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2475 # character must be a lowercase letter, and all following characters must be
2476 # a dash, lowercase letter, or digit, except the last character, which cannot
2477 # be a dash.
2478 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
2479 # notifications regarding this Interconnect. If specified, this will be used
2480 # for notifications in addition to all other forms described, such as
2481 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
2482 # required for users who sign up for Cloud Interconnect using
2483 # workforce identity federation.
2484 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
2485 # which can take one of the following values:
2486 #
2487 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
2488 # use. Attachments may be provisioned on this Interconnect.
2489 #
2490 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
2491 # attachments may be provisioned on this Interconnect.
2492 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
2493 # maintenance. No attachments may be provisioned or updated on this
2494 # Interconnect.
2495 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2496 # as part of resource payload.
2497 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2498 # Tag keys and values have the same definition as resource
2499 # manager tags. The field is allowed for INSERT
2500 # only. The keys/values to set on the resource should be specified in
2501 # either ID { : } or Namespaced format
2502 # { : }.
2503 # For example the following are valid inputs:
2504 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2505 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2506 # Note:
2507 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2508 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2509 # * Inconsistent format is not supported. For instance:
2510 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2511 &quot;a_key&quot;: &quot;A String&quot;,
2512 },
2513 },
2514 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
2515 # Interconnect link. The customer should configure this IP address during
2516 # turnup when prompted by Google NOC. This can be used only for ping tests.
2517 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
2518 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
2519 # location outside of Google&#x27;s network that the interconnect is connected to.
2520 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
2521 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
2522 # Interconnect connection, which can take one of the following values:
2523 #
2524 # - IF_MACSEC: If specified, then the connection is created on MACsec
2525 # capable hardware ports. If not specified, non-MACsec capable ports will
2526 # also be considered.
2527 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
2528 # exclusively for Cross-Site Networking. The connection can not be used for
2529 # Cross-Site Networking unless this feature is specified.
2530 &quot;A String&quot;,
2531 ],
2532 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
2533 # customer.
2534 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2535 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2536 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2537 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
2538 # take one of the following values:
2539 #
2540 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
2541 # Attachments may be provisioned on this Interconnect.
2542 # - UNPROVISIONED: The Interconnect has not completed turnup. No
2543 # attachments may be provisioned on this Interconnect.
2544 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
2545 # No attachments may be provisioned or updated on this
2546 # Interconnect.
2547 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
2548 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
2549 # configured to use this Interconnect. The Interconnect cannot be deleted if
2550 # this list is non-empty.
2551 &quot;A String&quot;,
2552 ],
2553 }
2554
2555 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2556 that if you must retry your request, the server will know to ignore the
2557 request if it has already been completed.
2558
2559 For example, consider a situation where you make an initial request and
2560 the request times out. If you make the request again with the same
2561 request ID, the server can check if original operation with the same
2562 request ID was received, and if so, will ignore the second request. This
2563 prevents clients from accidentally creating duplicate commitments.
2564
2565 The request ID must be
2566 a valid UUID with the exception that zero UUID is not supported
2567 (00000000-0000-0000-0000-000000000000).
2568 x__xgafv: string, V1 error format.
2569 Allowed values
2570 1 - v1 error format
2571 2 - v2 error format
2572
2573 Returns:
2574 An object of the form:
2575
2576 { # Represents an Operation resource.
2577 #
2578 # Google Compute Engine has three Operation resources:
2579 #
2580 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2581 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2582 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2583 #
2584 # You can use an operation resource to manage asynchronous API requests.
2585 # For more information, readHandling
2586 # API responses.
2587 #
2588 # Operations can be global, regional or zonal.
2589 #
2590 # - For global operations, use the `globalOperations`
2591 # resource.
2592 # - For regional operations, use the
2593 # `regionOperations` resource.
2594 # - For zonal operations, use
2595 # the `zoneOperations` resource.
2596 #
2597 #
2598 #
2599 # For more information, read
2600 # Global, Regional, and Zonal Resources.
2601 #
2602 # Note that completed Operation resources have a limited
2603 # retention period.
2604 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2605 # Not present otherwise.
2606 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2607 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2608 # set when the operation is created.
2609 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2610 # text format.
2611 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2612 # this field will be populated.
2613 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2614 # operation.
2615 {
2616 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2617 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2618 # details. There is a set of defined message types to use for providing
2619 # details.The syntax depends on the error code. For example,
2620 # QuotaExceededInfo will have details when the error code is
2621 # QUOTA_EXCEEDED.
2622 {
2623 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2624 #
2625 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2626 # is not enabled:
2627 #
2628 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2629 # &quot;domain&quot;: &quot;googleapis.com&quot;
2630 # &quot;metadata&quot;: {
2631 # &quot;resource&quot;: &quot;projects/123&quot;,
2632 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2633 # }
2634 # }
2635 #
2636 # This response indicates that the pubsub.googleapis.com API is not enabled.
2637 #
2638 # Example of an error that is returned when attempting to create a Spanner
2639 # instance in a region that is out of stock:
2640 #
2641 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2642 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2643 # &quot;metadata&quot;: {
2644 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2645 # }
2646 # }
2647 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2648 # is typically the registered service name of the tool or product that
2649 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2650 # generated by some common infrastructure, the error domain must be a
2651 # globally unique value that identifies the infrastructure. For Google API
2652 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2653 &quot;metadatas&quot;: { # Additional structured details about this error.
2654 #
2655 # Keys must match a regular expression of `a-z+` but should
2656 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2657 # length. When identifying the current value of an exceeded limit, the units
2658 # should be contained in the key, not the value. For example, rather than
2659 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2660 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2661 # instances that can be created in a single (batch) request.
2662 &quot;a_key&quot;: &quot;A String&quot;,
2663 },
2664 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2665 # proximate cause of the error. Error reasons are unique within a particular
2666 # domain of errors. This should be at most 63 characters and match a
2667 # regular expression of `A-Z+[A-Z0-9]`, which represents
2668 # UPPER_SNAKE_CASE.
2669 },
2670 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2671 #
2672 # For example, if a quota check failed with an error indicating the calling
2673 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2674 # directly to the right place in the developer console to flip the bit.
2675 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2676 { # Describes a URL link.
2677 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2678 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2679 },
2680 ],
2681 },
2682 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2683 # which can be attached to an RPC error.
2684 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2685 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2686 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2687 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2688 },
2689 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2690 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2691 &quot;a_key&quot;: &quot;A String&quot;,
2692 },
2693 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2694 # type or metric.
2695 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2696 # or metric.
2697 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2698 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2699 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2700 },
2701 },
2702 ],
2703 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2704 # This property is optional.
2705 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2706 },
2707 ],
2708 },
2709 &quot;getVersionOperationMetadata&quot;: {
2710 &quot;inlineSbomInfo&quot;: {
2711 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2712 # appropriate identifiers.
2713 &quot;a_key&quot;: &quot;A String&quot;,
2714 },
2715 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2716 # identifiers.
2717 &quot;a_key&quot;: &quot;A String&quot;,
2718 },
2719 },
2720 },
2721 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2722 # message that was returned, such as `NOT FOUND`.
2723 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2724 # status code that was returned. For example, a `404` means the
2725 # resource was not found.
2726 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2727 # defined by the server.
2728 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2729 # This value is inRFC3339
2730 # text format.
2731 &quot;instancesBulkInsertOperationMetadata&quot;: {
2732 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2733 # Example key: zones/us-central1-a
2734 &quot;a_key&quot;: {
2735 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2736 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2737 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2738 # error.
2739 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2740 # if the flow is rolling forward or rolling back.
2741 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2742 },
2743 },
2744 },
2745 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2746 # Operation resources.
2747 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2748 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2749 # group of operations results from a `bulkInsert` API request.
2750 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2751 # `update`, or `delete`, and so on.
2752 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2753 # There is no requirement that this be linear or support any granularity of
2754 # operations. This should not be used to guess when the operation will be
2755 # complete. This number should monotonically increase as the operation
2756 # progresses.
2757 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2758 # applicable when performing regional operations.
2759 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2760 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2761 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2762 # this field will contain information on all underlying zonal actions and
2763 # their state.
2764 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2765 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2766 # Example key: zones/us-central1-a
2767 &quot;a_key&quot;: {
2768 &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
2769 # populated.
2770 # different programming environments, including REST APIs and RPC APIs. It is
2771 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2772 # three pieces of data: error code, error message, and error details.
2773 #
2774 # You can find out more about this error model and how to work with it in the
2775 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2776 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2777 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2778 # message types for APIs to use.
2779 {
2780 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2781 },
2782 ],
2783 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2784 # user-facing error message should be localized and sent in the
2785 # google.rpc.Status.details field, or localized by the client.
2786 },
2787 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2788 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2789 },
2790 },
2791 },
2792 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2793 # This value is inRFC3339
2794 # text format.
2795 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2796 # following:
2797 # `PENDING`, `RUNNING`, or `DONE`.
2798 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2799 # operation.
2800 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2801 # of the target resource.
2802 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2803 # operations related to creating a snapshot, this points to the disk
2804 # that the snapshot was created from.
2805 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2806 # `[email protected]` or
2807 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2808 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2809 # operation, this field will be populated.
2810 {
2811 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2812 # Engine returns NO_RESULTS_ON_PAGE if there
2813 # are no results in the response.
2814 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2815 # value format. For example:
2816 #
2817 # &quot;data&quot;: [
2818 # {
2819 # &quot;key&quot;: &quot;scope&quot;,
2820 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2821 # }
2822 {
2823 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2824 # returned. For example, for warnings where there are no results in a list
2825 # request for a particular zone, this key might be scope and
2826 # the key value might be the zone name. Other examples might be a key
2827 # indicating a deprecated resource and a suggested replacement, or a
2828 # warning about invalid network settings (for example, if an instance
2829 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2830 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2831 },
2832 ],
2833 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2834 },
2835 ],
2836 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2837 # applicable when performing per-zone operations.
2838 }</pre>
2839 </div>
2840
2841 <div class="method">
2842 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
2843 <pre>Sets the access control policy on the specified resource.
2844 Replaces any existing policy.
2845
2846 Args:
2847 project: string, Project ID for this request. (required)
2848 resource: string, Name or id of the resource for this request. (required)
2849 body: object, The request body.
2850 The object takes the form of:
2851
2852 {
2853 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
2854 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
2855 { # Associates `members`, or principals, with a `role`.
2856 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2857 #
2858 # If the condition evaluates to `true`, then this binding applies to the
2859 # current request.
2860 #
2861 # If the condition evaluates to `false`, then this binding does not apply to
2862 # the current request. However, a different role binding might grant the same
2863 # role to one or more of the principals in this binding.
2864 #
2865 # To learn which resources support conditions in their IAM policies, see the
2866 # [IAM
2867 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2868 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2869 # are documented at https://github.com/google/cel-spec.
2870 #
2871 # Example (Comparison):
2872 #
2873 # title: &quot;Summary size limit&quot;
2874 # description: &quot;Determines if a summary is less than 100 chars&quot;
2875 # expression: &quot;document.summary.size() &lt; 100&quot;
2876 #
2877 # Example (Equality):
2878 #
2879 # title: &quot;Requestor is owner&quot;
2880 # description: &quot;Determines if requestor is the document owner&quot;
2881 # expression: &quot;document.owner == request.auth.claims.email&quot;
2882 #
2883 # Example (Logic):
2884 #
2885 # title: &quot;Public documents&quot;
2886 # description: &quot;Determine whether the document should be publicly visible&quot;
2887 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2888 #
2889 # Example (Data Manipulation):
2890 #
2891 # title: &quot;Notification string&quot;
2892 # description: &quot;Create a notification string with a timestamp.&quot;
2893 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2894 #
2895 # The exact variables and functions that may be referenced within an expression
2896 # are determined by the service that evaluates it. See the service
2897 # documentation for additional information.
2898 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2899 # describes the expression, e.g. when hovered over it in a UI.
2900 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2901 # syntax.
2902 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2903 # reporting, e.g. a file name and a position in the file.
2904 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2905 # its purpose. This can be used e.g. in UIs which allow to enter the
2906 # expression.
2907 },
2908 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2909 # `members` can have the following values:
2910 #
2911 # * `allUsers`: A special identifier that represents anyone who is
2912 # on the internet; with or without a Google account.
2913 #
2914 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2915 # who is authenticated with a Google account or a service account.
2916 # Does not include identities that come from external identity providers
2917 # (IdPs) through identity federation.
2918 #
2919 # * `user:{emailid}`: An email address that represents a specific Google
2920 # account. For example, `[email protected]` .
2921 #
2922 #
2923 # * `serviceAccount:{emailid}`: An email address that represents a Google
2924 # service account. For example,
2925 # `[email protected]`.
2926 #
2927 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2928 # identifier for a
2929 # [Kubernetes service
2930 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2931 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2932 #
2933 # * `group:{emailid}`: An email address that represents a Google group.
2934 # For example, `[email protected]`.
2935 #
2936 #
2937 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2938 # users of that domain. For example, `google.com` or `example.com`.
2939 #
2940 #
2941 #
2942 #
2943 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2944 # A single identity in a workforce identity pool.
2945 #
2946 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2947 # All workforce identities in a group.
2948 #
2949 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2950 # All workforce identities with a specific attribute value.
2951 #
2952 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2953 # All identities in a workforce identity pool.
2954 #
2955 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2956 # A single identity in a workload identity pool.
2957 #
2958 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2959 # A workload identity pool group.
2960 #
2961 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2962 # All identities in a workload identity pool with a certain attribute.
2963 #
2964 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2965 # All identities in a workload identity pool.
2966 #
2967 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2968 # identifier) representing a user that has been recently deleted. For
2969 # example, `[email protected]?uid=123456789012345678901`. If the user is
2970 # recovered, this value reverts to `user:{emailid}` and the recovered user
2971 # retains the role in the binding.
2972 #
2973 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2974 # unique identifier) representing a service account that has been recently
2975 # deleted. For example,
2976 # `[email protected]?uid=123456789012345678901`.
2977 # If the service account is undeleted, this value reverts to
2978 # `serviceAccount:{emailid}` and the undeleted service account retains the
2979 # role in the binding.
2980 #
2981 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2982 # identifier) representing a Google group that has been recently
2983 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2984 # the group is recovered, this value reverts to `group:{emailid}` and the
2985 # recovered group retains the role in the binding.
2986 #
2987 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2988 # Deleted single identity in a workforce identity pool. For example,
2989 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2990 &quot;A String&quot;,
2991 ],
2992 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2993 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2994 #
2995 # For an overview of the IAM roles and permissions, see the
2996 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2997 # a list of the available pre-defined roles, see
2998 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2999 },
3000 ],
3001 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3002 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3003 &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
3004 # the policy is limited to a few 10s of KB. An empty policy is in general a
3005 # valid policy but certain services (like Projects) might reject them.
3006 # controls for Google Cloud resources.
3007 #
3008 #
3009 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3010 # `members`, or principals, to a single `role`. Principals can be user
3011 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3012 # `role` is a named list of permissions; each `role` can be an IAM predefined
3013 # role or a user-created custom role.
3014 #
3015 # For some types of Google Cloud resources, a `binding` can also specify a
3016 # `condition`, which is a logical expression that allows access to a resource
3017 # only if the expression evaluates to `true`. A condition can add constraints
3018 # based on attributes of the request, the resource, or both. To learn which
3019 # resources support conditions in their IAM policies, see the
3020 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3021 #
3022 # **JSON example:**
3023 #
3024 # ```
3025 # {
3026 # &quot;bindings&quot;: [
3027 # {
3028 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3029 # &quot;members&quot;: [
3030 # &quot;user:[email protected]&quot;,
3031 # &quot;group:[email protected]&quot;,
3032 # &quot;domain:google.com&quot;,
3033 # &quot;serviceAccount:[email protected]&quot;
3034 # ]
3035 # },
3036 # {
3037 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3038 # &quot;members&quot;: [
3039 # &quot;user:[email protected]&quot;
3040 # ],
3041 # &quot;condition&quot;: {
3042 # &quot;title&quot;: &quot;expirable access&quot;,
3043 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3044 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3045 # }
3046 # }
3047 # ],
3048 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3049 # &quot;version&quot;: 3
3050 # }
3051 # ```
3052 #
3053 # **YAML example:**
3054 #
3055 # ```
3056 # bindings:
3057 # - members:
3058 # - user:[email protected]
3059 # - group:[email protected]
3060 # - domain:google.com
3061 # - serviceAccount:[email protected]
3062 # role: roles/resourcemanager.organizationAdmin
3063 # - members:
3064 # - user:[email protected]
3065 # role: roles/resourcemanager.organizationViewer
3066 # condition:
3067 # title: expirable access
3068 # description: Does not grant access after Sep 2020
3069 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3070 # etag: BwWWja0YfJA=
3071 # version: 3
3072 # ```
3073 #
3074 # For a description of IAM and its features, see the
3075 # [IAM documentation](https://cloud.google.com/iam/docs/).
3076 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3077 { # Specifies the audit configuration for a service.
3078 # The configuration determines which permission types are logged, and what
3079 # identities, if any, are exempted from logging.
3080 # An AuditConfig must have one or more AuditLogConfigs.
3081 #
3082 # If there are AuditConfigs for both `allServices` and a specific service,
3083 # the union of the two AuditConfigs is used for that service: the log_types
3084 # specified in each AuditConfig are enabled, and the exempted_members in each
3085 # AuditLogConfig are exempted.
3086 #
3087 # Example Policy with multiple AuditConfigs:
3088 #
3089 # {
3090 # &quot;audit_configs&quot;: [
3091 # {
3092 # &quot;service&quot;: &quot;allServices&quot;,
3093 # &quot;audit_log_configs&quot;: [
3094 # {
3095 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3096 # &quot;exempted_members&quot;: [
3097 # &quot;user:[email protected]&quot;
3098 # ]
3099 # },
3100 # {
3101 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3102 # },
3103 # {
3104 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3105 # }
3106 # ]
3107 # },
3108 # {
3109 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3110 # &quot;audit_log_configs&quot;: [
3111 # {
3112 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3113 # },
3114 # {
3115 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3116 # &quot;exempted_members&quot;: [
3117 # &quot;user:[email protected]&quot;
3118 # ]
3119 # }
3120 # ]
3121 # }
3122 # ]
3123 # }
3124 #
3125 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3126 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3127 # `[email protected]` from DATA_WRITE logging.
3128 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3129 { # Provides the configuration for logging a type of permissions.
3130 # Example:
3131 #
3132 # {
3133 # &quot;audit_log_configs&quot;: [
3134 # {
3135 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3136 # &quot;exempted_members&quot;: [
3137 # &quot;user:[email protected]&quot;
3138 # ]
3139 # },
3140 # {
3141 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3142 # }
3143 # ]
3144 # }
3145 #
3146 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3147 # [email protected] from DATA_READ logging.
3148 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3149 # permission.
3150 # Follows the same format of Binding.members.
3151 &quot;A String&quot;,
3152 ],
3153 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3154 },
3155 ],
3156 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3157 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3158 # `allServices` is a special value that covers all services.
3159 },
3160 ],
3161 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3162 # may specify a `condition` that determines how and when the `bindings` are
3163 # applied. Each of the `bindings` must contain at least one principal.
3164 #
3165 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3166 # of these principals can be Google groups. Each occurrence of a principal
3167 # counts towards these limits. For example, if the `bindings` grant 50
3168 # different roles to `user:[email protected]`, and not to any other
3169 # principal, then you can add another 1,450 principals to the `bindings` in
3170 # the `Policy`.
3171 { # Associates `members`, or principals, with a `role`.
3172 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3173 #
3174 # If the condition evaluates to `true`, then this binding applies to the
3175 # current request.
3176 #
3177 # If the condition evaluates to `false`, then this binding does not apply to
3178 # the current request. However, a different role binding might grant the same
3179 # role to one or more of the principals in this binding.
3180 #
3181 # To learn which resources support conditions in their IAM policies, see the
3182 # [IAM
3183 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3184 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3185 # are documented at https://github.com/google/cel-spec.
3186 #
3187 # Example (Comparison):
3188 #
3189 # title: &quot;Summary size limit&quot;
3190 # description: &quot;Determines if a summary is less than 100 chars&quot;
3191 # expression: &quot;document.summary.size() &lt; 100&quot;
3192 #
3193 # Example (Equality):
3194 #
3195 # title: &quot;Requestor is owner&quot;
3196 # description: &quot;Determines if requestor is the document owner&quot;
3197 # expression: &quot;document.owner == request.auth.claims.email&quot;
3198 #
3199 # Example (Logic):
3200 #
3201 # title: &quot;Public documents&quot;
3202 # description: &quot;Determine whether the document should be publicly visible&quot;
3203 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3204 #
3205 # Example (Data Manipulation):
3206 #
3207 # title: &quot;Notification string&quot;
3208 # description: &quot;Create a notification string with a timestamp.&quot;
3209 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3210 #
3211 # The exact variables and functions that may be referenced within an expression
3212 # are determined by the service that evaluates it. See the service
3213 # documentation for additional information.
3214 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3215 # describes the expression, e.g. when hovered over it in a UI.
3216 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3217 # syntax.
3218 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3219 # reporting, e.g. a file name and a position in the file.
3220 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3221 # its purpose. This can be used e.g. in UIs which allow to enter the
3222 # expression.
3223 },
3224 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3225 # `members` can have the following values:
3226 #
3227 # * `allUsers`: A special identifier that represents anyone who is
3228 # on the internet; with or without a Google account.
3229 #
3230 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3231 # who is authenticated with a Google account or a service account.
3232 # Does not include identities that come from external identity providers
3233 # (IdPs) through identity federation.
3234 #
3235 # * `user:{emailid}`: An email address that represents a specific Google
3236 # account. For example, `[email protected]` .
3237 #
3238 #
3239 # * `serviceAccount:{emailid}`: An email address that represents a Google
3240 # service account. For example,
3241 # `[email protected]`.
3242 #
3243 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3244 # identifier for a
3245 # [Kubernetes service
3246 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3247 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3248 #
3249 # * `group:{emailid}`: An email address that represents a Google group.
3250 # For example, `[email protected]`.
3251 #
3252 #
3253 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3254 # users of that domain. For example, `google.com` or `example.com`.
3255 #
3256 #
3257 #
3258 #
3259 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3260 # A single identity in a workforce identity pool.
3261 #
3262 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3263 # All workforce identities in a group.
3264 #
3265 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3266 # All workforce identities with a specific attribute value.
3267 #
3268 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3269 # All identities in a workforce identity pool.
3270 #
3271 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3272 # A single identity in a workload identity pool.
3273 #
3274 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3275 # A workload identity pool group.
3276 #
3277 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3278 # All identities in a workload identity pool with a certain attribute.
3279 #
3280 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3281 # All identities in a workload identity pool.
3282 #
3283 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3284 # identifier) representing a user that has been recently deleted. For
3285 # example, `[email protected]?uid=123456789012345678901`. If the user is
3286 # recovered, this value reverts to `user:{emailid}` and the recovered user
3287 # retains the role in the binding.
3288 #
3289 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3290 # unique identifier) representing a service account that has been recently
3291 # deleted. For example,
3292 # `[email protected]?uid=123456789012345678901`.
3293 # If the service account is undeleted, this value reverts to
3294 # `serviceAccount:{emailid}` and the undeleted service account retains the
3295 # role in the binding.
3296 #
3297 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3298 # identifier) representing a Google group that has been recently
3299 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3300 # the group is recovered, this value reverts to `group:{emailid}` and the
3301 # recovered group retains the role in the binding.
3302 #
3303 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3304 # Deleted single identity in a workforce identity pool. For example,
3305 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3306 &quot;A String&quot;,
3307 ],
3308 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3309 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3310 #
3311 # For an overview of the IAM roles and permissions, see the
3312 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3313 # a list of the available pre-defined roles, see
3314 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3315 },
3316 ],
3317 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3318 # prevent simultaneous updates of a policy from overwriting each other.
3319 # It is strongly suggested that systems make use of the `etag` in the
3320 # read-modify-write cycle to perform policy updates in order to avoid race
3321 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3322 # systems are expected to put that etag in the request to `setIamPolicy` to
3323 # ensure that their change will be applied to the same version of the policy.
3324 #
3325 # **Important:** If you use IAM Conditions, you must include the `etag` field
3326 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3327 # you to overwrite a version `3` policy with a version `1` policy, and all of
3328 # the conditions in the version `3` policy are lost.
3329 &quot;version&quot;: 42, # Specifies the format of the policy.
3330 #
3331 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3332 # are rejected.
3333 #
3334 # Any operation that affects conditional role bindings must specify version
3335 # `3`. This requirement applies to the following operations:
3336 #
3337 # * Getting a policy that includes a conditional role binding
3338 # * Adding a conditional role binding to a policy
3339 # * Changing a conditional role binding in a policy
3340 # * Removing any role binding, with or without a condition, from a policy
3341 # that includes conditions
3342 #
3343 # **Important:** If you use IAM Conditions, you must include the `etag` field
3344 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3345 # you to overwrite a version `3` policy with a version `1` policy, and all of
3346 # the conditions in the version `3` policy are lost.
3347 #
3348 # If a policy does not include any conditions, operations on that policy may
3349 # specify any valid version or leave the field unset.
3350 #
3351 # To learn which resources support conditions in their IAM policies, see the
3352 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3353 },
3354 }
3355
3356 x__xgafv: string, V1 error format.
3357 Allowed values
3358 1 - v1 error format
3359 2 - v2 error format
3360
3361 Returns:
3362 An object of the form:
3363
3364 { # An Identity and Access Management (IAM) policy, which specifies access
3365 # controls for Google Cloud resources.
3366 #
3367 #
3368 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3369 # `members`, or principals, to a single `role`. Principals can be user
3370 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3371 # `role` is a named list of permissions; each `role` can be an IAM predefined
3372 # role or a user-created custom role.
3373 #
3374 # For some types of Google Cloud resources, a `binding` can also specify a
3375 # `condition`, which is a logical expression that allows access to a resource
3376 # only if the expression evaluates to `true`. A condition can add constraints
3377 # based on attributes of the request, the resource, or both. To learn which
3378 # resources support conditions in their IAM policies, see the
3379 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3380 #
3381 # **JSON example:**
3382 #
3383 # ```
3384 # {
3385 # &quot;bindings&quot;: [
3386 # {
3387 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3388 # &quot;members&quot;: [
3389 # &quot;user:[email protected]&quot;,
3390 # &quot;group:[email protected]&quot;,
3391 # &quot;domain:google.com&quot;,
3392 # &quot;serviceAccount:[email protected]&quot;
3393 # ]
3394 # },
3395 # {
3396 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3397 # &quot;members&quot;: [
3398 # &quot;user:[email protected]&quot;
3399 # ],
3400 # &quot;condition&quot;: {
3401 # &quot;title&quot;: &quot;expirable access&quot;,
3402 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3403 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3404 # }
3405 # }
3406 # ],
3407 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3408 # &quot;version&quot;: 3
3409 # }
3410 # ```
3411 #
3412 # **YAML example:**
3413 #
3414 # ```
3415 # bindings:
3416 # - members:
3417 # - user:[email protected]
3418 # - group:[email protected]
3419 # - domain:google.com
3420 # - serviceAccount:[email protected]
3421 # role: roles/resourcemanager.organizationAdmin
3422 # - members:
3423 # - user:[email protected]
3424 # role: roles/resourcemanager.organizationViewer
3425 # condition:
3426 # title: expirable access
3427 # description: Does not grant access after Sep 2020
3428 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3429 # etag: BwWWja0YfJA=
3430 # version: 3
3431 # ```
3432 #
3433 # For a description of IAM and its features, see the
3434 # [IAM documentation](https://cloud.google.com/iam/docs/).
3435 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3436 { # Specifies the audit configuration for a service.
3437 # The configuration determines which permission types are logged, and what
3438 # identities, if any, are exempted from logging.
3439 # An AuditConfig must have one or more AuditLogConfigs.
3440 #
3441 # If there are AuditConfigs for both `allServices` and a specific service,
3442 # the union of the two AuditConfigs is used for that service: the log_types
3443 # specified in each AuditConfig are enabled, and the exempted_members in each
3444 # AuditLogConfig are exempted.
3445 #
3446 # Example Policy with multiple AuditConfigs:
3447 #
3448 # {
3449 # &quot;audit_configs&quot;: [
3450 # {
3451 # &quot;service&quot;: &quot;allServices&quot;,
3452 # &quot;audit_log_configs&quot;: [
3453 # {
3454 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3455 # &quot;exempted_members&quot;: [
3456 # &quot;user:[email protected]&quot;
3457 # ]
3458 # },
3459 # {
3460 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3461 # },
3462 # {
3463 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3464 # }
3465 # ]
3466 # },
3467 # {
3468 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3469 # &quot;audit_log_configs&quot;: [
3470 # {
3471 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3472 # },
3473 # {
3474 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3475 # &quot;exempted_members&quot;: [
3476 # &quot;user:[email protected]&quot;
3477 # ]
3478 # }
3479 # ]
3480 # }
3481 # ]
3482 # }
3483 #
3484 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3485 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3486 # `[email protected]` from DATA_WRITE logging.
3487 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3488 { # Provides the configuration for logging a type of permissions.
3489 # Example:
3490 #
3491 # {
3492 # &quot;audit_log_configs&quot;: [
3493 # {
3494 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3495 # &quot;exempted_members&quot;: [
3496 # &quot;user:[email protected]&quot;
3497 # ]
3498 # },
3499 # {
3500 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3501 # }
3502 # ]
3503 # }
3504 #
3505 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3506 # [email protected] from DATA_READ logging.
3507 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3508 # permission.
3509 # Follows the same format of Binding.members.
3510 &quot;A String&quot;,
3511 ],
3512 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3513 },
3514 ],
3515 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3516 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3517 # `allServices` is a special value that covers all services.
3518 },
3519 ],
3520 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3521 # may specify a `condition` that determines how and when the `bindings` are
3522 # applied. Each of the `bindings` must contain at least one principal.
3523 #
3524 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3525 # of these principals can be Google groups. Each occurrence of a principal
3526 # counts towards these limits. For example, if the `bindings` grant 50
3527 # different roles to `user:[email protected]`, and not to any other
3528 # principal, then you can add another 1,450 principals to the `bindings` in
3529 # the `Policy`.
3530 { # Associates `members`, or principals, with a `role`.
3531 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3532 #
3533 # If the condition evaluates to `true`, then this binding applies to the
3534 # current request.
3535 #
3536 # If the condition evaluates to `false`, then this binding does not apply to
3537 # the current request. However, a different role binding might grant the same
3538 # role to one or more of the principals in this binding.
3539 #
3540 # To learn which resources support conditions in their IAM policies, see the
3541 # [IAM
3542 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3543 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3544 # are documented at https://github.com/google/cel-spec.
3545 #
3546 # Example (Comparison):
3547 #
3548 # title: &quot;Summary size limit&quot;
3549 # description: &quot;Determines if a summary is less than 100 chars&quot;
3550 # expression: &quot;document.summary.size() &lt; 100&quot;
3551 #
3552 # Example (Equality):
3553 #
3554 # title: &quot;Requestor is owner&quot;
3555 # description: &quot;Determines if requestor is the document owner&quot;
3556 # expression: &quot;document.owner == request.auth.claims.email&quot;
3557 #
3558 # Example (Logic):
3559 #
3560 # title: &quot;Public documents&quot;
3561 # description: &quot;Determine whether the document should be publicly visible&quot;
3562 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3563 #
3564 # Example (Data Manipulation):
3565 #
3566 # title: &quot;Notification string&quot;
3567 # description: &quot;Create a notification string with a timestamp.&quot;
3568 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3569 #
3570 # The exact variables and functions that may be referenced within an expression
3571 # are determined by the service that evaluates it. See the service
3572 # documentation for additional information.
3573 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3574 # describes the expression, e.g. when hovered over it in a UI.
3575 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3576 # syntax.
3577 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3578 # reporting, e.g. a file name and a position in the file.
3579 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3580 # its purpose. This can be used e.g. in UIs which allow to enter the
3581 # expression.
3582 },
3583 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3584 # `members` can have the following values:
3585 #
3586 # * `allUsers`: A special identifier that represents anyone who is
3587 # on the internet; with or without a Google account.
3588 #
3589 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3590 # who is authenticated with a Google account or a service account.
3591 # Does not include identities that come from external identity providers
3592 # (IdPs) through identity federation.
3593 #
3594 # * `user:{emailid}`: An email address that represents a specific Google
3595 # account. For example, `[email protected]` .
3596 #
3597 #
3598 # * `serviceAccount:{emailid}`: An email address that represents a Google
3599 # service account. For example,
3600 # `[email protected]`.
3601 #
3602 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3603 # identifier for a
3604 # [Kubernetes service
3605 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3606 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3607 #
3608 # * `group:{emailid}`: An email address that represents a Google group.
3609 # For example, `[email protected]`.
3610 #
3611 #
3612 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3613 # users of that domain. For example, `google.com` or `example.com`.
3614 #
3615 #
3616 #
3617 #
3618 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3619 # A single identity in a workforce identity pool.
3620 #
3621 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3622 # All workforce identities in a group.
3623 #
3624 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3625 # All workforce identities with a specific attribute value.
3626 #
3627 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3628 # All identities in a workforce identity pool.
3629 #
3630 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3631 # A single identity in a workload identity pool.
3632 #
3633 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3634 # A workload identity pool group.
3635 #
3636 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3637 # All identities in a workload identity pool with a certain attribute.
3638 #
3639 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3640 # All identities in a workload identity pool.
3641 #
3642 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3643 # identifier) representing a user that has been recently deleted. For
3644 # example, `[email protected]?uid=123456789012345678901`. If the user is
3645 # recovered, this value reverts to `user:{emailid}` and the recovered user
3646 # retains the role in the binding.
3647 #
3648 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3649 # unique identifier) representing a service account that has been recently
3650 # deleted. For example,
3651 # `[email protected]?uid=123456789012345678901`.
3652 # If the service account is undeleted, this value reverts to
3653 # `serviceAccount:{emailid}` and the undeleted service account retains the
3654 # role in the binding.
3655 #
3656 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3657 # identifier) representing a Google group that has been recently
3658 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3659 # the group is recovered, this value reverts to `group:{emailid}` and the
3660 # recovered group retains the role in the binding.
3661 #
3662 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3663 # Deleted single identity in a workforce identity pool. For example,
3664 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3665 &quot;A String&quot;,
3666 ],
3667 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3668 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3669 #
3670 # For an overview of the IAM roles and permissions, see the
3671 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3672 # a list of the available pre-defined roles, see
3673 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3674 },
3675 ],
3676 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3677 # prevent simultaneous updates of a policy from overwriting each other.
3678 # It is strongly suggested that systems make use of the `etag` in the
3679 # read-modify-write cycle to perform policy updates in order to avoid race
3680 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3681 # systems are expected to put that etag in the request to `setIamPolicy` to
3682 # ensure that their change will be applied to the same version of the policy.
3683 #
3684 # **Important:** If you use IAM Conditions, you must include the `etag` field
3685 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3686 # you to overwrite a version `3` policy with a version `1` policy, and all of
3687 # the conditions in the version `3` policy are lost.
3688 &quot;version&quot;: 42, # Specifies the format of the policy.
3689 #
3690 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3691 # are rejected.
3692 #
3693 # Any operation that affects conditional role bindings must specify version
3694 # `3`. This requirement applies to the following operations:
3695 #
3696 # * Getting a policy that includes a conditional role binding
3697 # * Adding a conditional role binding to a policy
3698 # * Changing a conditional role binding in a policy
3699 # * Removing any role binding, with or without a condition, from a policy
3700 # that includes conditions
3701 #
3702 # **Important:** If you use IAM Conditions, you must include the `etag` field
3703 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3704 # you to overwrite a version `3` policy with a version `1` policy, and all of
3705 # the conditions in the version `3` policy are lost.
3706 #
3707 # If a policy does not include any conditions, operations on that policy may
3708 # specify any valid version or leave the field unset.
3709 #
3710 # To learn which resources support conditions in their IAM policies, see the
3711 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3712 }</pre>
3713 </div>
3714
3715 <div class="method">
3716 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
3717 <pre>Sets the labels on an Interconnect. To learn more about labels,
3718 read the Labeling
3719 Resources documentation.
3720
3721 Args:
3722 project: string, Project ID for this request. (required)
3723 resource: string, Name or id of the resource for this request. (required)
3724 body: object, The request body.
3725 The object takes the form of:
3726
3727 {
3728 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
3729 # used to detect conflicts. The fingerprint is initially generated by Compute
3730 # Engine and changes after every request to modify or update labels. You must
3731 # always provide an up-to-date fingerprint hash when updating or changing
3732 # labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
3733 # resource to get the latest fingerprint.
3734 &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
3735 # the
3736 # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
3737 # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
3738 &quot;a_key&quot;: &quot;A String&quot;,
3739 },
3740 }
3741
3742 x__xgafv: string, V1 error format.
3743 Allowed values
3744 1 - v1 error format
3745 2 - v2 error format
3746
3747 Returns:
3748 An object of the form:
3749
3750 { # Represents an Operation resource.
3751 #
3752 # Google Compute Engine has three Operation resources:
3753 #
3754 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3755 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3756 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3757 #
3758 # You can use an operation resource to manage asynchronous API requests.
3759 # For more information, readHandling
3760 # API responses.
3761 #
3762 # Operations can be global, regional or zonal.
3763 #
3764 # - For global operations, use the `globalOperations`
3765 # resource.
3766 # - For regional operations, use the
3767 # `regionOperations` resource.
3768 # - For zonal operations, use
3769 # the `zoneOperations` resource.
3770 #
3771 #
3772 #
3773 # For more information, read
3774 # Global, Regional, and Zonal Resources.
3775 #
3776 # Note that completed Operation resources have a limited
3777 # retention period.
3778 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3779 # Not present otherwise.
3780 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3781 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3782 # set when the operation is created.
3783 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3784 # text format.
3785 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3786 # this field will be populated.
3787 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3788 # operation.
3789 {
3790 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3791 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3792 # details. There is a set of defined message types to use for providing
3793 # details.The syntax depends on the error code. For example,
3794 # QuotaExceededInfo will have details when the error code is
3795 # QUOTA_EXCEEDED.
3796 {
3797 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3798 #
3799 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3800 # is not enabled:
3801 #
3802 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3803 # &quot;domain&quot;: &quot;googleapis.com&quot;
3804 # &quot;metadata&quot;: {
3805 # &quot;resource&quot;: &quot;projects/123&quot;,
3806 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3807 # }
3808 # }
3809 #
3810 # This response indicates that the pubsub.googleapis.com API is not enabled.
3811 #
3812 # Example of an error that is returned when attempting to create a Spanner
3813 # instance in a region that is out of stock:
3814 #
3815 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3816 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3817 # &quot;metadata&quot;: {
3818 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3819 # }
3820 # }
3821 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3822 # is typically the registered service name of the tool or product that
3823 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3824 # generated by some common infrastructure, the error domain must be a
3825 # globally unique value that identifies the infrastructure. For Google API
3826 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3827 &quot;metadatas&quot;: { # Additional structured details about this error.
3828 #
3829 # Keys must match a regular expression of `a-z+` but should
3830 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3831 # length. When identifying the current value of an exceeded limit, the units
3832 # should be contained in the key, not the value. For example, rather than
3833 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3834 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3835 # instances that can be created in a single (batch) request.
3836 &quot;a_key&quot;: &quot;A String&quot;,
3837 },
3838 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3839 # proximate cause of the error. Error reasons are unique within a particular
3840 # domain of errors. This should be at most 63 characters and match a
3841 # regular expression of `A-Z+[A-Z0-9]`, which represents
3842 # UPPER_SNAKE_CASE.
3843 },
3844 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3845 #
3846 # For example, if a quota check failed with an error indicating the calling
3847 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3848 # directly to the right place in the developer console to flip the bit.
3849 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3850 { # Describes a URL link.
3851 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3852 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3853 },
3854 ],
3855 },
3856 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3857 # which can be attached to an RPC error.
3858 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3859 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3860 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3861 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3862 },
3863 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3864 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3865 &quot;a_key&quot;: &quot;A String&quot;,
3866 },
3867 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3868 # type or metric.
3869 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3870 # or metric.
3871 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3872 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3873 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3874 },
3875 },
3876 ],
3877 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3878 # This property is optional.
3879 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3880 },
3881 ],
3882 },
3883 &quot;getVersionOperationMetadata&quot;: {
3884 &quot;inlineSbomInfo&quot;: {
3885 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3886 # appropriate identifiers.
3887 &quot;a_key&quot;: &quot;A String&quot;,
3888 },
3889 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3890 # identifiers.
3891 &quot;a_key&quot;: &quot;A String&quot;,
3892 },
3893 },
3894 },
3895 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3896 # message that was returned, such as `NOT FOUND`.
3897 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3898 # status code that was returned. For example, a `404` means the
3899 # resource was not found.
3900 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3901 # defined by the server.
3902 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3903 # This value is inRFC3339
3904 # text format.
3905 &quot;instancesBulkInsertOperationMetadata&quot;: {
3906 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3907 # Example key: zones/us-central1-a
3908 &quot;a_key&quot;: {
3909 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3910 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3911 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3912 # error.
3913 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3914 # if the flow is rolling forward or rolling back.
3915 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3916 },
3917 },
3918 },
3919 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3920 # Operation resources.
3921 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3922 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3923 # group of operations results from a `bulkInsert` API request.
3924 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3925 # `update`, or `delete`, and so on.
3926 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3927 # There is no requirement that this be linear or support any granularity of
3928 # operations. This should not be used to guess when the operation will be
3929 # complete. This number should monotonically increase as the operation
3930 # progresses.
3931 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3932 # applicable when performing regional operations.
3933 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3934 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3935 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3936 # this field will contain information on all underlying zonal actions and
3937 # their state.
3938 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3939 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3940 # Example key: zones/us-central1-a
3941 &quot;a_key&quot;: {
3942 &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
3943 # populated.
3944 # different programming environments, including REST APIs and RPC APIs. It is
3945 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3946 # three pieces of data: error code, error message, and error details.
3947 #
3948 # You can find out more about this error model and how to work with it in the
3949 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3950 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3951 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3952 # message types for APIs to use.
3953 {
3954 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3955 },
3956 ],
3957 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3958 # user-facing error message should be localized and sent in the
3959 # google.rpc.Status.details field, or localized by the client.
3960 },
3961 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3962 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3963 },
3964 },
3965 },
3966 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3967 # This value is inRFC3339
3968 # text format.
3969 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3970 # following:
3971 # `PENDING`, `RUNNING`, or `DONE`.
3972 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3973 # operation.
3974 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3975 # of the target resource.
3976 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3977 # operations related to creating a snapshot, this points to the disk
3978 # that the snapshot was created from.
3979 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3980 # `[email protected]` or
3981 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3982 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3983 # operation, this field will be populated.
3984 {
3985 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3986 # Engine returns NO_RESULTS_ON_PAGE if there
3987 # are no results in the response.
3988 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3989 # value format. For example:
3990 #
3991 # &quot;data&quot;: [
3992 # {
3993 # &quot;key&quot;: &quot;scope&quot;,
3994 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3995 # }
3996 {
3997 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3998 # returned. For example, for warnings where there are no results in a list
3999 # request for a particular zone, this key might be scope and
4000 # the key value might be the zone name. Other examples might be a key
4001 # indicating a deprecated resource and a suggested replacement, or a
4002 # warning about invalid network settings (for example, if an instance
4003 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4004 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4005 },
4006 ],
4007 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4008 },
4009 ],
4010 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4011 # applicable when performing per-zone operations.
4012 }</pre>
4013 </div>
4014
4015 <div class="method">
4016 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
4017 <pre>Returns permissions that a caller has on the specified resource.
4018
4019 Args:
4020 project: string, Project ID for this request. (required)
4021 resource: string, Name or id of the resource for this request. (required)
4022 body: object, The request body.
4023 The object takes the form of:
4024
4025 {
4026 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
4027 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
4028 &quot;A String&quot;,
4029 ],
4030 }
4031
4032 x__xgafv: string, V1 error format.
4033 Allowed values
4034 1 - v1 error format
4035 2 - v2 error format
4036
4037 Returns:
4038 An object of the form:
4039
4040 {
4041 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4042 # allowed.
4043 &quot;A String&quot;,
4044 ],
4045 }</pre>
4046 </div>
4047
4048 </body></html>