blob: 7e8c9fe6d1a4f8d15837c5fa05c40010b3285df2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_beta.html">Compute Engine API</a> . <a href="compute_beta.interconnects.html">interconnects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#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 -070087 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<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 -070096 <code><a href="#patch">patch(project, interconnect, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<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<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#setLabels">setLabels(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(project, interconnect, requestId=None)</code>
107 <pre>Deletes the specified interconnect.
108
109Args:
110 project: string, Project ID for this request. (required)
111 interconnect: string, Name of the interconnect to delete. (required)
112 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.
113
114For 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.
115
116The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
117
118Returns:
119 An object of the form:
120
121 { # Represents an Operation resource.
122 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700123 # Google Compute Engine has three Operation resources:
124 #
125 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
126 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
128 #
129 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700130 # - For global operations, use the `globalOperations` resource.
131 # - For regional operations, use the `regionOperations` resource.
132 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700134 # 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 -0700135 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
136 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
137 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 "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 -0700139 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
140 "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 -0700141 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
142 "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 -0700143 "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 -0700144 "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 -0700145 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700146 "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 -0700147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
148 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
149 {
150 "message": "A String", # [Output Only] A human-readable description of the warning code.
151 "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.
152 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
153 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
154 {
155 "value": "A String", # [Output Only] A warning data value corresponding to the key.
156 "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).
157 },
158 ],
159 },
160 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700161 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 "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 -0700163 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
164 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700165 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
166 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
167 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
168 {
169 "message": "A String", # [Output Only] An optional, human-readable error message.
170 "code": "A String", # [Output Only] The error type identifier for this error.
171 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
172 },
173 ],
174 },
175 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
177 "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.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="get">get(project, interconnect)</code>
183 <pre>Returns the specified interconnect. Get a list of available interconnects by making a list() request.
184
185Args:
186 project: string, Project ID for this request. (required)
187 interconnect: string, Name of the interconnect to return. (required)
188
189Returns:
190 An object of the form:
191
192 { # Represents an Interconnect resource.
193 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700194 # 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 -0700195 "linkType": "A String", # Type of link requested, which can take one of the following values:
196 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
197 # - 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.
198 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
199 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
200 { # 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
201 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
202 "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.
203 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
204 },
205 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700206 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700207 "a_key": "A String",
208 },
209 "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.
210 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
211 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
212 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
213 "A String",
214 ],
215 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
216 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
217 { # Description of a planned outage on this Interconnect. Next id: 9
218 "description": "A String", # A description about the purpose of the outage.
219 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
220 "A String",
221 ],
222 "source": "A String", # The party that generated this notification, which can take the following value:
223 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
224 "state": "A String", # State of this notification, which can take one of the following values:
225 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
226 # - 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.
227 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
228 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
229 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
230 # - 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.
231 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
232 "name": "A String", # Unique identifier for this outage notification.
233 },
234 ],
235 "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.
236 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
237 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
238 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
239 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
240 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
241 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
242 "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.
243 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
244 #
245 # To see the latest fingerprint, make a get() request to retrieve an Interconnect.
246 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
247 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
248 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
249 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
250 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
251 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
252 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
253 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
254 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
255 "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.
256 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
257 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
258 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect)</code>
264 <pre>Returns the interconnectDiagnostics for the specified interconnect.
265
266Args:
267 project: string, Project ID for this request. (required)
268 interconnect: string, Name of the interconnect resource to query. (required)
269
270Returns:
271 An object of the form:
272
273 { # Response for the InterconnectsGetDiagnosticsRequest.
Dan O'Mearadd494642020-05-01 07:42:23 -0700274 "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 -0700275 "macAddress": "A String", # The MAC address of the Interconnect's bundle interface.
276 "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.
277 { # Describing the ARP neighbor entries seen on this link
278 "macAddress": "A String", # The MAC address of this ARP neighbor.
279 "ipAddress": "A String", # The IP address of this ARP neighbor.
280 },
281 ],
282 "links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.
283 {
284 "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
285 { # Describing the ARP neighbor entries seen on this link
286 "macAddress": "A String", # The MAC address of this ARP neighbor.
287 "ipAddress": "A String", # The IP address of this ARP neighbor.
288 },
289 ],
290 "circuitId": "A String", # The unique ID for this link assigned during turn up by Google.
291 "receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.
292 "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:
293 # - OK: The value has not crossed a warning threshold.
294 # - LOW_WARNING: The value has crossed below the low warning threshold.
295 # - HIGH_WARNING: The value has crossed above the high warning threshold.
296 # - LOW_ALARM: The value has crossed below the low alarm threshold.
297 # - HIGH_ALARM: The value has crossed above the high alarm threshold.
298 "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.
299 },
300 "googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA.
301 "lacpStatus": {
Dan O'Mearadd494642020-05-01 07:42:23 -0700302 "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 -0700303 "state": "A String", # The state of a LACP link, which can take one of the following values:
304 # - ACTIVE: The link is configured and active within the bundle.
305 # - 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 -0700306 "googleSystemId": "A String", # System ID of the port on Google's side of the LACP exchange.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700307 },
308 "transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.
309 "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:
310 # - OK: The value has not crossed a warning threshold.
311 # - LOW_WARNING: The value has crossed below the low warning threshold.
312 # - HIGH_WARNING: The value has crossed above the high warning threshold.
313 # - LOW_ALARM: The value has crossed below the low alarm threshold.
314 # - HIGH_ALARM: The value has crossed above the high alarm threshold.
315 "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.
316 },
317 },
318 ],
319 },
320 }</pre>
321</div>
322
323<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700324 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700325 <pre>Creates a Interconnect in the specified project using the data included in the request.
326
327Args:
328 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700329 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330 The object takes the form of:
331
332{ # Represents an Interconnect resource.
333 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700334 # 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 -0700335 "linkType": "A String", # Type of link requested, which can take one of the following values:
336 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
337 # - 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.
338 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
339 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
340 { # 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
341 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
342 "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.
343 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
344 },
345 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700346 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700347 "a_key": "A String",
348 },
349 "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.
350 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
351 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
352 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
353 "A String",
354 ],
355 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
356 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
357 { # Description of a planned outage on this Interconnect. Next id: 9
358 "description": "A String", # A description about the purpose of the outage.
359 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
360 "A String",
361 ],
362 "source": "A String", # The party that generated this notification, which can take the following value:
363 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
364 "state": "A String", # State of this notification, which can take one of the following values:
365 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
366 # - 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.
367 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
368 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
369 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
370 # - 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.
371 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
372 "name": "A String", # Unique identifier for this outage notification.
373 },
374 ],
375 "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.
376 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
377 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
378 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
379 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
380 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
381 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
382 "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.
383 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
384 #
385 # To see the latest fingerprint, make a get() request to retrieve an Interconnect.
386 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
387 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
388 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
389 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
390 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
391 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
392 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
393 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
394 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
395 "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.
396 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
397 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
398 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
399 }
400
401 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.
402
403For 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.
404
405The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
406
407Returns:
408 An object of the form:
409
410 { # Represents an Operation resource.
411 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700412 # Google Compute Engine has three Operation resources:
413 #
414 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
415 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700416 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
417 #
418 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700419 # - For global operations, use the `globalOperations` resource.
420 # - For regional operations, use the `regionOperations` resource.
421 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700423 # 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 -0700424 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
425 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
426 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700427 "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 -0700428 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
429 "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 -0700430 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
431 "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 -0700432 "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 -0700433 "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 -0700434 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700435 "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 -0700436 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
437 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
438 {
439 "message": "A String", # [Output Only] A human-readable description of the warning code.
440 "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.
441 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
442 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
443 {
444 "value": "A String", # [Output Only] A warning data value corresponding to the key.
445 "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).
446 },
447 ],
448 },
449 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451 "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 -0700452 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
453 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700454 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
455 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
456 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
457 {
458 "message": "A String", # [Output Only] An optional, human-readable error message.
459 "code": "A String", # [Output Only] The error type identifier for this error.
460 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
461 },
462 ],
463 },
464 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
465 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
466 "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.
467 }</pre>
468</div>
469
470<div class="method">
471 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
472 <pre>Retrieves the list of interconnect available to the specified project.
473
474Args:
475 project: string, Project ID for this request. (required)
476 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
477
Dan O'Mearadd494642020-05-01 07:42:23 -0700478You 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 -0700479
Dan O'Mearadd494642020-05-01 07:42:23 -0700480Currently, only sorting by `name` or `creationTimestamp desc` is supported.
481 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`)
482 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.
483 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 -0700484
Dan O'Mearadd494642020-05-01 07:42:23 -0700485For 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 -0700486
Dan O'Mearadd494642020-05-01 07:42:23 -0700487You 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 -0700488
Dan O'Mearadd494642020-05-01 07:42:23 -0700489To 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 -0700490
491Returns:
492 An object of the form:
493
494 { # Response to the list request, and contains a list of interconnects.
495 "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.
496 "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.
497 "items": [ # A list of Interconnect resources.
498 { # Represents an Interconnect resource.
499 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700500 # 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 -0700501 "linkType": "A String", # Type of link requested, which can take one of the following values:
502 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
503 # - 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.
504 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
505 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
506 { # 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
507 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
508 "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.
509 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
510 },
511 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700512 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700513 "a_key": "A String",
514 },
515 "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.
516 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
517 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
518 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
519 "A String",
520 ],
521 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
522 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
523 { # Description of a planned outage on this Interconnect. Next id: 9
524 "description": "A String", # A description about the purpose of the outage.
525 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
526 "A String",
527 ],
528 "source": "A String", # The party that generated this notification, which can take the following value:
529 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
530 "state": "A String", # State of this notification, which can take one of the following values:
531 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
532 # - 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.
533 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
534 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
535 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
536 # - 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.
537 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
538 "name": "A String", # Unique identifier for this outage notification.
539 },
540 ],
541 "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.
542 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
543 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
544 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
545 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
546 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
547 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
548 "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.
549 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
550 #
551 # To see the latest fingerprint, make a get() request to retrieve an Interconnect.
552 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
553 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
554 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
555 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
556 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
557 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
558 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
559 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
560 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
561 "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.
562 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
563 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
564 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
565 },
566 ],
567 "warning": { # [Output Only] Informational warning message.
568 "message": "A String", # [Output Only] A human-readable description of the warning code.
569 "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.
570 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
571 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
572 {
573 "value": "A String", # [Output Only] A warning data value corresponding to the key.
574 "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).
575 },
576 ],
577 },
578 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
579 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
580 }</pre>
581</div>
582
583<div class="method">
584 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
585 <pre>Retrieves the next page of results.
586
587Args:
588 previous_request: The request for the previous page. (required)
589 previous_response: The response from the request for the previous page. (required)
590
591Returns:
592 A request object that you can call 'execute()' on to request the next
593 page. Returns None if there are no more items in the collection.
594 </pre>
595</div>
596
597<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700598 <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700599 <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.
600
601Args:
602 project: string, Project ID for this request. (required)
603 interconnect: string, Name of the interconnect to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700604 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 The object takes the form of:
606
607{ # Represents an Interconnect resource.
608 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700609 # 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 -0700610 "linkType": "A String", # Type of link requested, which can take one of the following values:
611 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
612 # - 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.
613 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
614 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
615 { # 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
616 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
617 "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.
618 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
619 },
620 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700621 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700622 "a_key": "A String",
623 },
624 "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.
625 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
626 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
627 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
628 "A String",
629 ],
630 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
631 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
632 { # Description of a planned outage on this Interconnect. Next id: 9
633 "description": "A String", # A description about the purpose of the outage.
634 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
635 "A String",
636 ],
637 "source": "A String", # The party that generated this notification, which can take the following value:
638 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
639 "state": "A String", # State of this notification, which can take one of the following values:
640 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
641 # - 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.
642 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
643 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
644 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
645 # - 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.
646 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
647 "name": "A String", # Unique identifier for this outage notification.
648 },
649 ],
650 "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.
651 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
652 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
653 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
654 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
655 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
656 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
657 "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.
658 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
659 #
660 # To see the latest fingerprint, make a get() request to retrieve an Interconnect.
661 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
662 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
663 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
664 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
665 "interconnectType": "A String", # Type of interconnect, which can take one of the following values:
666 # - PARTNER: A partner-managed interconnection shared between customers though a partner.
667 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
668 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
669 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
670 "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.
671 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
672 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
673 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
674 }
675
676 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.
677
678For 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.
679
680The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
681
682Returns:
683 An object of the form:
684
685 { # Represents an Operation resource.
686 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700687 # Google Compute Engine has three Operation resources:
688 #
689 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
690 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700691 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
692 #
693 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700694 # - For global operations, use the `globalOperations` resource.
695 # - For regional operations, use the `regionOperations` resource.
696 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700697 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700698 # 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 -0700699 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
700 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
701 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700702 "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 -0700703 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
704 "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 -0700705 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
706 "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 -0700707 "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 -0700708 "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 -0700709 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700710 "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 -0700711 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
712 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
713 {
714 "message": "A String", # [Output Only] A human-readable description of the warning code.
715 "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.
716 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
717 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
718 {
719 "value": "A String", # [Output Only] A warning data value corresponding to the key.
720 "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).
721 },
722 ],
723 },
724 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700725 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700726 "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 -0700727 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
728 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700729 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
730 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
731 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
732 {
733 "message": "A String", # [Output Only] An optional, human-readable error message.
734 "code": "A String", # [Output Only] The error type identifier for this error.
735 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
736 },
737 ],
738 },
739 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
740 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
741 "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.
742 }</pre>
743</div>
744
745<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700746 <code class="details" id="setLabels">setLabels(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700747 <pre>Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.
748
749Args:
750 project: string, Project ID for this request. (required)
751 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700752 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700753 The object takes the form of:
754
755{
756 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700757 "labels": { # A list of labels to apply for this resource. Each label key &amp; value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700758 "a_key": "A String",
759 },
760 }
761
762
763Returns:
764 An object of the form:
765
766 { # Represents an Operation resource.
767 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700768 # Google Compute Engine has three Operation resources:
769 #
770 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
771 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700772 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
773 #
774 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700775 # - For global operations, use the `globalOperations` resource.
776 # - For regional operations, use the `regionOperations` resource.
777 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700778 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700779 # 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 -0700780 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
781 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
782 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700783 "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 -0700784 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
785 "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 -0700786 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
787 "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 -0700788 "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 -0700789 "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 -0700790 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700791 "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 -0700792 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
793 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
794 {
795 "message": "A String", # [Output Only] A human-readable description of the warning code.
796 "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.
797 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
798 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
799 {
800 "value": "A String", # [Output Only] A warning data value corresponding to the key.
801 "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).
802 },
803 ],
804 },
805 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700806 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700807 "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 -0700808 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
809 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700810 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
811 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
812 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
813 {
814 "message": "A String", # [Output Only] An optional, human-readable error message.
815 "code": "A String", # [Output Only] The error type identifier for this error.
816 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
817 },
818 ],
819 },
820 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
821 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
822 "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.
823 }</pre>
824</div>
825
826<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700827 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700828 <pre>Returns permissions that a caller has on the specified resource.
829
830Args:
831 project: string, Project ID for this request. (required)
832 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700833 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700834 The object takes the form of:
835
836{
837 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
838 "A String",
839 ],
840 }
841
842
843Returns:
844 An object of the form:
845
846 {
847 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
848 "A String",
849 ],
850 }</pre>
851</div>
852
853</body></html>