Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.interconnects.html
blob: c42e60031bb9ce0acefdb6c74eead9e346bff44b [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="#delete">delete(project, interconnect, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified interconnect.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, interconnect)</a></code></p>
82<p class="firstline">Returns the specified interconnect. Get a list of available interconnects by making a list() request.</p>
83<p class="toc_element">
84 <code><a href="#getDiagnostics">getDiagnostics(project, interconnect)</a></code></p>
85<p class="firstline">Returns the interconnectDiagnostics for the specified interconnect.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Creates a Interconnect in the specified project using the data included in the request.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves the list of interconnect available to the specified project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#patch">patch(project, interconnect, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, interconnect, requestId=None)</code>
101 <pre>Deletes the specified interconnect.
102
103Args:
104 project: string, Project ID for this request. (required)
105 interconnect: string, Name of the interconnect to delete. (required)
106 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
107
108For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
109
110The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
111
112Returns:
113 An object of the form:
114
115 { # Represents an Operation resource.
116 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 # Google Compute Engine has three Operation resources:
118 #
119 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
120 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
122 #
123 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 # - For global operations, use the `globalOperations` resource.
125 # - For regional operations, use the `regionOperations` resource.
126 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
130 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
131 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
134 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
136 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
142 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
143 {
144 "message": "A String", # [Output Only] A human-readable description of the warning code.
145 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
148 {
149 "value": "A String", # [Output Only] A warning data value corresponding to the key.
150 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
151 },
152 ],
153 },
154 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
158 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
160 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
161 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
162 {
163 "message": "A String", # [Output Only] An optional, human-readable error message.
164 "code": "A String", # [Output Only] The error type identifier for this error.
165 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
166 },
167 ],
168 },
169 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
170 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
171 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="get">get(project, interconnect)</code>
177 <pre>Returns the specified interconnect. Get a list of available interconnects by making a list() request.
178
179Args:
180 project: string, Project ID for this request. (required)
181 interconnect: string, Name of the interconnect to return. (required)
182
183Returns:
184 An object of the form:
185
186 { # Represents an Interconnect resource.
187 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "linkType": "A String", # Type of link requested, which can take one of the following values:
190 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
191 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
192 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
193 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
194 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4
195 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
196 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
197 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
198 },
199 ],
200 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
201 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
203 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
204 "A String",
205 ],
206 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
207 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
208 { # Description of a planned outage on this Interconnect. Next id: 9
209 "description": "A String", # A description about the purpose of the outage.
210 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
211 "A String",
212 ],
213 "source": "A String", # The party that generated this notification, which can take the following value:
214 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
215 "state": "A String", # State of this notification, which can take one of the following values:
216 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
217 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
218 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
219 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
220 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
221 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
222 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
223 "name": "A String", # Unique identifier for this outage notification.
224 },
225 ],
226 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.
227 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
228 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
229 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
230 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
231 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
232 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
233 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
234 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
235 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
236 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
237 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
238 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
239 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
240 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
241 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
242 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
243 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
244 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
245 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
246 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect)</code>
252 <pre>Returns the interconnectDiagnostics for the specified interconnect.
253
254Args:
255 project: string, Project ID for this request. (required)
256 interconnect: string, Name of the interconnect resource to query. (required)
257
258Returns:
259 An object of the form:
260
261 { # Response for the InterconnectsGetDiagnosticsRequest.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 "result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "macAddress": "A String", # The MAC address of the Interconnect's bundle interface.
264 "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.
265 { # Describing the ARP neighbor entries seen on this link
266 "macAddress": "A String", # The MAC address of this ARP neighbor.
267 "ipAddress": "A String", # The IP address of this ARP neighbor.
268 },
269 ],
270 "links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.
271 {
272 "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled
273 { # Describing the ARP neighbor entries seen on this link
274 "macAddress": "A String", # The MAC address of this ARP neighbor.
275 "ipAddress": "A String", # The IP address of this ARP neighbor.
276 },
277 ],
278 "circuitId": "A String", # The unique ID for this link assigned during turn up by Google.
279 "receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.
280 "state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:
281 # - OK: The value has not crossed a warning threshold.
282 # - LOW_WARNING: The value has crossed below the low warning threshold.
283 # - HIGH_WARNING: The value has crossed above the high warning threshold.
284 # - LOW_ALARM: The value has crossed below the low alarm threshold.
285 # - HIGH_ALARM: The value has crossed above the high alarm threshold.
286 "value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.
287 },
288 "googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA.
289 "lacpStatus": {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]290 "neighborSystemId": "A String", # System ID of the port on the neighbor's side of the LACP exchange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 "state": "A String", # The state of a LACP link, which can take one of the following values:
292 # - ACTIVE: The link is configured and active within the bundle.
293 # - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "googleSystemId": "A String", # System ID of the port on Google's side of the LACP exchange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 },
296 "transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.
297 "state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:
298 # - OK: The value has not crossed a warning threshold.
299 # - LOW_WARNING: The value has crossed below the low warning threshold.
300 # - HIGH_WARNING: The value has crossed above the high warning threshold.
301 # - LOW_ALARM: The value has crossed below the low alarm threshold.
302 # - HIGH_ALARM: The value has crossed above the high alarm threshold.
303 "value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.
304 },
305 },
306 ],
307 },
308 }</pre>
309</div>
310
311<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 <pre>Creates a Interconnect in the specified project using the data included in the request.
314
315Args:
316 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]317 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 The object takes the form of:
319
320{ # Represents an Interconnect resource.
321 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]322 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]323 "linkType": "A String", # Type of link requested, which can take one of the following values:
324 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
325 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
326 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
327 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
328 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4
329 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
330 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
331 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
332 },
333 ],
334 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
335 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
336 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
337 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
338 "A String",
339 ],
340 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
341 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
342 { # Description of a planned outage on this Interconnect. Next id: 9
343 "description": "A String", # A description about the purpose of the outage.
344 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
345 "A String",
346 ],
347 "source": "A String", # The party that generated this notification, which can take the following value:
348 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
349 "state": "A String", # State of this notification, which can take one of the following values:
350 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
351 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
352 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
353 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
354 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
355 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
356 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
357 "name": "A String", # Unique identifier for this outage notification.
358 },
359 ],
360 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.
361 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
362 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
363 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
364 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
365 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
366 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
367 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
368 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
369 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
370 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
371 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
372 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
373 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
374 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
375 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
376 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
377 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
378 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
379 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
380 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
381 }
382
383 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
384
385For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
386
387The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
388
389Returns:
390 An object of the form:
391
392 { # Represents an Operation resource.
393 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 # Google Compute Engine has three Operation resources:
395 #
396 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
397 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
399 #
400 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 # - For global operations, use the `globalOperations` resource.
402 # - For regional operations, use the `regionOperations` resource.
403 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
407 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
408 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
411 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
413 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]415 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
419 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
420 {
421 "message": "A String", # [Output Only] A human-readable description of the warning code.
422 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
423 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
424 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
425 {
426 "value": "A String", # [Output Only] A warning data value corresponding to the key.
427 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
428 },
429 ],
430 },
431 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
435 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
437 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
438 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
439 {
440 "message": "A String", # [Output Only] An optional, human-readable error message.
441 "code": "A String", # [Output Only] The error type identifier for this error.
442 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
443 },
444 ],
445 },
446 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
447 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
448 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
449 }</pre>
450</div>
451
452<div class="method">
453 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
454 <pre>Retrieves the list of interconnect available to the specified project.
455
456Args:
457 project: string, Project ID for this request. (required)
458 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
459
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462Currently, only sorting by `name` or `creationTimestamp desc` is supported.
463 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
464 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
465 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]467For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]469You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]471To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]472
473Returns:
474 An object of the form:
475
476 { # Response to the list request, and contains a list of interconnects.
477 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
478 "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.
479 "items": [ # A list of Interconnect resources.
480 { # Represents an Interconnect resource.
481 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 "linkType": "A String", # Type of link requested, which can take one of the following values:
484 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
485 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
486 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
487 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
488 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4
489 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
490 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
491 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
492 },
493 ],
494 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
495 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
496 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
497 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
498 "A String",
499 ],
500 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
501 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
502 { # Description of a planned outage on this Interconnect. Next id: 9
503 "description": "A String", # A description about the purpose of the outage.
504 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
505 "A String",
506 ],
507 "source": "A String", # The party that generated this notification, which can take the following value:
508 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
509 "state": "A String", # State of this notification, which can take one of the following values:
510 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
511 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
512 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
513 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
514 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
515 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
516 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
517 "name": "A String", # Unique identifier for this outage notification.
518 },
519 ],
520 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.
521 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
522 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
523 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
524 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
525 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
526 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
527 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
528 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
529 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
530 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
531 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
532 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
533 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
534 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
535 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
536 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
537 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
538 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
539 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
540 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
541 },
542 ],
543 "warning": { # [Output Only] Informational warning message.
544 "message": "A String", # [Output Only] A human-readable description of the warning code.
545 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
546 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
547 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
548 {
549 "value": "A String", # [Output Only] A warning data value corresponding to the key.
550 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
551 },
552 ],
553 },
554 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
555 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
556 }</pre>
557</div>
558
559<div class="method">
560 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
561 <pre>Retrieves the next page of results.
562
563Args:
564 previous_request: The request for the previous page. (required)
565 previous_response: The response from the request for the previous page. (required)
566
567Returns:
568 A request object that you can call 'execute()' on to request the next
569 page. Returns None if there are no more items in the collection.
570 </pre>
571</div>
572
573<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]574 <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]575 <pre>Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
576
577Args:
578 project: string, Project ID for this request. (required)
579 interconnect: string, Name of the interconnect to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 The object takes the form of:
582
583{ # Represents an Interconnect resource.
584 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]585 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]586 "linkType": "A String", # Type of link requested, which can take one of the following values:
587 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
588 # - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
589 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
590 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
591 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4
592 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
593 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
594 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
595 },
596 ],
597 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.
598 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
599 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
600 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
601 "A String",
602 ],
603 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
604 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
605 { # Description of a planned outage on this Interconnect. Next id: 9
606 "description": "A String", # A description about the purpose of the outage.
607 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
608 "A String",
609 ],
610 "source": "A String", # The party that generated this notification, which can take the following value:
611 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
612 "state": "A String", # State of this notification, which can take one of the following values:
613 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
614 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
615 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
616 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
617 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
618 # - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
619 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
620 "name": "A String", # Unique identifier for this outage notification.
621 },
622 ],
623 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.
624 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
625 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
626 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
627 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
628 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
629 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
630 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
631 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
632 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
633 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
634 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
635 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
636 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
637 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
638 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
639 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
640 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
641 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
642 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
643 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
644 }
645
646 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
647
648For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
649
650The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
651
652Returns:
653 An object of the form:
654
655 { # Represents an Operation resource.
656 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]657 # Google Compute Engine has three Operation resources:
658 #
659 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
660 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
662 #
663 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]664 # - For global operations, use the `globalOperations` resource.
665 # - For regional operations, use the `regionOperations` resource.
666 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]668 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]669 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
670 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
671 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]672 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]673 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
674 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
676 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]678 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]679 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]680 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]681 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
682 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
683 {
684 "message": "A String", # [Output Only] A human-readable description of the warning code.
685 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
686 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
687 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
688 {
689 "value": "A String", # [Output Only] A warning data value corresponding to the key.
690 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
691 },
692 ],
693 },
694 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]695 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]696 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]697 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
698 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]699 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
700 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
701 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
702 {
703 "message": "A String", # [Output Only] An optional, human-readable error message.
704 "code": "A String", # [Output Only] The error type identifier for this error.
705 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
706 },
707 ],
708 },
709 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
710 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
711 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
712 }</pre>
713</div>
714
715</body></html>