You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/clients/src/api/interlink/v1beta1/api.gen.ts
+23-70Lines changed: 23 additions & 70 deletions
Original file line number
Diff line number
Diff line change
@@ -71,9 +71,8 @@ const jsonContentHeaders = {
71
71
72
72
/**
73
73
* InterLink API.
74
-
*
75
-
* This API allows you to manage your Scaleway InterLink, to connect your
76
-
* on-premises infrastructure with your Scaleway VPC.
74
+
75
+
This API allows you to manage your Scaleway InterLink, to connect your on-premises infrastructure with your Scaleway VPC.
77
76
*/
78
77
exportclassAPIextendsParentAPI{
79
78
/** Lists the available regions of the API. */
@@ -110,10 +109,7 @@ export class API extends ParentAPI {
110
109
)
111
110
112
111
/**
113
-
* List dedicated connections. For self-hosted users, list their dedicated
114
-
* physical connections in a given region. By default, the connections
115
-
* returned in the list are ordered by name in ascending order, though this
116
-
* can be modified via the `order_by` field.
112
+
* List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
117
113
*
118
114
* @param request - The request {@link ListDedicatedConnectionsRequest}
119
115
* @returns A Promise of ListDedicatedConnectionsResponse
@@ -128,9 +124,7 @@ export class API extends ParentAPI {
128
124
)
129
125
130
126
/**
131
-
* Get a dedicated connection. For self-hosted users, get a dedicated physical
132
-
* connection corresponding to the given ID. The response object includes
133
-
* information such as the connection's name, status and total bandwidth.
127
+
* Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth.
134
128
*
135
129
* @param request - The request {@link GetDedicatedConnectionRequest}
136
130
* @returns A Promise of DedicatedConnection
@@ -189,9 +183,7 @@ export class API extends ParentAPI {
189
183
)
190
184
191
185
/**
192
-
* List available partners. List all available partners. By default, the
193
-
* partners returned in the list are ordered by name in ascending order,
194
-
* though this can be modified via the `order_by` field.
186
+
* List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
195
187
*
196
188
* @param request - The request {@link ListPartnersRequest}
197
189
* @returns A Promise of ListPartnersResponse
@@ -200,9 +192,7 @@ export class API extends ParentAPI {
* Get a partner. Get a partner for the given partner IP. The response object
204
-
* includes information such as the partner's name, email address and portal
205
-
* URL.
195
+
* Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.
206
196
*
207
197
* @param request - The request {@link GetPartnerRequest}
208
198
* @returns A Promise of Partner
@@ -239,8 +229,7 @@ export class API extends ParentAPI {
239
229
)
240
230
241
231
/**
242
-
* List PoPs. List all available PoPs (locations) for a given region. By
243
-
* default, the results are returned in ascending alphabetical order by name.
232
+
* List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.
244
233
*
245
234
* @param request - The request {@link ListPopsRequest}
246
235
* @returns A Promise of ListPopsResponse
@@ -249,8 +238,7 @@ export class API extends ParentAPI {
* Get a link. Get a link (InterLink session / logical InterLink resource) for
311
-
* the given link ID. The response object includes information about the
312
-
* link's various configuration details.
297
+
* Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.
313
298
*
314
299
* @param request - The request {@link GetLinkRequest}
315
300
* @returns A Promise of Link
@@ -346,11 +331,7 @@ export class API extends ParentAPI {
346
331
)
347
332
348
333
/**
349
-
* Create a link. Create a link (InterLink session / logical InterLink
350
-
* resource) in a given PoP, specifying its various configuration details.
351
-
* Links can either be hosted (faciliated by partners' shared physical
352
-
* connections) or self-hosted (for users who have purchased a dedicated
353
-
* physical connection).
334
+
* Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
354
335
*
355
336
* @param request - The request {@link CreateLinkRequest}
356
337
* @returns A Promise of Link
@@ -369,8 +350,7 @@ export class API extends ParentAPI {
369
350
)
370
351
371
352
/**
372
-
* Update a link. Update an existing link, specified by its link ID. Only its
373
-
* name and tags can be updated.
353
+
* Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated.
374
354
*
375
355
* @param request - The request {@link UpdateLinkRequest}
376
356
* @returns A Promise of Link
@@ -389,11 +369,7 @@ export class API extends ParentAPI {
389
369
)
390
370
391
371
/**
392
-
* Delete a link. Delete an existing link, specified by its link ID. Note that
393
-
* as well as deleting the link here on the Scaleway side, it is also
394
-
* necessary to request deletion from the partner on their side. Only when
395
-
* this action has been carried out on both sides will the resource be
396
-
* completely deleted.
372
+
* Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
397
373
*
398
374
* @param request - The request {@link DeleteLinkRequest}
399
375
* @returns A Promise of Link
@@ -408,9 +384,7 @@ export class API extends ParentAPI {
408
384
)
409
385
410
386
/**
411
-
* Attach a VPC. Attach a VPC to an existing link. This facilitates
412
-
* communication between the resources in your Scaleway VPC, and your
413
-
* on-premises infrastructure.
387
+
* Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
414
388
*
415
389
* @param request - The request {@link AttachVpcRequest}
416
390
* @returns A Promise of Link
@@ -446,10 +420,7 @@ export class API extends ParentAPI {
446
420
)
447
421
448
422
/**
449
-
* Attach a routing policy. Attach a routing policy to an existing link. As
450
-
* all routes across the link are blocked by default, you must attach a
451
-
* routing policy to set IP prefix filters for allowed routes, facilitating
452
-
* traffic flow.
423
+
* Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
453
424
*
454
425
* @param request - The request {@link AttachRoutingPolicyRequest}
455
426
* @returns A Promise of Link
@@ -468,9 +439,7 @@ export class API extends ParentAPI {
468
439
)
469
440
470
441
/**
471
-
* Detach a routing policy. Detach a routing policy from an existing link.
472
-
* Without a routing policy, all routes across the link are blocked by
473
-
* default.
442
+
* Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
474
443
*
475
444
* @param request - The request {@link DetachRoutingPolicyRequest}
476
445
* @returns A Promise of Link
@@ -487,12 +456,7 @@ export class API extends ParentAPI {
487
456
)
488
457
489
458
/**
490
-
* Enable route propagation. Enable all allowed prefixes (defined in a routing
491
-
* policy) to be announced in the BGP session. This allows traffic to flow
492
-
* between the attached VPC and the on-premises infrastructure along the
493
-
* announced routes. Note that by default, even when route propagation is
494
-
* enabled, all routes are blocked. It is essential to attach a routing policy
495
-
* to define the ranges of routes to announce.
459
+
* Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
496
460
*
497
461
* @param request - The request {@link EnableRoutePropagationRequest}
498
462
* @returns A Promise of Link
@@ -509,9 +473,7 @@ export class API extends ParentAPI {
509
473
)
510
474
511
475
/**
512
-
* Disable route propagation. Prevent any prefixes from being announced in the
513
-
* BGP session. Traffic will not be able to flow over the InterLink until
514
-
* route propagation is re-enabled.
476
+
* Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
515
477
*
516
478
* @param request - The request {@link DisableRoutePropagationRequest}
517
479
* @returns A Promise of Link
@@ -553,9 +515,7 @@ export class API extends ParentAPI {
553
515
)
554
516
555
517
/**
556
-
* List routing policies. List all routing policies in a given region. A
557
-
* routing policy can be attached to one or multiple links (InterLink
558
-
* connections).
518
+
* List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).
559
519
*
560
520
* @param request - The request {@link ListRoutingPoliciesRequest}
561
521
* @returns A Promise of ListRoutingPoliciesResponse
@@ -568,9 +528,7 @@ export class API extends ParentAPI {
568
528
)
569
529
570
530
/**
571
-
* Get routing policy. Get a routing policy for the given routing policy ID.
572
-
* The response object gives information including the policy's name, tags and
573
-
* prefix filters.
531
+
* Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.
574
532
*
575
533
* @param request - The request {@link GetRoutingPolicyRequest}
576
534
* @returns A Promise of RoutingPolicy
@@ -585,9 +543,7 @@ export class API extends ParentAPI {
585
543
)
586
544
587
545
/**
588
-
* Create a routing policy. Create a routing policy. Routing policies allow
589
-
* you to set IP prefix filters to define the incoming route announcements to
590
-
* accept from the peer, and the outgoing routes to announce to the peer.
546
+
* Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.
591
547
*
592
548
* @param request - The request {@link CreateRoutingPolicyRequest}
593
549
* @returns A Promise of RoutingPolicy
@@ -606,9 +562,7 @@ export class API extends ParentAPI {
606
562
)
607
563
608
564
/**
609
-
* Update a routing policy. Update an existing routing policy, specified by
610
-
* its routing policy ID. Its name, tags and incoming/outgoing prefix filters
611
-
* can be updated.
565
+
* Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.
612
566
*
613
567
* @param request - The request {@link UpdateRoutingPolicyRequest}
614
568
* @returns A Promise of RoutingPolicy
@@ -627,8 +581,7 @@ export class API extends ParentAPI {
627
581
)
628
582
629
583
/**
630
-
* Delete a routing policy. Delete an existing routing policy, specified by
631
-
* its routing policy ID.
584
+
* Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.
632
585
*
633
586
* @param request - The request {@link DeleteRoutingPolicyRequest}
0 commit comments