Debian Codegraph @

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