@maxim_mazurok/gapi.client.networkconnectivity-v1 0.0.20230705 → 0.0.20230712

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +75 -72
  2. package/package.json +1 -1
  3. package/tests.ts +5 -2
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://networkconnectivity.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230705
12
+ // Revision: 20230712
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,11 +24,11 @@ declare namespace gapi.client {
24
24
  namespace networkconnectivity {
25
25
  interface AcceptSpokeRequest {
26
26
  /**
27
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know
28
- * that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where
29
- * 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 to see whether the original operation was
30
- * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with
31
- * the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
27
+ * Optional. A 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
28
+ * completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an
29
+ * initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it
30
+ * was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception
31
+ * that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
32
32
  */
33
33
  requestId?:
34
34
  string;
@@ -333,10 +333,10 @@ declare namespace gapi.client {
333
333
  string;
334
334
  }
335
335
  interface LinkedVpcNetwork {
336
- /** Optional. IP Ranges encompassing the subnets to be excluded from peering. */
336
+ /** Optional. IP ranges encompassing the subnets to be excluded from peering. */
337
337
  excludeExportRanges?:
338
338
  string[];
339
- /** Required. The URI of the VPC network resource */
339
+ /** Required. The URI of the VPC network resource. */
340
340
  uri?:
341
341
  string;
342
342
  }
@@ -597,15 +597,15 @@ declare namespace gapi.client {
597
597
  string;
598
598
  }
599
599
  interface RejectSpokeRequest {
600
- /** Optional. Additional Details behind the rejection */
600
+ /** Optional. Additional information provided by the hub administrator in the `RejectSpoke` call. */
601
601
  details?:
602
602
  string;
603
603
  /**
604
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know
605
- * that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where
606
- * 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 to see whether the original operation was
607
- * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with
608
- * the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
604
+ * Optional. A 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
605
+ * completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an
606
+ * initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it
607
+ * was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception
608
+ * that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
609
609
  */
610
610
  requestId?:
611
611
  string;
@@ -630,7 +630,7 @@ declare namespace gapi.client {
630
630
  location?:
631
631
  string;
632
632
  /**
633
- * Immutable. The name of the route. Route names must be unique. They use the following form:
633
+ * Immutable. The name of the route. Route names must be unique. Route names use the following form:
634
634
  * `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
635
635
  */
636
636
  name?:
@@ -649,7 +649,7 @@ declare namespace gapi.client {
649
649
  string;
650
650
  /**
651
651
  * Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same
652
- * name is created, the new route is assigned a different unique_id.
652
+ * name is created, the new route is assigned a different `uid`.
653
653
  */
654
654
  uid?:
655
655
  string;
@@ -679,7 +679,7 @@ declare namespace gapi.client {
679
679
  labels?:
680
680
  { [P in string]: string };
681
681
  /**
682
- * Immutable. The name of the route table. Route Table names must be unique. They use the following form:
682
+ * Immutable. The name of the route table. Route table names must be unique. They use the following form:
683
683
  * `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}`
684
684
  */
685
685
  name?:
@@ -689,7 +689,7 @@ declare namespace gapi.client {
689
689
  string;
690
690
  /**
691
691
  * Output only. The Google-generated UUID for the route table. This value is unique across all route table resources. If a route table is deleted and another with the same name is
692
- * created, the new route table is assigned a different unique_id.
692
+ * created, the new route table is assigned a different `uid`.
693
693
  */
694
694
  uid?:
695
695
  string;
@@ -902,7 +902,7 @@ declare namespace gapi.client {
902
902
  /** Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}` */
903
903
  name?:
904
904
  string;
905
- /** Output only. The reasons for current state of the spoke. */
905
+ /** Output only. The reasons for current state of the spoke. Only present when the spoke is in the `INACTIVE` state. */
906
906
  reasons?:
907
907
  StateReason[];
908
908
  /** Output only. The type of resource associated with the spoke. */
@@ -913,7 +913,7 @@ declare namespace gapi.client {
913
913
  string;
914
914
  /**
915
915
  * Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke
916
- * is assigned a different unique_id.
916
+ * is assigned a different `unique_id`.
917
917
  */
918
918
  uniqueId?:
919
919
  string;
@@ -1345,11 +1345,11 @@ declare namespace gapi.client {
1345
1345
  quotaUser?:
1346
1346
  string;
1347
1347
  /**
1348
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
1349
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
1350
- * 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 to see whether the original
1351
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
1352
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1348
+ * Optional. A 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
1349
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
1350
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
1351
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
1352
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1353
1353
  */
1354
1354
  requestId?:
1355
1355
  string;
@@ -1398,11 +1398,11 @@ declare namespace gapi.client {
1398
1398
  quotaUser?:
1399
1399
  string;
1400
1400
  /**
1401
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
1402
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
1403
- * 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 to see whether the original
1404
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
1405
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1401
+ * Optional. A 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
1402
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
1403
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
1404
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
1405
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1406
1406
  */
1407
1407
  requestId?:
1408
1408
  string;
@@ -1447,11 +1447,11 @@ declare namespace gapi.client {
1447
1447
  quotaUser?:
1448
1448
  string;
1449
1449
  /**
1450
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
1451
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
1452
- * 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 to see whether the original
1453
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
1454
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1450
+ * Optional. A 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
1451
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
1452
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
1453
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
1454
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1455
1455
  */
1456
1456
  requestId?:
1457
1457
  string;
@@ -1663,7 +1663,7 @@ declare namespace gapi.client {
1663
1663
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1664
1664
  uploadType?:
1665
1665
  string;
1666
- /** The view of the spoke to return. The view you use determines which spoke fields are included in the response. */
1666
+ /** The view of the spoke to return. The view that you use determines which spoke fields are included in the response. */
1667
1667
  view?:
1668
1668
  string;
1669
1669
  }): Request<ListHubSpokesResponse>;
@@ -1700,11 +1700,11 @@ declare namespace gapi.client {
1700
1700
  quotaUser?:
1701
1701
  string;
1702
1702
  /**
1703
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
1704
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
1705
- * 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 to see whether the original
1706
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
1707
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1703
+ * Optional. A 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
1704
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
1705
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
1706
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
1707
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1708
1708
  */
1709
1709
  requestId?:
1710
1710
  string;
@@ -1756,11 +1756,11 @@ declare namespace gapi.client {
1756
1756
  quotaUser?:
1757
1757
  string;
1758
1758
  /**
1759
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
1760
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
1761
- * 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 to see whether the original
1762
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
1763
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1759
+ * Optional. A 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
1760
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
1761
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
1762
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
1763
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1764
1764
  */
1765
1765
  requestId?:
1766
1766
  string;
@@ -4384,11 +4384,11 @@ declare namespace gapi.client {
4384
4384
  quotaUser?:
4385
4385
  string;
4386
4386
  /**
4387
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
4388
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
4389
- * 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 to see whether the original
4390
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
4391
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4387
+ * Optional. A 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
4388
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
4389
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
4390
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
4391
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4392
4392
  */
4393
4393
  requestId?:
4394
4394
  string;
@@ -4437,11 +4437,11 @@ declare namespace gapi.client {
4437
4437
  quotaUser?:
4438
4438
  string;
4439
4439
  /**
4440
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
4441
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
4442
- * 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 to see whether the original
4443
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
4444
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4440
+ * Optional. A 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
4441
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
4442
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
4443
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
4444
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4445
4445
  */
4446
4446
  requestId?:
4447
4447
  string;
@@ -4489,11 +4489,11 @@ declare namespace gapi.client {
4489
4489
  quotaUser?:
4490
4490
  string;
4491
4491
  /**
4492
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
4493
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
4494
- * 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 to see whether the original
4495
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
4496
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4492
+ * Optional. A 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
4493
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
4494
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
4495
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
4496
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4497
4497
  */
4498
4498
  requestId?:
4499
4499
  string;
@@ -4678,11 +4678,11 @@ declare namespace gapi.client {
4678
4678
  quotaUser?:
4679
4679
  string;
4680
4680
  /**
4681
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
4682
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
4683
- * 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 to see whether the original
4684
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
4685
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4681
+ * Optional. A 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
4682
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
4683
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
4684
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
4685
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4686
4686
  */
4687
4687
  requestId?:
4688
4688
  string;
@@ -4734,11 +4734,11 @@ declare namespace gapi.client {
4734
4734
  quotaUser?:
4735
4735
  string;
4736
4736
  /**
4737
- * Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server
4738
- * know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a
4739
- * 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 to see whether the original
4740
- * operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a
4741
- * valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4737
+ * Optional. A 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
4738
+ * been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you
4739
+ * make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was
4740
+ * received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID,
4741
+ * with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4742
4742
  */
4743
4743
  requestId?:
4744
4744
  string;
@@ -4756,7 +4756,10 @@ declare namespace gapi.client {
4756
4756
  string;
4757
4757
  },
4758
4758
  body: Spoke): Request<GoogleLongrunningOperation>;
4759
- /** Does one of the following: * Rejects a proposal to attach a Network Connectivity Center spoke to the hub. * Rejects and removes a previously attached spoke from the hub. */
4759
+ /**
4760
+ * Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no
4761
+ * longer able to connect to other spokes that are attached to the hub.
4762
+ */
4760
4763
  reject(request: {
4761
4764
  /** V1 error format. */
4762
4765
  "$.xgafv"?:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.networkconnectivity-v1",
3
- "version": "0.0.20230705",
3
+ "version": "0.0.20230712",
4
4
  "description": "TypeScript typings for Network Connectivity API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230705
6
+ // Revision: 20230712
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -1046,7 +1046,10 @@ gapi.load('client', async () => {
1046
1046
  uniqueId: "Test string",
1047
1047
  updateTime: "Test string",
1048
1048
  });
1049
- /** Does one of the following: * Rejects a proposal to attach a Network Connectivity Center spoke to the hub. * Rejects and removes a previously attached spoke from the hub. */
1049
+ /**
1050
+ * Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer
1051
+ * able to connect to other spokes that are attached to the hub.
1052
+ */
1050
1053
  await gapi.client.networkconnectivity.projects.locations.spokes.reject({
1051
1054
  name: "Test string",
1052
1055
  }, {