Debian Codegraph @

docs/dyn/compute_beta.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_beta.html">Compute Engine API</a> . <a href="compute_beta.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="#getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the interconnectMacsecConfig for the specified</p>
92 <p class="toc_element">
93 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates an Interconnect in the specified project using</p>
95 <p class="toc_element">
96 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves the list of Interconnects available to the specified project.</p>
98 <p class="toc_element">
99 <code><a href="#list_next">list_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the specified Interconnect with the data included in the request.</p>
104 <p class="toc_element">
105 <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Sets the labels on an Interconnect. To learn more about labels,</p>
107 <p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="close">close()</code>
113 <pre>Close httplib2 connections.</pre>
114 </div>
115
116 <div class="method">
117 <code class="details" id="delete">delete(project, interconnect, requestId=None, x__xgafv=None)</code>
118 <pre>Deletes the specified Interconnect.
119
120 Args:
121 project: string, Project ID for this request. (required)
122 interconnect: string, Name of the interconnect to delete. (required)
123 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
124 that if you must retry your request, the server will know to ignore the
125 request if it has already been completed.
126
127 For example, consider a situation where you make an initial request and
128 the request times out. If you make the request again with the same
129 request ID, the server can check if original operation with the same
130 request ID was received, and if so, will ignore the second request. This
131 prevents clients from accidentally creating duplicate commitments.
132
133 The request ID must be
134 a valid UUID with the exception that zero UUID is not supported
135 (00000000-0000-0000-0000-000000000000).
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141 Returns:
142 An object of the form:
143
144 { # Represents an Operation resource.
145 #
146 # Google Compute Engine has three Operation resources:
147 #
148 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
149 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
150 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
151 #
152 # You can use an operation resource to manage asynchronous API requests.
153 # For more information, readHandling
154 # API responses.
155 #
156 # Operations can be global, regional or zonal.
157 #
158 # - For global operations, use the `globalOperations`
159 # resource.
160 # - For regional operations, use the
161 # `regionOperations` resource.
162 # - For zonal operations, use
163 # the `zoneOperations` resource.
164 #
165 #
166 #
167 # For more information, read
168 # Global, Regional, and Zonal Resources.
169 #
170 # Note that completed Operation resources have a limited
171 # retention period.
172 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
173 # Not present otherwise.
174 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
175 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
176 # set when the operation is created.
177 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
178 # text format.
179 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
180 # this field will be populated.
181 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
182 # operation.
183 {
184 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
185 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
186 # details. There is a set of defined message types to use for providing
187 # details.The syntax depends on the error code. For example,
188 # QuotaExceededInfo will have details when the error code is
189 # QUOTA_EXCEEDED.
190 {
191 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
192 #
193 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
194 # is not enabled:
195 #
196 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
197 # &quot;domain&quot;: &quot;googleapis.com&quot;
198 # &quot;metadata&quot;: {
199 # &quot;resource&quot;: &quot;projects/123&quot;,
200 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
201 # }
202 # }
203 #
204 # This response indicates that the pubsub.googleapis.com API is not enabled.
205 #
206 # Example of an error that is returned when attempting to create a Spanner
207 # instance in a region that is out of stock:
208 #
209 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
210 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
211 # &quot;metadata&quot;: {
212 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
213 # }
214 # }
215 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
216 # is typically the registered service name of the tool or product that
217 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
218 # generated by some common infrastructure, the error domain must be a
219 # globally unique value that identifies the infrastructure. For Google API
220 # infrastructure, the error domain is &quot;googleapis.com&quot;.
221 &quot;metadatas&quot;: { # Additional structured details about this error.
222 #
223 # Keys must match a regular expression of `a-z+` but should
224 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
225 # length. When identifying the current value of an exceeded limit, the units
226 # should be contained in the key, not the value. For example, rather than
227 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
228 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
229 # instances that can be created in a single (batch) request.
230 &quot;a_key&quot;: &quot;A String&quot;,
231 },
232 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
233 # proximate cause of the error. Error reasons are unique within a particular
234 # domain of errors. This should be at most 63 characters and match a
235 # regular expression of `A-Z+[A-Z0-9]`, which represents
236 # UPPER_SNAKE_CASE.
237 },
238 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
239 #
240 # For example, if a quota check failed with an error indicating the calling
241 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
242 # directly to the right place in the developer console to flip the bit.
243 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
244 { # Describes a URL link.
245 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
246 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
247 },
248 ],
249 },
250 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
251 # which can be attached to an RPC error.
252 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
253 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
254 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
255 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
256 },
257 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
258 &quot;dimensions&quot;: { # The map holding related quota dimensions.
259 &quot;a_key&quot;: &quot;A String&quot;,
260 },
261 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
262 # type or metric.
263 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
264 # or metric.
265 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
266 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
267 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
268 },
269 },
270 ],
271 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
272 # This property is optional.
273 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
274 },
275 ],
276 },
277 &quot;getVersionOperationMetadata&quot;: {
278 &quot;inlineSbomInfo&quot;: {
279 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
280 # appropriate identifiers.
281 &quot;a_key&quot;: &quot;A String&quot;,
282 },
283 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
284 # identifiers.
285 &quot;a_key&quot;: &quot;A String&quot;,
286 },
287 },
288 },
289 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
290 # message that was returned, such as `NOT FOUND`.
291 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
292 # status code that was returned. For example, a `404` means the
293 # resource was not found.
294 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
295 # defined by the server.
296 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
297 # This value is inRFC3339
298 # text format.
299 &quot;instancesBulkInsertOperationMetadata&quot;: {
300 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
301 # Example key: zones/us-central1-a
302 &quot;a_key&quot;: {
303 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
304 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
305 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
306 # error.
307 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
308 # if the flow is rolling forward or rolling back.
309 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
310 },
311 },
312 },
313 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
314 # Operation resources.
315 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
316 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
317 # group of operations results from a `bulkInsert` API request.
318 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
319 # `update`, or `delete`, and so on.
320 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
321 # There is no requirement that this be linear or support any granularity of
322 # operations. This should not be used to guess when the operation will be
323 # complete. This number should monotonically increase as the operation
324 # progresses.
325 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
326 # applicable when performing regional operations.
327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
328 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
329 # this field will contain information on all underlying zonal actions and
330 # their state.
331 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
332 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
333 # Example key: zones/us-central1-a
334 &quot;a_key&quot;: {
335 &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
336 # populated.
337 # different programming environments, including REST APIs and RPC APIs. It is
338 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
339 # three pieces of data: error code, error message, and error details.
340 #
341 # You can find out more about this error model and how to work with it in the
342 # [API Design Guide](https://cloud.google.com/apis/design/errors).
343 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
344 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
345 # message types for APIs to use.
346 {
347 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
348 },
349 ],
350 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
351 # user-facing error message should be localized and sent in the
352 # google.rpc.Status.details field, or localized by the client.
353 },
354 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
355 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
356 },
357 },
358 },
359 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
360 # This value is inRFC3339
361 # text format.
362 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
363 # following:
364 # `PENDING`, `RUNNING`, or `DONE`.
365 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
366 # operation.
367 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
368 # of the target resource.
369 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
370 # operations related to creating a snapshot, this points to the disk
371 # that the snapshot was created from.
372 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
373 # `[email protected]` or
374 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
375 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
376 # operation, this field will be populated.
377 {
378 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
379 # Engine returns NO_RESULTS_ON_PAGE if there
380 # are no results in the response.
381 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
382 # value format. For example:
383 #
384 # &quot;data&quot;: [
385 # {
386 # &quot;key&quot;: &quot;scope&quot;,
387 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
388 # }
389 {
390 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
391 # returned. For example, for warnings where there are no results in a list
392 # request for a particular zone, this key might be scope and
393 # the key value might be the zone name. Other examples might be a key
394 # indicating a deprecated resource and a suggested replacement, or a
395 # warning about invalid network settings (for example, if an instance
396 # attempts to perform IP forwarding but is not enabled for IP forwarding).
397 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
398 },
399 ],
400 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
401 },
402 ],
403 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
404 # applicable when performing per-zone operations.
405 }</pre>
406 </div>
407
408 <div class="method">
409 <code class="details" id="get">get(project, interconnect, x__xgafv=None)</code>
410 <pre>Returns the specified Interconnect. Get a list of available Interconnects
411 by making a list() request.
412
413 Args:
414 project: string, Project ID for this request. (required)
415 interconnect: string, Name of the interconnect to return. (required)
416 x__xgafv: string, V1 error format.
417 Allowed values
418 1 - v1 error format
419 2 - v2 error format
420
421 Returns:
422 An object of the form:
423
424 { # Represents an Interconnect resource.
425 #
426 # An Interconnect resource is a dedicated connection between the Google
427 # Cloud network and your on-premises network. For more information, read the
428 # Dedicated Interconnect Overview.
429 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
430 # Interconnect.
431 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
432 # Interconnect is functional and can carry traffic.
433 # When set to false, no packets can be carried over the interconnect and
434 # no BGP routes are exchanged over it. By default, the status is set to true.
435 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
436 # Interconnect.
437 # Interconnect.
438 &quot;bandwidthPercentagePolicy&quot;: {
439 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
440 # type Bandwidth Percent.
441 { # Specify bandwidth percentages [1-100] for various traffic classes in
442 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
443 # All traffic classes must have a percentage value specified.
444 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
445 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
446 },
447 ],
448 },
449 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
450 # Interconnect.
451 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
452 # applied in conjunction with StrictPriorityPolicy or
453 # BandwidthPercentagePolicy.
454 { # Specify bandwidth percentages [1-100] for various traffic classes in
455 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
456 # All traffic classes must have a percentage value specified.
457 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
458 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
459 },
460 ],
461 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
462 },
463 },
464 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
465 # which can take one of the following values:
466 #
467 # - IF_MACSEC: If present, then the Interconnect connection is
468 # provisioned on MACsec capable hardware ports. If not present, then the
469 # Interconnect connection is provisioned on non-MACsec capable ports. Any
470 # attempt to enable MACsec will fail.
471 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
472 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
473 # VLAN attachments will fail. If not present, then the Interconnect
474 # connection is not provisioned for Cross-Site Networking. Any attempt to use
475 # it for Cross-Site Networking will fail.
476 &quot;A String&quot;,
477 ],
478 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
479 # circuits in this LAG.
480 { # Describes a single physical circuit between the Customer and Google.
481 # CircuitInfo objects are created by Google, so all fields are output only.
482 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
483 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
484 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
485 # provided by Google to the customer in the LOA.
486 },
487 ],
488 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
489 # text format.
490 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
491 # authorized to request a crossconnect.
492 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
493 # create the resource.
494 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
495 # this connection is to be provisioned. By default it will be the same as the
496 # location field.
497 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
498 { # Description of a planned outage on this Interconnect.
499 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
500 # IDs that will be affected.
501 &quot;A String&quot;,
502 ],
503 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
504 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
505 # epoch).
506 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
507 # values:
508 #
509 # - OUTAGE: The Interconnect may be completely out of service for
510 # some or all of the specified window.
511 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
512 # should remain up, but with reduced bandwidth.
513 #
514 #
515 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
516 # deprecated in favor of the unprefixed values.
517 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
518 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
519 # value:
520 #
521 # - GOOGLE: this notification as generated by Google.
522 #
523 #
524 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
525 # GOOGLE.
526 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
527 # epoch).
528 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
529 #
530 # - ACTIVE: This outage notification is active. The event could be in
531 # the past, present, or future. See start_time and end_time for
532 # scheduling.
533 # - CANCELLED: The outage associated with this notification was cancelled
534 # before the outage was due to start.
535 # - COMPLETED: The outage associated with this notification is complete.
536 #
537 #
538 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
539 # deprecated in favor of the unprefixed values.
540 },
541 ],
542 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
543 # link. This can be used only for ping tests.
544 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
545 # with Google or otherwise to debug backend connectivity issues.
546 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
547 # defined by the server.
548 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
549 # to use this Interconnect.
550 &quot;A String&quot;,
551 ],
552 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
553 # Order is arbitrary and items are unique.
554 &quot;A String&quot;,
555 ],
556 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
557 #
558 # - PARTNER: A partner-managed interconnection shared between customers
559 # though a partner.
560 # - DEDICATED: A dedicated physical interconnection with the
561 # customer.
562 #
563 #
564 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
565 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
566 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
567 # is essentially a hash of the labels set used for optimistic locking. The
568 # fingerprint is initially generated by Compute Engine and changes after
569 # every request to modify or update labels. You must always provide an
570 # up-to-date fingerprint hash in order to update or change labels,
571 # otherwise the request will fail with error412 conditionNotMet.
572 #
573 # To see the latest fingerprint, make a get() request to
574 # retrieve an Interconnect.
575 &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.
576 # Label values may be empty.
577 &quot;a_key&quot;: &quot;A String&quot;,
578 },
579 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
580 #
581 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
582 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
583 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
584 #
585 #
586 # Note that this field indicates the speed of each of
587 # the links in the bundle, not the speed of the entire bundle.
588 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
589 # connection is to be provisioned.
590 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
591 # Cloud Interconnect connection between Google and your on-premises router.
592 # (MACsec) on this Cloud Interconnect connection between Google and your
593 # on-premises router.
594 &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
595 # router to fallback to cleartext traffic if the MKA session cannot be
596 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
597 # MKA session cannot be established with your router.
598 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
599 # along with their start times. A MACsec CKN/CAK is generated for each
600 # key in the key chain. Google router automatically picks the key with
601 # the most recent startTime when establishing or re-establishing a MACsec
602 # secure link.
603 { # Describes a pre-shared key used to setup MACsec in static connectivity
604 # association key (CAK) mode.
605 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
606 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
607 # characters long and match the regular expression
608 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
609 # lowercase letter, and all following characters must be a dash,
610 # lowercase letter, or digit, except the last character, which cannot be
611 # a dash.
612 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
613 # valid. startTime can be in the future. If the keychain has a single
614 # key, startTime can be omitted. If the keychain has multiple keys,
615 # startTime is mandatory for each key. The start times of keys must be in
616 # increasing order. The start times of two consecutive keys must be
617 # at least 6 hours apart.
618 },
619 ],
620 },
621 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
622 # fails if the MACsec object is not specified.
623 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
624 # The name must be 1-63 characters long, and comply withRFC1035.
625 # Specifically, the name must be 1-63 characters long and match the regular
626 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
627 # character must be a lowercase letter, and all following characters must be
628 # a dash, lowercase letter, or digit, except the last character, which cannot
629 # be a dash.
630 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
631 # notifications regarding this Interconnect. If specified, this will be used
632 # for notifications in addition to all other forms described, such as
633 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
634 # required for users who sign up for Cloud Interconnect using
635 # workforce identity federation.
636 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
637 # which can take one of the following values:
638 #
639 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
640 # use. Attachments may be provisioned on this Interconnect.
641 #
642 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
643 # attachments may be provisioned on this Interconnect.
644 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
645 # maintenance. No attachments may be provisioned or updated on this
646 # Interconnect.
647 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
648 # as part of resource payload.
649 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
650 # Tag keys and values have the same definition as resource
651 # manager tags. The field is allowed for INSERT
652 # only. The keys/values to set on the resource should be specified in
653 # either ID { : } or Namespaced format
654 # { : }.
655 # For example the following are valid inputs:
656 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
657 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
658 # Note:
659 # * Invalid combinations of ID &amp; namespaced format is not supported. For
660 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
661 # * Inconsistent format is not supported. For instance:
662 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
663 &quot;a_key&quot;: &quot;A String&quot;,
664 },
665 },
666 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
667 # Interconnect link. The customer should configure this IP address during
668 # turnup when prompted by Google NOC. This can be used only for ping tests.
669 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
670 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
671 # location outside of Google&#x27;s network that the interconnect is connected to.
672 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
673 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
674 # Interconnect connection, which can take one of the following values:
675 #
676 # - IF_MACSEC: If specified, then the connection is created on MACsec
677 # capable hardware ports. If not specified, non-MACsec capable ports will
678 # also be considered.
679 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
680 # exclusively for Cross-Site Networking. The connection can not be used for
681 # Cross-Site Networking unless this feature is specified.
682 &quot;A String&quot;,
683 ],
684 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
685 # customer.
686 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
687 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
688 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
689 # take one of the following values:
690 #
691 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
692 # Attachments may be provisioned on this Interconnect.
693 # - UNPROVISIONED: The Interconnect has not completed turnup. No
694 # attachments may be provisioned on this Interconnect.
695 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
696 # No attachments may be provisioned or updated on this
697 # Interconnect.
698 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
699 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
700 # configured to use this Interconnect. The Interconnect cannot be deleted if
701 # this list is non-empty.
702 &quot;A String&quot;,
703 ],
704 }</pre>
705 </div>
706
707 <div class="method">
708 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</code>
709 <pre>Returns the interconnectDiagnostics for the specified
710 Interconnect.
711
712 In the event of a
713 global outage, do not use this API to make decisions about where to
714 redirect your network traffic.
715
716 Unlike a VLAN attachment, which is regional, a Cloud Interconnect
717 connection is a global resource. A global outage can prevent this
718 API from functioning properly.
719
720 Args:
721 project: string, Project ID for this request. (required)
722 interconnect: string, Name of the interconnect resource to query. (required)
723 x__xgafv: string, V1 error format.
724 Allowed values
725 1 - v1 error format
726 2 - v2 error format
727
728 Returns:
729 An object of the form:
730
731 { # Response for the InterconnectsGetDiagnosticsRequest.
732 &quot;result&quot;: { # Diagnostics information about the Interconnect connection, which contains
733 # detailed and current technical information about Google&#x27;s side of the
734 # connection.
735 &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
736 # describing individual neighbors currently seen by the Google router in
737 # the ARP cache for the Interconnect.
738 # This will be empty when the Interconnect is not bundled.
739 { # Describing the ARP neighbor entries seen on this link
740 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
741 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
742 },
743 ],
744 &quot;bundleAggregationType&quot;: &quot;A String&quot;, # The aggregation type of the bundle interface.
745 &quot;bundleOperationalStatus&quot;: &quot;A String&quot;, # The operational status of the bundle interface.
746 &quot;links&quot;: [ # A list of InterconnectDiagnostics.LinkStatus objects,
747 # describing the status for each link on the Interconnect.
748 {
749 &quot;arpCaches&quot;: [ # A list of InterconnectDiagnostics.ARPEntry objects,
750 # describing the ARP neighbor entries seen on this link.
751 # This will be empty if the link is bundled
752 { # Describing the ARP neighbor entries seen on this link
753 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this ARP neighbor.
754 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of this ARP neighbor.
755 },
756 ],
757 &quot;circuitId&quot;: &quot;A String&quot;, # The unique ID for this link assigned during turn up by Google.
758 &quot;googleDemarc&quot;: &quot;A String&quot;, # The Demarc address assigned by Google and provided in the LoA.
759 &quot;lacpStatus&quot;: {
760 &quot;googleSystemId&quot;: &quot;A String&quot;, # System ID of the port on Google&#x27;s side of the LACP exchange.
761 &quot;neighborSystemId&quot;: &quot;A String&quot;, # System ID of the port on the neighbor&#x27;s side of the LACP exchange.
762 &quot;state&quot;: &quot;A String&quot;, # The state of a LACP link, which can take one of the following values:
763 #
764 # - ACTIVE: The link is configured and active within the bundle.
765 # - DETACHED: The link is not configured within the bundle. This means
766 # that the rest of the object should be empty.
767 },
768 &quot;macsec&quot;: { # Describes the status of MACsec encryption on the link. # Describes the status of MACsec encryption on this link.
769 &quot;ckn&quot;: &quot;A String&quot;, # Indicates the Connectivity Association Key Name (CKN)
770 # currently being used if MACsec is operational.
771 &quot;operational&quot;: True or False, # Indicates whether or not MACsec is operational on this link.
772 },
773 &quot;operationalStatus&quot;: &quot;A String&quot;, # The operational status of the link.
774 &quot;receivingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
775 # describing the current value and status of the received light level.
776 &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
777 # levels for the receiving or transmitting transceiver. Possible states
778 # include:
779 #
780 #
781 # - OK: The value has not crossed a warning threshold.
782 # - LOW_WARNING: The value has crossed below the low
783 # warning threshold.
784 # - HIGH_WARNING: The value has
785 # crossed above the high warning threshold.
786 # - LOW_ALARM: The value has crossed below the low alarm
787 # threshold.
788 # - HIGH_ALARM: The value has crossed above the high alarm
789 # threshold.
790 &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
791 # dBm. Take a known good optical value, give it a 10% margin and trigger
792 # warnings relative to that value. In general, a -7dBm warning and a -11dBm
793 # alarm are good optical value estimates for most links.
794 },
795 &quot;transmittingOpticalPower&quot;: { # An InterconnectDiagnostics.LinkOpticalPower object,
796 # describing the current value and status of the transmitted light level.
797 &quot;state&quot;: &quot;A String&quot;, # The status of the current value when compared to the warning and alarm
798 # levels for the receiving or transmitting transceiver. Possible states
799 # include:
800 #
801 #
802 # - OK: The value has not crossed a warning threshold.
803 # - LOW_WARNING: The value has crossed below the low
804 # warning threshold.
805 # - HIGH_WARNING: The value has
806 # crossed above the high warning threshold.
807 # - LOW_ALARM: The value has crossed below the low alarm
808 # threshold.
809 # - HIGH_ALARM: The value has crossed above the high alarm
810 # threshold.
811 &quot;value&quot;: 3.14, # Value of the current receiving or transmitting optical power, read in
812 # dBm. Take a known good optical value, give it a 10% margin and trigger
813 # warnings relative to that value. In general, a -7dBm warning and a -11dBm
814 # alarm are good optical value estimates for most links.
815 },
816 },
817 ],
818 &quot;macAddress&quot;: &quot;A String&quot;, # The MAC address of the Interconnect&#x27;s bundle interface.
819 },
820 }</pre>
821 </div>
822
823 <div class="method">
824 <code class="details" id="getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</code>
825 <pre>Returns the interconnectMacsecConfig for the specified
826 Interconnect.
827
828 Args:
829 project: string, Project ID for this request. (required)
830 interconnect: string, Name of the interconnect resource to query. (required)
831 x__xgafv: string, V1 error format.
832 Allowed values
833 1 - v1 error format
834 2 - v2 error format
835
836 Returns:
837 An object of the form:
838
839 { # Response for the InterconnectsGetMacsecConfigRequest.
840 &quot;etag&quot;: &quot;A String&quot;, # end_interface: MixerGetResponseWithEtagBuilder
841 &quot;result&quot;: { # MACsec configuration information for the Interconnect connection. Contains
842 # the generated Connectivity Association Key Name (CKN) and the key (CAK) for
843 # this Interconnect connection.
844 &quot;preSharedKeys&quot;: [ # A keychain placeholder describing a set of named key objects
845 # along with their start times. A MACsec CKN/CAK is generated for each key in
846 # the key chain. Google router automatically picks the key with the most
847 # recent startTime when establishing or re-establishing a MACsec secure link.
848 { # Describes a pre-shared key used to setup MACsec in static connectivity
849 # association key (CAK) mode.
850 &quot;cak&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key (CAK) for this key.
851 &quot;ckn&quot;: &quot;A String&quot;, # An auto-generated Connectivity Association Key Name (CKN) for this key.
852 &quot;name&quot;: &quot;A String&quot;, # User provided name for this pre-shared key.
853 &quot;startTime&quot;: &quot;A String&quot;, # User provided timestamp on or after which this key is valid.
854 },
855 ],
856 },
857 }</pre>
858 </div>
859
860 <div class="method">
861 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
862 <pre>Creates an Interconnect in the specified project using
863 the data included in the request.
864
865 Args:
866 project: string, Project ID for this request. (required)
867 body: object, The request body.
868 The object takes the form of:
869
870 { # Represents an Interconnect resource.
871 #
872 # An Interconnect resource is a dedicated connection between the Google
873 # Cloud network and your on-premises network. For more information, read the
874 # Dedicated Interconnect Overview.
875 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
876 # Interconnect.
877 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
878 # Interconnect is functional and can carry traffic.
879 # When set to false, no packets can be carried over the interconnect and
880 # no BGP routes are exchanged over it. By default, the status is set to true.
881 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
882 # Interconnect.
883 # Interconnect.
884 &quot;bandwidthPercentagePolicy&quot;: {
885 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
886 # type Bandwidth Percent.
887 { # Specify bandwidth percentages [1-100] for various traffic classes in
888 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
889 # All traffic classes must have a percentage value specified.
890 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
891 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
892 },
893 ],
894 },
895 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
896 # Interconnect.
897 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
898 # applied in conjunction with StrictPriorityPolicy or
899 # BandwidthPercentagePolicy.
900 { # Specify bandwidth percentages [1-100] for various traffic classes in
901 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
902 # All traffic classes must have a percentage value specified.
903 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
904 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
905 },
906 ],
907 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
908 },
909 },
910 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
911 # which can take one of the following values:
912 #
913 # - IF_MACSEC: If present, then the Interconnect connection is
914 # provisioned on MACsec capable hardware ports. If not present, then the
915 # Interconnect connection is provisioned on non-MACsec capable ports. Any
916 # attempt to enable MACsec will fail.
917 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
918 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
919 # VLAN attachments will fail. If not present, then the Interconnect
920 # connection is not provisioned for Cross-Site Networking. Any attempt to use
921 # it for Cross-Site Networking will fail.
922 &quot;A String&quot;,
923 ],
924 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
925 # circuits in this LAG.
926 { # Describes a single physical circuit between the Customer and Google.
927 # CircuitInfo objects are created by Google, so all fields are output only.
928 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
929 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
930 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
931 # provided by Google to the customer in the LOA.
932 },
933 ],
934 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
935 # text format.
936 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
937 # authorized to request a crossconnect.
938 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
939 # create the resource.
940 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
941 # this connection is to be provisioned. By default it will be the same as the
942 # location field.
943 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
944 { # Description of a planned outage on this Interconnect.
945 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
946 # IDs that will be affected.
947 &quot;A String&quot;,
948 ],
949 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
950 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
951 # epoch).
952 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
953 # values:
954 #
955 # - OUTAGE: The Interconnect may be completely out of service for
956 # some or all of the specified window.
957 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
958 # should remain up, but with reduced bandwidth.
959 #
960 #
961 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
962 # deprecated in favor of the unprefixed values.
963 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
964 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
965 # value:
966 #
967 # - GOOGLE: this notification as generated by Google.
968 #
969 #
970 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
971 # GOOGLE.
972 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
973 # epoch).
974 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
975 #
976 # - ACTIVE: This outage notification is active. The event could be in
977 # the past, present, or future. See start_time and end_time for
978 # scheduling.
979 # - CANCELLED: The outage associated with this notification was cancelled
980 # before the outage was due to start.
981 # - COMPLETED: The outage associated with this notification is complete.
982 #
983 #
984 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
985 # deprecated in favor of the unprefixed values.
986 },
987 ],
988 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
989 # link. This can be used only for ping tests.
990 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
991 # with Google or otherwise to debug backend connectivity issues.
992 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
993 # defined by the server.
994 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
995 # to use this Interconnect.
996 &quot;A String&quot;,
997 ],
998 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
999 # Order is arbitrary and items are unique.
1000 &quot;A String&quot;,
1001 ],
1002 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
1003 #
1004 # - PARTNER: A partner-managed interconnection shared between customers
1005 # though a partner.
1006 # - DEDICATED: A dedicated physical interconnection with the
1007 # customer.
1008 #
1009 #
1010 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
1011 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
1012 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
1013 # is essentially a hash of the labels set used for optimistic locking. The
1014 # fingerprint is initially generated by Compute Engine and changes after
1015 # every request to modify or update labels. You must always provide an
1016 # up-to-date fingerprint hash in order to update or change labels,
1017 # otherwise the request will fail with error412 conditionNotMet.
1018 #
1019 # To see the latest fingerprint, make a get() request to
1020 # retrieve an Interconnect.
1021 &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.
1022 # Label values may be empty.
1023 &quot;a_key&quot;: &quot;A String&quot;,
1024 },
1025 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
1026 #
1027 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
1028 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
1029 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
1030 #
1031 #
1032 # Note that this field indicates the speed of each of
1033 # the links in the bundle, not the speed of the entire bundle.
1034 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
1035 # connection is to be provisioned.
1036 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
1037 # Cloud Interconnect connection between Google and your on-premises router.
1038 # (MACsec) on this Cloud Interconnect connection between Google and your
1039 # on-premises router.
1040 &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
1041 # router to fallback to cleartext traffic if the MKA session cannot be
1042 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
1043 # MKA session cannot be established with your router.
1044 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
1045 # along with their start times. A MACsec CKN/CAK is generated for each
1046 # key in the key chain. Google router automatically picks the key with
1047 # the most recent startTime when establishing or re-establishing a MACsec
1048 # secure link.
1049 { # Describes a pre-shared key used to setup MACsec in static connectivity
1050 # association key (CAK) mode.
1051 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
1052 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1053 # characters long and match the regular expression
1054 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1055 # lowercase letter, and all following characters must be a dash,
1056 # lowercase letter, or digit, except the last character, which cannot be
1057 # a dash.
1058 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
1059 # valid. startTime can be in the future. If the keychain has a single
1060 # key, startTime can be omitted. If the keychain has multiple keys,
1061 # startTime is mandatory for each key. The start times of keys must be in
1062 # increasing order. The start times of two consecutive keys must be
1063 # at least 6 hours apart.
1064 },
1065 ],
1066 },
1067 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
1068 # fails if the MACsec object is not specified.
1069 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1070 # The name must be 1-63 characters long, and comply withRFC1035.
1071 # Specifically, the name must be 1-63 characters long and match the regular
1072 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1073 # character must be a lowercase letter, and all following characters must be
1074 # a dash, lowercase letter, or digit, except the last character, which cannot
1075 # be a dash.
1076 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
1077 # notifications regarding this Interconnect. If specified, this will be used
1078 # for notifications in addition to all other forms described, such as
1079 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
1080 # required for users who sign up for Cloud Interconnect using
1081 # workforce identity federation.
1082 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
1083 # which can take one of the following values:
1084 #
1085 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
1086 # use. Attachments may be provisioned on this Interconnect.
1087 #
1088 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
1089 # attachments may be provisioned on this Interconnect.
1090 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
1091 # maintenance. No attachments may be provisioned or updated on this
1092 # Interconnect.
1093 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1094 # as part of resource payload.
1095 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1096 # Tag keys and values have the same definition as resource
1097 # manager tags. The field is allowed for INSERT
1098 # only. The keys/values to set on the resource should be specified in
1099 # either ID { : } or Namespaced format
1100 # { : }.
1101 # For example the following are valid inputs:
1102 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1103 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1104 # Note:
1105 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1106 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1107 # * Inconsistent format is not supported. For instance:
1108 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1109 &quot;a_key&quot;: &quot;A String&quot;,
1110 },
1111 },
1112 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
1113 # Interconnect link. The customer should configure this IP address during
1114 # turnup when prompted by Google NOC. This can be used only for ping tests.
1115 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
1116 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
1117 # location outside of Google&#x27;s network that the interconnect is connected to.
1118 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
1119 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
1120 # Interconnect connection, which can take one of the following values:
1121 #
1122 # - IF_MACSEC: If specified, then the connection is created on MACsec
1123 # capable hardware ports. If not specified, non-MACsec capable ports will
1124 # also be considered.
1125 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
1126 # exclusively for Cross-Site Networking. The connection can not be used for
1127 # Cross-Site Networking unless this feature is specified.
1128 &quot;A String&quot;,
1129 ],
1130 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
1131 # customer.
1132 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1133 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1134 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
1135 # take one of the following values:
1136 #
1137 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
1138 # Attachments may be provisioned on this Interconnect.
1139 # - UNPROVISIONED: The Interconnect has not completed turnup. No
1140 # attachments may be provisioned on this Interconnect.
1141 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
1142 # No attachments may be provisioned or updated on this
1143 # Interconnect.
1144 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
1145 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
1146 # configured to use this Interconnect. The Interconnect cannot be deleted if
1147 # this list is non-empty.
1148 &quot;A String&quot;,
1149 ],
1150 }
1151
1152 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1153 that if you must retry your request, the server will know to ignore the
1154 request if it has already been completed.
1155
1156 For example, consider a situation where you make an initial request and
1157 the request times out. If you make the request again with the same
1158 request ID, the server can check if original operation with the same
1159 request ID was received, and if so, will ignore the second request. This
1160 prevents clients from accidentally creating duplicate commitments.
1161
1162 The request ID must be
1163 a valid UUID with the exception that zero UUID is not supported
1164 (00000000-0000-0000-0000-000000000000).
1165 x__xgafv: string, V1 error format.
1166 Allowed values
1167 1 - v1 error format
1168 2 - v2 error format
1169
1170 Returns:
1171 An object of the form:
1172
1173 { # Represents an Operation resource.
1174 #
1175 # Google Compute Engine has three Operation resources:
1176 #
1177 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1178 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1179 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1180 #
1181 # You can use an operation resource to manage asynchronous API requests.
1182 # For more information, readHandling
1183 # API responses.
1184 #
1185 # Operations can be global, regional or zonal.
1186 #
1187 # - For global operations, use the `globalOperations`
1188 # resource.
1189 # - For regional operations, use the
1190 # `regionOperations` resource.
1191 # - For zonal operations, use
1192 # the `zoneOperations` resource.
1193 #
1194 #
1195 #
1196 # For more information, read
1197 # Global, Regional, and Zonal Resources.
1198 #
1199 # Note that completed Operation resources have a limited
1200 # retention period.
1201 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1202 # Not present otherwise.
1203 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1204 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1205 # set when the operation is created.
1206 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1207 # text format.
1208 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1209 # this field will be populated.
1210 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1211 # operation.
1212 {
1213 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1214 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1215 # details. There is a set of defined message types to use for providing
1216 # details.The syntax depends on the error code. For example,
1217 # QuotaExceededInfo will have details when the error code is
1218 # QUOTA_EXCEEDED.
1219 {
1220 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1221 #
1222 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1223 # is not enabled:
1224 #
1225 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1226 # &quot;domain&quot;: &quot;googleapis.com&quot;
1227 # &quot;metadata&quot;: {
1228 # &quot;resource&quot;: &quot;projects/123&quot;,
1229 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1230 # }
1231 # }
1232 #
1233 # This response indicates that the pubsub.googleapis.com API is not enabled.
1234 #
1235 # Example of an error that is returned when attempting to create a Spanner
1236 # instance in a region that is out of stock:
1237 #
1238 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1239 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1240 # &quot;metadata&quot;: {
1241 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1242 # }
1243 # }
1244 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1245 # is typically the registered service name of the tool or product that
1246 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1247 # generated by some common infrastructure, the error domain must be a
1248 # globally unique value that identifies the infrastructure. For Google API
1249 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1250 &quot;metadatas&quot;: { # Additional structured details about this error.
1251 #
1252 # Keys must match a regular expression of `a-z+` but should
1253 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1254 # length. When identifying the current value of an exceeded limit, the units
1255 # should be contained in the key, not the value. For example, rather than
1256 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1257 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1258 # instances that can be created in a single (batch) request.
1259 &quot;a_key&quot;: &quot;A String&quot;,
1260 },
1261 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1262 # proximate cause of the error. Error reasons are unique within a particular
1263 # domain of errors. This should be at most 63 characters and match a
1264 # regular expression of `A-Z+[A-Z0-9]`, which represents
1265 # UPPER_SNAKE_CASE.
1266 },
1267 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1268 #
1269 # For example, if a quota check failed with an error indicating the calling
1270 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1271 # directly to the right place in the developer console to flip the bit.
1272 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1273 { # Describes a URL link.
1274 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1275 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1276 },
1277 ],
1278 },
1279 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1280 # which can be attached to an RPC error.
1281 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1282 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1283 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1284 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1285 },
1286 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1287 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1288 &quot;a_key&quot;: &quot;A String&quot;,
1289 },
1290 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1291 # type or metric.
1292 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1293 # or metric.
1294 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1295 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1296 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1297 },
1298 },
1299 ],
1300 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1301 # This property is optional.
1302 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1303 },
1304 ],
1305 },
1306 &quot;getVersionOperationMetadata&quot;: {
1307 &quot;inlineSbomInfo&quot;: {
1308 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1309 # appropriate identifiers.
1310 &quot;a_key&quot;: &quot;A String&quot;,
1311 },
1312 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1313 # identifiers.
1314 &quot;a_key&quot;: &quot;A String&quot;,
1315 },
1316 },
1317 },
1318 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1319 # message that was returned, such as `NOT FOUND`.
1320 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1321 # status code that was returned. For example, a `404` means the
1322 # resource was not found.
1323 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1324 # defined by the server.
1325 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1326 # This value is inRFC3339
1327 # text format.
1328 &quot;instancesBulkInsertOperationMetadata&quot;: {
1329 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1330 # Example key: zones/us-central1-a
1331 &quot;a_key&quot;: {
1332 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1333 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1334 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1335 # error.
1336 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1337 # if the flow is rolling forward or rolling back.
1338 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1339 },
1340 },
1341 },
1342 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1343 # Operation resources.
1344 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1345 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1346 # group of operations results from a `bulkInsert` API request.
1347 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1348 # `update`, or `delete`, and so on.
1349 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1350 # There is no requirement that this be linear or support any granularity of
1351 # operations. This should not be used to guess when the operation will be
1352 # complete. This number should monotonically increase as the operation
1353 # progresses.
1354 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1355 # applicable when performing regional operations.
1356 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1357 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1358 # this field will contain information on all underlying zonal actions and
1359 # their state.
1360 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1361 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1362 # Example key: zones/us-central1-a
1363 &quot;a_key&quot;: {
1364 &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
1365 # populated.
1366 # different programming environments, including REST APIs and RPC APIs. It is
1367 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1368 # three pieces of data: error code, error message, and error details.
1369 #
1370 # You can find out more about this error model and how to work with it in the
1371 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1372 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1373 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1374 # message types for APIs to use.
1375 {
1376 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1377 },
1378 ],
1379 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1380 # user-facing error message should be localized and sent in the
1381 # google.rpc.Status.details field, or localized by the client.
1382 },
1383 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1384 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1385 },
1386 },
1387 },
1388 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1389 # This value is inRFC3339
1390 # text format.
1391 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1392 # following:
1393 # `PENDING`, `RUNNING`, or `DONE`.
1394 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1395 # operation.
1396 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1397 # of the target resource.
1398 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1399 # operations related to creating a snapshot, this points to the disk
1400 # that the snapshot was created from.
1401 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1402 # `[email protected]` or
1403 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1404 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1405 # operation, this field will be populated.
1406 {
1407 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1408 # Engine returns NO_RESULTS_ON_PAGE if there
1409 # are no results in the response.
1410 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1411 # value format. For example:
1412 #
1413 # &quot;data&quot;: [
1414 # {
1415 # &quot;key&quot;: &quot;scope&quot;,
1416 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1417 # }
1418 {
1419 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1420 # returned. For example, for warnings where there are no results in a list
1421 # request for a particular zone, this key might be scope and
1422 # the key value might be the zone name. Other examples might be a key
1423 # indicating a deprecated resource and a suggested replacement, or a
1424 # warning about invalid network settings (for example, if an instance
1425 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1426 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1427 },
1428 ],
1429 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1430 },
1431 ],
1432 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1433 # applicable when performing per-zone operations.
1434 }</pre>
1435 </div>
1436
1437 <div class="method">
1438 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1439 <pre>Retrieves the list of Interconnects available to the specified project.
1440
1441 Args:
1442 project: string, Project ID for this request. (required)
1443 filter: string, A filter expression that filters resources listed in the response. Most
1444 Compute resources support two types of filter expressions:
1445 expressions that support regular expressions and expressions that follow
1446 API improvement proposal AIP-160.
1447 These two types of filter expressions cannot be mixed in one request.
1448
1449 If you want to use AIP-160, your expression must specify the field name, an
1450 operator, and the value that you want to use for filtering. The value
1451 must be a string, a number, or a boolean. The operator
1452 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1453
1454 For example, if you are filtering Compute Engine instances, you can
1455 exclude instances named `example-instance` by specifying
1456 `name != example-instance`.
1457
1458 The `:*` comparison can be used to test whether a key has been defined.
1459 For example, to find all objects with `owner` label use:
1460 ```
1461 labels.owner:*
1462 ```
1463
1464 You can also filter nested fields. For example, you could specify
1465 `scheduling.automaticRestart = false` to include instances only
1466 if they are not scheduled for automatic restarts. You can use filtering
1467 on nested fields to filter based onresource labels.
1468
1469 To filter on multiple expressions, provide each separate expression within
1470 parentheses. For example:
1471 ```
1472 (scheduling.automaticRestart = true)
1473 (cpuPlatform = &quot;Intel Skylake&quot;)
1474 ```
1475 By default, each expression is an `AND` expression. However, you
1476 can include `AND` and `OR` expressions explicitly.
1477 For example:
1478 ```
1479 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1480 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1481 (scheduling.automaticRestart = true)
1482 ```
1483
1484 If you want to use a regular expression, use the `eq` (equal) or `ne`
1485 (not equal) operator against a single un-parenthesized expression with or
1486 without quotes or against multiple parenthesized expressions. Examples:
1487
1488 `fieldname eq unquoted literal`
1489 `fieldname eq &#x27;single quoted literal&#x27;`
1490 `fieldname eq &quot;double quoted literal&quot;`
1491 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1492
1493 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1494 The literal value must match the entire field.
1495
1496 For example, to filter for instances that do not end with name &quot;instance&quot;,
1497 you would use `name ne .*instance`.
1498
1499 You cannot combine constraints on multiple fields using regular
1500 expressions.
1501 maxResults: integer, The maximum number of results per page that should be returned.
1502 If the number of available results is larger than `maxResults`,
1503 Compute Engine returns a `nextPageToken` that can be used to get
1504 the next page of results in subsequent list requests. Acceptable values are
1505 `0` to `500`, inclusive. (Default: `500`)
1506 orderBy: string, Sorts list results by a certain order. By default, results
1507 are returned in alphanumerical order based on the resource name.
1508
1509 You can also sort results in descending order based on the creation
1510 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1511 results based on the `creationTimestamp` field in
1512 reverse chronological order (newest result first). Use this to sort
1513 resources like operations so that the newest operation is returned first.
1514
1515 Currently, only sorting by `name` or
1516 `creationTimestamp desc` is supported.
1517 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1518 `nextPageToken` returned by a previous list request to get
1519 the next page of results.
1520 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1521 of failure. The default value is false.
1522
1523 For example, when partial success behavior is enabled, aggregatedList for a
1524 single zone scope either returns all resources in the zone or no resources,
1525 with an error code.
1526 x__xgafv: string, V1 error format.
1527 Allowed values
1528 1 - v1 error format
1529 2 - v2 error format
1530
1531 Returns:
1532 An object of the form:
1533
1534 { # Response to the list request, and contains a list of interconnects.
1535 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1536 &quot;items&quot;: [ # A list of Interconnect resources.
1537 { # Represents an Interconnect resource.
1538 #
1539 # An Interconnect resource is a dedicated connection between the Google
1540 # Cloud network and your on-premises network. For more information, read the
1541 # Dedicated Interconnect Overview.
1542 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
1543 # Interconnect.
1544 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
1545 # Interconnect is functional and can carry traffic.
1546 # When set to false, no packets can be carried over the interconnect and
1547 # no BGP routes are exchanged over it. By default, the status is set to true.
1548 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
1549 # Interconnect.
1550 # Interconnect.
1551 &quot;bandwidthPercentagePolicy&quot;: {
1552 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
1553 # type Bandwidth Percent.
1554 { # Specify bandwidth percentages [1-100] for various traffic classes in
1555 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1556 # All traffic classes must have a percentage value specified.
1557 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1558 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1559 },
1560 ],
1561 },
1562 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
1563 # Interconnect.
1564 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
1565 # applied in conjunction with StrictPriorityPolicy or
1566 # BandwidthPercentagePolicy.
1567 { # Specify bandwidth percentages [1-100] for various traffic classes in
1568 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1569 # All traffic classes must have a percentage value specified.
1570 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1571 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1572 },
1573 ],
1574 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
1575 },
1576 },
1577 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
1578 # which can take one of the following values:
1579 #
1580 # - IF_MACSEC: If present, then the Interconnect connection is
1581 # provisioned on MACsec capable hardware ports. If not present, then the
1582 # Interconnect connection is provisioned on non-MACsec capable ports. Any
1583 # attempt to enable MACsec will fail.
1584 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
1585 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
1586 # VLAN attachments will fail. If not present, then the Interconnect
1587 # connection is not provisioned for Cross-Site Networking. Any attempt to use
1588 # it for Cross-Site Networking will fail.
1589 &quot;A String&quot;,
1590 ],
1591 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
1592 # circuits in this LAG.
1593 { # Describes a single physical circuit between the Customer and Google.
1594 # CircuitInfo objects are created by Google, so all fields are output only.
1595 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
1596 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
1597 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
1598 # provided by Google to the customer in the LOA.
1599 },
1600 ],
1601 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1602 # text format.
1603 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
1604 # authorized to request a crossconnect.
1605 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1606 # create the resource.
1607 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
1608 # this connection is to be provisioned. By default it will be the same as the
1609 # location field.
1610 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
1611 { # Description of a planned outage on this Interconnect.
1612 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
1613 # IDs that will be affected.
1614 &quot;A String&quot;,
1615 ],
1616 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
1617 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
1618 # epoch).
1619 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
1620 # values:
1621 #
1622 # - OUTAGE: The Interconnect may be completely out of service for
1623 # some or all of the specified window.
1624 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
1625 # should remain up, but with reduced bandwidth.
1626 #
1627 #
1628 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
1629 # deprecated in favor of the unprefixed values.
1630 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
1631 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
1632 # value:
1633 #
1634 # - GOOGLE: this notification as generated by Google.
1635 #
1636 #
1637 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
1638 # GOOGLE.
1639 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
1640 # epoch).
1641 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
1642 #
1643 # - ACTIVE: This outage notification is active. The event could be in
1644 # the past, present, or future. See start_time and end_time for
1645 # scheduling.
1646 # - CANCELLED: The outage associated with this notification was cancelled
1647 # before the outage was due to start.
1648 # - COMPLETED: The outage associated with this notification is complete.
1649 #
1650 #
1651 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
1652 # deprecated in favor of the unprefixed values.
1653 },
1654 ],
1655 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
1656 # link. This can be used only for ping tests.
1657 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
1658 # with Google or otherwise to debug backend connectivity issues.
1659 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1660 # defined by the server.
1661 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
1662 # to use this Interconnect.
1663 &quot;A String&quot;,
1664 ],
1665 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
1666 # Order is arbitrary and items are unique.
1667 &quot;A String&quot;,
1668 ],
1669 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
1670 #
1671 # - PARTNER: A partner-managed interconnection shared between customers
1672 # though a partner.
1673 # - DEDICATED: A dedicated physical interconnection with the
1674 # customer.
1675 #
1676 #
1677 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
1678 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
1679 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
1680 # is essentially a hash of the labels set used for optimistic locking. The
1681 # fingerprint is initially generated by Compute Engine and changes after
1682 # every request to modify or update labels. You must always provide an
1683 # up-to-date fingerprint hash in order to update or change labels,
1684 # otherwise the request will fail with error412 conditionNotMet.
1685 #
1686 # To see the latest fingerprint, make a get() request to
1687 # retrieve an Interconnect.
1688 &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.
1689 # Label values may be empty.
1690 &quot;a_key&quot;: &quot;A String&quot;,
1691 },
1692 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
1693 #
1694 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
1695 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
1696 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
1697 #
1698 #
1699 # Note that this field indicates the speed of each of
1700 # the links in the bundle, not the speed of the entire bundle.
1701 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
1702 # connection is to be provisioned.
1703 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
1704 # Cloud Interconnect connection between Google and your on-premises router.
1705 # (MACsec) on this Cloud Interconnect connection between Google and your
1706 # on-premises router.
1707 &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
1708 # router to fallback to cleartext traffic if the MKA session cannot be
1709 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
1710 # MKA session cannot be established with your router.
1711 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
1712 # along with their start times. A MACsec CKN/CAK is generated for each
1713 # key in the key chain. Google router automatically picks the key with
1714 # the most recent startTime when establishing or re-establishing a MACsec
1715 # secure link.
1716 { # Describes a pre-shared key used to setup MACsec in static connectivity
1717 # association key (CAK) mode.
1718 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
1719 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
1720 # characters long and match the regular expression
1721 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
1722 # lowercase letter, and all following characters must be a dash,
1723 # lowercase letter, or digit, except the last character, which cannot be
1724 # a dash.
1725 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
1726 # valid. startTime can be in the future. If the keychain has a single
1727 # key, startTime can be omitted. If the keychain has multiple keys,
1728 # startTime is mandatory for each key. The start times of keys must be in
1729 # increasing order. The start times of two consecutive keys must be
1730 # at least 6 hours apart.
1731 },
1732 ],
1733 },
1734 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
1735 # fails if the MACsec object is not specified.
1736 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1737 # The name must be 1-63 characters long, and comply withRFC1035.
1738 # Specifically, the name must be 1-63 characters long and match the regular
1739 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1740 # character must be a lowercase letter, and all following characters must be
1741 # a dash, lowercase letter, or digit, except the last character, which cannot
1742 # be a dash.
1743 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
1744 # notifications regarding this Interconnect. If specified, this will be used
1745 # for notifications in addition to all other forms described, such as
1746 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
1747 # required for users who sign up for Cloud Interconnect using
1748 # workforce identity federation.
1749 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
1750 # which can take one of the following values:
1751 #
1752 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
1753 # use. Attachments may be provisioned on this Interconnect.
1754 #
1755 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
1756 # attachments may be provisioned on this Interconnect.
1757 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
1758 # maintenance. No attachments may be provisioned or updated on this
1759 # Interconnect.
1760 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1761 # as part of resource payload.
1762 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1763 # Tag keys and values have the same definition as resource
1764 # manager tags. The field is allowed for INSERT
1765 # only. The keys/values to set on the resource should be specified in
1766 # either ID { : } or Namespaced format
1767 # { : }.
1768 # For example the following are valid inputs:
1769 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1770 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1771 # Note:
1772 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1773 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1774 # * Inconsistent format is not supported. For instance:
1775 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1776 &quot;a_key&quot;: &quot;A String&quot;,
1777 },
1778 },
1779 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
1780 # Interconnect link. The customer should configure this IP address during
1781 # turnup when prompted by Google NOC. This can be used only for ping tests.
1782 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
1783 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
1784 # location outside of Google&#x27;s network that the interconnect is connected to.
1785 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
1786 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
1787 # Interconnect connection, which can take one of the following values:
1788 #
1789 # - IF_MACSEC: If specified, then the connection is created on MACsec
1790 # capable hardware ports. If not specified, non-MACsec capable ports will
1791 # also be considered.
1792 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
1793 # exclusively for Cross-Site Networking. The connection can not be used for
1794 # Cross-Site Networking unless this feature is specified.
1795 &quot;A String&quot;,
1796 ],
1797 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
1798 # customer.
1799 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1800 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1801 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
1802 # take one of the following values:
1803 #
1804 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
1805 # Attachments may be provisioned on this Interconnect.
1806 # - UNPROVISIONED: The Interconnect has not completed turnup. No
1807 # attachments may be provisioned on this Interconnect.
1808 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
1809 # No attachments may be provisioned or updated on this
1810 # Interconnect.
1811 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
1812 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
1813 # configured to use this Interconnect. The Interconnect cannot be deleted if
1814 # this list is non-empty.
1815 &quot;A String&quot;,
1816 ],
1817 },
1818 ],
1819 &quot;kind&quot;: &quot;compute#interconnectList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectList for lists of interconnects.
1820 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1821 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1822 # the query parameter pageToken in the next list request.
1823 # Subsequent list requests will have their own nextPageToken to
1824 # continue paging through the results.
1825 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1826 &quot;warning&quot;: { # [Output Only] Informational warning message.
1827 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1828 # Engine returns NO_RESULTS_ON_PAGE if there
1829 # are no results in the response.
1830 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1831 # value format. For example:
1832 #
1833 # &quot;data&quot;: [
1834 # {
1835 # &quot;key&quot;: &quot;scope&quot;,
1836 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1837 # }
1838 {
1839 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1840 # returned. For example, for warnings where there are no results in a list
1841 # request for a particular zone, this key might be scope and
1842 # the key value might be the zone name. Other examples might be a key
1843 # indicating a deprecated resource and a suggested replacement, or a
1844 # warning about invalid network settings (for example, if an instance
1845 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1846 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1847 },
1848 ],
1849 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1850 },
1851 }</pre>
1852 </div>
1853
1854 <div class="method">
1855 <code class="details" id="list_next">list_next()</code>
1856 <pre>Retrieves the next page of results.
1857
1858 Args:
1859 previous_request: The request for the previous page. (required)
1860 previous_response: The response from the request for the previous page. (required)
1861
1862 Returns:
1863 A request object that you can call &#x27;execute()&#x27; on to request the next
1864 page. Returns None if there are no more items in the collection.
1865 </pre>
1866 </div>
1867
1868 <div class="method">
1869 <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</code>
1870 <pre>Updates the specified Interconnect with the data included in the request.
1871 This method supportsPATCH
1872 semantics and uses theJSON merge
1873 patch format and processing rules.
1874
1875 Args:
1876 project: string, Project ID for this request. (required)
1877 interconnect: string, Name of the interconnect to update. (required)
1878 body: object, The request body.
1879 The object takes the form of:
1880
1881 { # Represents an Interconnect resource.
1882 #
1883 # An Interconnect resource is a dedicated connection between the Google
1884 # Cloud network and your on-premises network. For more information, read the
1885 # Dedicated Interconnect Overview.
1886 &quot;aaiEnabled&quot;: True or False, # Enable or disable the application awareness feature on this Cloud
1887 # Interconnect.
1888 &quot;adminEnabled&quot;: True or False, # Administrative status of the interconnect. When this is set to true, the
1889 # Interconnect is functional and can carry traffic.
1890 # When set to false, no packets can be carried over the interconnect and
1891 # no BGP routes are exchanged over it. By default, the status is set to true.
1892 &quot;applicationAwareInterconnect&quot;: { # Configuration information for application awareness on this Cloud # Configuration information for application awareness on this Cloud
1893 # Interconnect.
1894 # Interconnect.
1895 &quot;bandwidthPercentagePolicy&quot;: {
1896 &quot;bandwidthPercentages&quot;: [ # Specify bandwidth percentages for various traffic classes for queuing
1897 # type Bandwidth Percent.
1898 { # Specify bandwidth percentages [1-100] for various traffic classes in
1899 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1900 # All traffic classes must have a percentage value specified.
1901 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1902 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1903 },
1904 ],
1905 },
1906 &quot;profileDescription&quot;: &quot;A String&quot;, # Description for the application awareness profile on this Cloud
1907 # Interconnect.
1908 &quot;shapeAveragePercentages&quot;: [ # Optional field to specify a list of shape average percentages to be
1909 # applied in conjunction with StrictPriorityPolicy or
1910 # BandwidthPercentagePolicy.
1911 { # Specify bandwidth percentages [1-100] for various traffic classes in
1912 # BandwidthPercentagePolicy. The sum of all percentages must equal 100.
1913 # All traffic classes must have a percentage value specified.
1914 &quot;percentage&quot;: 42, # Bandwidth percentage for a specific traffic class.
1915 &quot;trafficClass&quot;: &quot;A String&quot;, # TrafficClass whose bandwidth percentage is being specified.
1916 },
1917 ],
1918 &quot;strictPriorityPolicy&quot;: { # Specify configuration for StrictPriorityPolicy.
1919 },
1920 },
1921 &quot;availableFeatures&quot;: [ # [Output only] List of features available for this Interconnect connection,
1922 # which can take one of the following values:
1923 #
1924 # - IF_MACSEC: If present, then the Interconnect connection is
1925 # provisioned on MACsec capable hardware ports. If not present, then the
1926 # Interconnect connection is provisioned on non-MACsec capable ports. Any
1927 # attempt to enable MACsec will fail.
1928 # - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
1929 # provisioned exclusively for Cross-Site Networking. Any attempt to configure
1930 # VLAN attachments will fail. If not present, then the Interconnect
1931 # connection is not provisioned for Cross-Site Networking. Any attempt to use
1932 # it for Cross-Site Networking will fail.
1933 &quot;A String&quot;,
1934 ],
1935 &quot;circuitInfos&quot;: [ # Output only. [Output Only] A list of CircuitInfo objects, that describe the individual
1936 # circuits in this LAG.
1937 { # Describes a single physical circuit between the Customer and Google.
1938 # CircuitInfo objects are created by Google, so all fields are output only.
1939 &quot;customerDemarcId&quot;: &quot;A String&quot;, # Customer-side demarc ID for this circuit.
1940 &quot;googleCircuitId&quot;: &quot;A String&quot;, # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
1941 &quot;googleDemarcId&quot;: &quot;A String&quot;, # Google-side demarc ID for this circuit. Assigned at circuit turn-up and
1942 # provided by Google to the customer in the LOA.
1943 },
1944 ],
1945 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1946 # text format.
1947 &quot;customerName&quot;: &quot;A String&quot;, # Customer name, to put in the Letter of Authorization as the party
1948 # authorized to request a crossconnect.
1949 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1950 # create the resource.
1951 &quot;effectiveLocation&quot;: &quot;A String&quot;, # Output only. URL of the InterconnectLocation object that represents where
1952 # this connection is to be provisioned. By default it will be the same as the
1953 # location field.
1954 &quot;expectedOutages&quot;: [ # Output only. [Output Only] A list of outages expected for this Interconnect.
1955 { # Description of a planned outage on this Interconnect.
1956 &quot;affectedCircuits&quot;: [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit
1957 # IDs that will be affected.
1958 &quot;A String&quot;,
1959 ],
1960 &quot;description&quot;: &quot;A String&quot;, # A description about the purpose of the outage.
1961 &quot;endTime&quot;: &quot;A String&quot;, # Scheduled end time for the outage (milliseconds since Unix
1962 # epoch).
1963 &quot;issueType&quot;: &quot;A String&quot;, # Form this outage is expected to take, which can take one of the following
1964 # values:
1965 #
1966 # - OUTAGE: The Interconnect may be completely out of service for
1967 # some or all of the specified window.
1968 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole
1969 # should remain up, but with reduced bandwidth.
1970 #
1971 #
1972 # Note that the versions of this enum prefixed with &quot;IT_&quot; have been
1973 # deprecated in favor of the unprefixed values.
1974 &quot;name&quot;: &quot;A String&quot;, # Unique identifier for this outage notification.
1975 &quot;source&quot;: &quot;A String&quot;, # The party that generated this notification, which can take the following
1976 # value:
1977 #
1978 # - GOOGLE: this notification as generated by Google.
1979 #
1980 #
1981 # Note that the value of NSRC_GOOGLE has been deprecated in favor of
1982 # GOOGLE.
1983 &quot;startTime&quot;: &quot;A String&quot;, # Scheduled start time for the outage (milliseconds since Unix
1984 # epoch).
1985 &quot;state&quot;: &quot;A String&quot;, # State of this notification, which can take one of the following values:
1986 #
1987 # - ACTIVE: This outage notification is active. The event could be in
1988 # the past, present, or future. See start_time and end_time for
1989 # scheduling.
1990 # - CANCELLED: The outage associated with this notification was cancelled
1991 # before the outage was due to start.
1992 # - COMPLETED: The outage associated with this notification is complete.
1993 #
1994 #
1995 # Note that the versions of this enum prefixed with &quot;NS_&quot; have been
1996 # deprecated in favor of the unprefixed values.
1997 },
1998 ],
1999 &quot;googleIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the Google side of the Interconnect
2000 # link. This can be used only for ping tests.
2001 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID to be used when raising support tickets
2002 # with Google or otherwise to debug backend connectivity issues.
2003 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2004 # defined by the server.
2005 &quot;interconnectAttachments&quot;: [ # Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured
2006 # to use this Interconnect.
2007 &quot;A String&quot;,
2008 ],
2009 &quot;interconnectGroups&quot;: [ # Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.
2010 # Order is arbitrary and items are unique.
2011 &quot;A String&quot;,
2012 ],
2013 &quot;interconnectType&quot;: &quot;A String&quot;, # Type of interconnect, which can take one of the following values:
2014 #
2015 # - PARTNER: A partner-managed interconnection shared between customers
2016 # though a partner.
2017 # - DEDICATED: A dedicated physical interconnection with the
2018 # customer.
2019 #
2020 #
2021 # Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
2022 &quot;kind&quot;: &quot;compute#interconnect&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.
2023 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this Interconnect, which
2024 # is essentially a hash of the labels set used for optimistic locking. The
2025 # fingerprint is initially generated by Compute Engine and changes after
2026 # every request to modify or update labels. You must always provide an
2027 # up-to-date fingerprint hash in order to update or change labels,
2028 # otherwise the request will fail with error412 conditionNotMet.
2029 #
2030 # To see the latest fingerprint, make a get() request to
2031 # retrieve an Interconnect.
2032 &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.
2033 # Label values may be empty.
2034 &quot;a_key&quot;: &quot;A String&quot;,
2035 },
2036 &quot;linkType&quot;: &quot;A String&quot;, # Type of link requested, which can take one of the following values:
2037 #
2038 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
2039 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
2040 # - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
2041 #
2042 #
2043 # Note that this field indicates the speed of each of
2044 # the links in the bundle, not the speed of the entire bundle.
2045 &quot;location&quot;: &quot;A String&quot;, # URL of the InterconnectLocation object that represents where this
2046 # connection is to be provisioned.
2047 &quot;macsec&quot;: { # Configuration information for enabling Media Access Control security # Configuration that enables Media Access Control security (MACsec) on the
2048 # Cloud Interconnect connection between Google and your on-premises router.
2049 # (MACsec) on this Cloud Interconnect connection between Google and your
2050 # on-premises router.
2051 &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
2052 # router to fallback to cleartext traffic if the MKA session cannot be
2053 # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the
2054 # MKA session cannot be established with your router.
2055 &quot;preSharedKeys&quot;: [ # Required. A keychain placeholder describing a set of named key objects
2056 # along with their start times. A MACsec CKN/CAK is generated for each
2057 # key in the key chain. Google router automatically picks the key with
2058 # the most recent startTime when establishing or re-establishing a MACsec
2059 # secure link.
2060 { # Describes a pre-shared key used to setup MACsec in static connectivity
2061 # association key (CAK) mode.
2062 &quot;name&quot;: &quot;A String&quot;, # Required. A name for this pre-shared key.
2063 # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
2064 # characters long and match the regular expression
2065 # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
2066 # lowercase letter, and all following characters must be a dash,
2067 # lowercase letter, or digit, except the last character, which cannot be
2068 # a dash.
2069 &quot;startTime&quot;: &quot;A String&quot;, # A RFC3339 timestamp on or after which the key is
2070 # valid. startTime can be in the future. If the keychain has a single
2071 # key, startTime can be omitted. If the keychain has multiple keys,
2072 # startTime is mandatory for each key. The start times of keys must be in
2073 # increasing order. The start times of two consecutive keys must be
2074 # at least 6 hours apart.
2075 },
2076 ],
2077 },
2078 &quot;macsecEnabled&quot;: True or False, # Enable or disable MACsec on this Interconnect connection. MACsec enablement
2079 # fails if the MACsec object is not specified.
2080 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2081 # The name must be 1-63 characters long, and comply withRFC1035.
2082 # Specifically, the name must be 1-63 characters long and match the regular
2083 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2084 # character must be a lowercase letter, and all following characters must be
2085 # a dash, lowercase letter, or digit, except the last character, which cannot
2086 # be a dash.
2087 &quot;nocContactEmail&quot;: &quot;A String&quot;, # Email address to contact the customer NOC for operations and maintenance
2088 # notifications regarding this Interconnect. If specified, this will be used
2089 # for notifications in addition to all other forms described, such as
2090 # Cloud Monitoring logs alerting and Cloud Notifications. This field is
2091 # required for users who sign up for Cloud Interconnect using
2092 # workforce identity federation.
2093 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of this Interconnect&#x27;s functionality,
2094 # which can take one of the following values:
2095 #
2096 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to
2097 # use. Attachments may be provisioned on this Interconnect.
2098 #
2099 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
2100 # attachments may be provisioned on this Interconnect.
2101 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
2102 # maintenance. No attachments may be provisioned or updated on this
2103 # Interconnect.
2104 &quot;params&quot;: { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2105 # as part of resource payload.
2106 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2107 # Tag keys and values have the same definition as resource
2108 # manager tags. The field is allowed for INSERT
2109 # only. The keys/values to set on the resource should be specified in
2110 # either ID { : } or Namespaced format
2111 # { : }.
2112 # For example the following are valid inputs:
2113 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2114 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2115 # Note:
2116 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2117 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2118 # * Inconsistent format is not supported. For instance:
2119 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2120 &quot;a_key&quot;: &quot;A String&quot;,
2121 },
2122 },
2123 &quot;peerIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IP address configured on the customer side of the
2124 # Interconnect link. The customer should configure this IP address during
2125 # turnup when prompted by Google NOC. This can be used only for ping tests.
2126 &quot;provisionedLinkCount&quot;: 42, # Output only. [Output Only] Number of links actually provisioned in this interconnect.
2127 &quot;remoteLocation&quot;: &quot;A String&quot;, # Indicates that this is a Cross-Cloud Interconnect. This field specifies the
2128 # location outside of Google&#x27;s network that the interconnect is connected to.
2129 &quot;requestedFeatures&quot;: [ # Optional. This parameter can be provided only with Interconnect INSERT. It
2130 # isn&#x27;t valid for Interconnect PATCH. List of features requested for this
2131 # Interconnect connection, which can take one of the following values:
2132 #
2133 # - IF_MACSEC: If specified, then the connection is created on MACsec
2134 # capable hardware ports. If not specified, non-MACsec capable ports will
2135 # also be considered.
2136 # - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
2137 # exclusively for Cross-Site Networking. The connection can not be used for
2138 # Cross-Site Networking unless this feature is specified.
2139 &quot;A String&quot;,
2140 ],
2141 &quot;requestedLinkCount&quot;: 42, # Target number of physical links in the link bundle, as requested by the
2142 # customer.
2143 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2144 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2145 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of Interconnect functionality, which can
2146 # take one of the following values:
2147 #
2148 # - ACTIVE: The Interconnect is valid, turned up and ready to use.
2149 # Attachments may be provisioned on this Interconnect.
2150 # - UNPROVISIONED: The Interconnect has not completed turnup. No
2151 # attachments may be provisioned on this Interconnect.
2152 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
2153 # No attachments may be provisioned or updated on this
2154 # Interconnect.
2155 &quot;subzone&quot;: &quot;A String&quot;, # To be deprecated.
2156 &quot;wireGroups&quot;: [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
2157 # configured to use this Interconnect. The Interconnect cannot be deleted if
2158 # this list is non-empty.
2159 &quot;A String&quot;,
2160 ],
2161 }
2162
2163 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2164 that if you must retry your request, the server will know to ignore the
2165 request if it has already been completed.
2166
2167 For example, consider a situation where you make an initial request and
2168 the request times out. If you make the request again with the same
2169 request ID, the server can check if original operation with the same
2170 request ID was received, and if so, will ignore the second request. This
2171 prevents clients from accidentally creating duplicate commitments.
2172
2173 The request ID must be
2174 a valid UUID with the exception that zero UUID is not supported
2175 (00000000-0000-0000-0000-000000000000).
2176 x__xgafv: string, V1 error format.
2177 Allowed values
2178 1 - v1 error format
2179 2 - v2 error format
2180
2181 Returns:
2182 An object of the form:
2183
2184 { # Represents an Operation resource.
2185 #
2186 # Google Compute Engine has three Operation resources:
2187 #
2188 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2189 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2190 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2191 #
2192 # You can use an operation resource to manage asynchronous API requests.
2193 # For more information, readHandling
2194 # API responses.
2195 #
2196 # Operations can be global, regional or zonal.
2197 #
2198 # - For global operations, use the `globalOperations`
2199 # resource.
2200 # - For regional operations, use the
2201 # `regionOperations` resource.
2202 # - For zonal operations, use
2203 # the `zoneOperations` resource.
2204 #
2205 #
2206 #
2207 # For more information, read
2208 # Global, Regional, and Zonal Resources.
2209 #
2210 # Note that completed Operation resources have a limited
2211 # retention period.
2212 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2213 # Not present otherwise.
2214 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2215 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2216 # set when the operation is created.
2217 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2218 # text format.
2219 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2220 # this field will be populated.
2221 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2222 # operation.
2223 {
2224 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2225 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2226 # details. There is a set of defined message types to use for providing
2227 # details.The syntax depends on the error code. For example,
2228 # QuotaExceededInfo will have details when the error code is
2229 # QUOTA_EXCEEDED.
2230 {
2231 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2232 #
2233 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2234 # is not enabled:
2235 #
2236 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2237 # &quot;domain&quot;: &quot;googleapis.com&quot;
2238 # &quot;metadata&quot;: {
2239 # &quot;resource&quot;: &quot;projects/123&quot;,
2240 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2241 # }
2242 # }
2243 #
2244 # This response indicates that the pubsub.googleapis.com API is not enabled.
2245 #
2246 # Example of an error that is returned when attempting to create a Spanner
2247 # instance in a region that is out of stock:
2248 #
2249 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2250 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2251 # &quot;metadata&quot;: {
2252 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2253 # }
2254 # }
2255 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2256 # is typically the registered service name of the tool or product that
2257 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2258 # generated by some common infrastructure, the error domain must be a
2259 # globally unique value that identifies the infrastructure. For Google API
2260 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2261 &quot;metadatas&quot;: { # Additional structured details about this error.
2262 #
2263 # Keys must match a regular expression of `a-z+` but should
2264 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2265 # length. When identifying the current value of an exceeded limit, the units
2266 # should be contained in the key, not the value. For example, rather than
2267 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2268 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2269 # instances that can be created in a single (batch) request.
2270 &quot;a_key&quot;: &quot;A String&quot;,
2271 },
2272 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2273 # proximate cause of the error. Error reasons are unique within a particular
2274 # domain of errors. This should be at most 63 characters and match a
2275 # regular expression of `A-Z+[A-Z0-9]`, which represents
2276 # UPPER_SNAKE_CASE.
2277 },
2278 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2279 #
2280 # For example, if a quota check failed with an error indicating the calling
2281 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2282 # directly to the right place in the developer console to flip the bit.
2283 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2284 { # Describes a URL link.
2285 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2286 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2287 },
2288 ],
2289 },
2290 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2291 # which can be attached to an RPC error.
2292 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2293 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2294 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2295 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2296 },
2297 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2298 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2299 &quot;a_key&quot;: &quot;A String&quot;,
2300 },
2301 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2302 # type or metric.
2303 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2304 # or metric.
2305 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2306 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2307 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2308 },
2309 },
2310 ],
2311 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2312 # This property is optional.
2313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2314 },
2315 ],
2316 },
2317 &quot;getVersionOperationMetadata&quot;: {
2318 &quot;inlineSbomInfo&quot;: {
2319 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2320 # appropriate identifiers.
2321 &quot;a_key&quot;: &quot;A String&quot;,
2322 },
2323 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2324 # identifiers.
2325 &quot;a_key&quot;: &quot;A String&quot;,
2326 },
2327 },
2328 },
2329 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2330 # message that was returned, such as `NOT FOUND`.
2331 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2332 # status code that was returned. For example, a `404` means the
2333 # resource was not found.
2334 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2335 # defined by the server.
2336 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2337 # This value is inRFC3339
2338 # text format.
2339 &quot;instancesBulkInsertOperationMetadata&quot;: {
2340 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2341 # Example key: zones/us-central1-a
2342 &quot;a_key&quot;: {
2343 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2344 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2345 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2346 # error.
2347 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2348 # if the flow is rolling forward or rolling back.
2349 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2350 },
2351 },
2352 },
2353 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2354 # Operation resources.
2355 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2356 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2357 # group of operations results from a `bulkInsert` API request.
2358 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2359 # `update`, or `delete`, and so on.
2360 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2361 # There is no requirement that this be linear or support any granularity of
2362 # operations. This should not be used to guess when the operation will be
2363 # complete. This number should monotonically increase as the operation
2364 # progresses.
2365 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2366 # applicable when performing regional operations.
2367 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2368 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2369 # this field will contain information on all underlying zonal actions and
2370 # their state.
2371 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2372 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2373 # Example key: zones/us-central1-a
2374 &quot;a_key&quot;: {
2375 &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
2376 # populated.
2377 # different programming environments, including REST APIs and RPC APIs. It is
2378 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2379 # three pieces of data: error code, error message, and error details.
2380 #
2381 # You can find out more about this error model and how to work with it in the
2382 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2383 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2384 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2385 # message types for APIs to use.
2386 {
2387 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2388 },
2389 ],
2390 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2391 # user-facing error message should be localized and sent in the
2392 # google.rpc.Status.details field, or localized by the client.
2393 },
2394 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2395 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2396 },
2397 },
2398 },
2399 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2400 # This value is inRFC3339
2401 # text format.
2402 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2403 # following:
2404 # `PENDING`, `RUNNING`, or `DONE`.
2405 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2406 # operation.
2407 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2408 # of the target resource.
2409 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2410 # operations related to creating a snapshot, this points to the disk
2411 # that the snapshot was created from.
2412 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2413 # `[email protected]` or
2414 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2415 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2416 # operation, this field will be populated.
2417 {
2418 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2419 # Engine returns NO_RESULTS_ON_PAGE if there
2420 # are no results in the response.
2421 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2422 # value format. For example:
2423 #
2424 # &quot;data&quot;: [
2425 # {
2426 # &quot;key&quot;: &quot;scope&quot;,
2427 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2428 # }
2429 {
2430 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2431 # returned. For example, for warnings where there are no results in a list
2432 # request for a particular zone, this key might be scope and
2433 # the key value might be the zone name. Other examples might be a key
2434 # indicating a deprecated resource and a suggested replacement, or a
2435 # warning about invalid network settings (for example, if an instance
2436 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2437 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2438 },
2439 ],
2440 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2441 },
2442 ],
2443 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2444 # applicable when performing per-zone operations.
2445 }</pre>
2446 </div>
2447
2448 <div class="method">
2449 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
2450 <pre>Sets the labels on an Interconnect. To learn more about labels,
2451 read the Labeling
2452 Resources documentation.
2453
2454 Args:
2455 project: string, Project ID for this request. (required)
2456 resource: string, Name or id of the resource for this request. (required)
2457 body: object, The request body.
2458 The object takes the form of:
2459
2460 {
2461 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
2462 # used to detect conflicts. The fingerprint is initially generated by Compute
2463 # Engine and changes after every request to modify or update labels. You must
2464 # always provide an up-to-date fingerprint hash when updating or changing
2465 # labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
2466 # resource to get the latest fingerprint.
2467 &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
2468 # the
2469 # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
2470 # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
2471 &quot;a_key&quot;: &quot;A String&quot;,
2472 },
2473 }
2474
2475 x__xgafv: string, V1 error format.
2476 Allowed values
2477 1 - v1 error format
2478 2 - v2 error format
2479
2480 Returns:
2481 An object of the form:
2482
2483 { # Represents an Operation resource.
2484 #
2485 # Google Compute Engine has three Operation resources:
2486 #
2487 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2488 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2489 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2490 #
2491 # You can use an operation resource to manage asynchronous API requests.
2492 # For more information, readHandling
2493 # API responses.
2494 #
2495 # Operations can be global, regional or zonal.
2496 #
2497 # - For global operations, use the `globalOperations`
2498 # resource.
2499 # - For regional operations, use the
2500 # `regionOperations` resource.
2501 # - For zonal operations, use
2502 # the `zoneOperations` resource.
2503 #
2504 #
2505 #
2506 # For more information, read
2507 # Global, Regional, and Zonal Resources.
2508 #
2509 # Note that completed Operation resources have a limited
2510 # retention period.
2511 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2512 # Not present otherwise.
2513 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2514 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2515 # set when the operation is created.
2516 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2517 # text format.
2518 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2519 # this field will be populated.
2520 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2521 # operation.
2522 {
2523 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2524 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2525 # details. There is a set of defined message types to use for providing
2526 # details.The syntax depends on the error code. For example,
2527 # QuotaExceededInfo will have details when the error code is
2528 # QUOTA_EXCEEDED.
2529 {
2530 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2531 #
2532 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2533 # is not enabled:
2534 #
2535 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2536 # &quot;domain&quot;: &quot;googleapis.com&quot;
2537 # &quot;metadata&quot;: {
2538 # &quot;resource&quot;: &quot;projects/123&quot;,
2539 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2540 # }
2541 # }
2542 #
2543 # This response indicates that the pubsub.googleapis.com API is not enabled.
2544 #
2545 # Example of an error that is returned when attempting to create a Spanner
2546 # instance in a region that is out of stock:
2547 #
2548 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2549 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2550 # &quot;metadata&quot;: {
2551 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2552 # }
2553 # }
2554 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2555 # is typically the registered service name of the tool or product that
2556 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2557 # generated by some common infrastructure, the error domain must be a
2558 # globally unique value that identifies the infrastructure. For Google API
2559 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2560 &quot;metadatas&quot;: { # Additional structured details about this error.
2561 #
2562 # Keys must match a regular expression of `a-z+` but should
2563 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2564 # length. When identifying the current value of an exceeded limit, the units
2565 # should be contained in the key, not the value. For example, rather than
2566 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2567 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2568 # instances that can be created in a single (batch) request.
2569 &quot;a_key&quot;: &quot;A String&quot;,
2570 },
2571 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2572 # proximate cause of the error. Error reasons are unique within a particular
2573 # domain of errors. This should be at most 63 characters and match a
2574 # regular expression of `A-Z+[A-Z0-9]`, which represents
2575 # UPPER_SNAKE_CASE.
2576 },
2577 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2578 #
2579 # For example, if a quota check failed with an error indicating the calling
2580 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2581 # directly to the right place in the developer console to flip the bit.
2582 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2583 { # Describes a URL link.
2584 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2585 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2586 },
2587 ],
2588 },
2589 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2590 # which can be attached to an RPC error.
2591 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2592 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2593 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2594 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2595 },
2596 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2597 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2598 &quot;a_key&quot;: &quot;A String&quot;,
2599 },
2600 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2601 # type or metric.
2602 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2603 # or metric.
2604 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2605 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2606 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2607 },
2608 },
2609 ],
2610 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2611 # This property is optional.
2612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2613 },
2614 ],
2615 },
2616 &quot;getVersionOperationMetadata&quot;: {
2617 &quot;inlineSbomInfo&quot;: {
2618 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2619 # appropriate identifiers.
2620 &quot;a_key&quot;: &quot;A String&quot;,
2621 },
2622 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2623 # identifiers.
2624 &quot;a_key&quot;: &quot;A String&quot;,
2625 },
2626 },
2627 },
2628 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2629 # message that was returned, such as `NOT FOUND`.
2630 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2631 # status code that was returned. For example, a `404` means the
2632 # resource was not found.
2633 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2634 # defined by the server.
2635 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2636 # This value is inRFC3339
2637 # text format.
2638 &quot;instancesBulkInsertOperationMetadata&quot;: {
2639 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2640 # Example key: zones/us-central1-a
2641 &quot;a_key&quot;: {
2642 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2643 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2644 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2645 # error.
2646 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2647 # if the flow is rolling forward or rolling back.
2648 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2649 },
2650 },
2651 },
2652 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2653 # Operation resources.
2654 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2655 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2656 # group of operations results from a `bulkInsert` API request.
2657 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2658 # `update`, or `delete`, and so on.
2659 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2660 # There is no requirement that this be linear or support any granularity of
2661 # operations. This should not be used to guess when the operation will be
2662 # complete. This number should monotonically increase as the operation
2663 # progresses.
2664 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2665 # applicable when performing regional operations.
2666 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2667 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2668 # this field will contain information on all underlying zonal actions and
2669 # their state.
2670 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2671 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2672 # Example key: zones/us-central1-a
2673 &quot;a_key&quot;: {
2674 &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
2675 # populated.
2676 # different programming environments, including REST APIs and RPC APIs. It is
2677 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2678 # three pieces of data: error code, error message, and error details.
2679 #
2680 # You can find out more about this error model and how to work with it in the
2681 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2682 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2683 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2684 # message types for APIs to use.
2685 {
2686 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2687 },
2688 ],
2689 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2690 # user-facing error message should be localized and sent in the
2691 # google.rpc.Status.details field, or localized by the client.
2692 },
2693 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2694 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2695 },
2696 },
2697 },
2698 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2699 # This value is inRFC3339
2700 # text format.
2701 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2702 # following:
2703 # `PENDING`, `RUNNING`, or `DONE`.
2704 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2705 # operation.
2706 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2707 # of the target resource.
2708 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2709 # operations related to creating a snapshot, this points to the disk
2710 # that the snapshot was created from.
2711 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2712 # `[email protected]` or
2713 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2714 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2715 # operation, this field will be populated.
2716 {
2717 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2718 # Engine returns NO_RESULTS_ON_PAGE if there
2719 # are no results in the response.
2720 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2721 # value format. For example:
2722 #
2723 # &quot;data&quot;: [
2724 # {
2725 # &quot;key&quot;: &quot;scope&quot;,
2726 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2727 # }
2728 {
2729 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2730 # returned. For example, for warnings where there are no results in a list
2731 # request for a particular zone, this key might be scope and
2732 # the key value might be the zone name. Other examples might be a key
2733 # indicating a deprecated resource and a suggested replacement, or a
2734 # warning about invalid network settings (for example, if an instance
2735 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2736 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2737 },
2738 ],
2739 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2740 },
2741 ],
2742 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2743 # applicable when performing per-zone operations.
2744 }</pre>
2745 </div>
2746
2747 <div class="method">
2748 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
2749 <pre>Returns permissions that a caller has on the specified resource.
2750
2751 Args:
2752 project: string, Project ID for this request. (required)
2753 resource: string, Name or id of the resource for this request. (required)
2754 body: object, The request body.
2755 The object takes the form of:
2756
2757 {
2758 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2759 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2760 &quot;A String&quot;,
2761 ],
2762 }
2763
2764 x__xgafv: string, V1 error format.
2765 Allowed values
2766 1 - v1 error format
2767 2 - v2 error format
2768
2769 Returns:
2770 An object of the form:
2771
2772 {
2773 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2774 # allowed.
2775 &quot;A String&quot;,
2776 ],
2777 }</pre>
2778 </div>
2779
2780 </body></html>