@googleapis/biglake 1.0.1 → 3.0.0

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.
package/v1.ts CHANGED
@@ -358,6 +358,73 @@ export namespace biglake_v1 {
358
358
 
359
359
  /**
360
360
  * Creates a new catalog.
361
+ * @example
362
+ * ```js
363
+ * // Before running the sample:
364
+ * // - Enable the API at:
365
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
366
+ * // - Login into gcloud by running:
367
+ * // ```sh
368
+ * // $ gcloud auth application-default login
369
+ * // ```
370
+ * // - Install the npm module by running:
371
+ * // ```sh
372
+ * // $ npm install googleapis
373
+ * // ```
374
+ *
375
+ * const {google} = require('googleapis');
376
+ * const biglake = google.biglake('v1');
377
+ *
378
+ * async function main() {
379
+ * const auth = new google.auth.GoogleAuth({
380
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
381
+ * scopes: [
382
+ * 'https://www.googleapis.com/auth/bigquery',
383
+ * 'https://www.googleapis.com/auth/cloud-platform',
384
+ * ],
385
+ * });
386
+ *
387
+ * // Acquire an auth client, and bind it to all future calls
388
+ * const authClient = await auth.getClient();
389
+ * google.options({auth: authClient});
390
+ *
391
+ * // Do the magic
392
+ * const res = await biglake.projects.locations.catalogs.create({
393
+ * // Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
394
+ * catalogId: 'placeholder-value',
395
+ * // Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}
396
+ * parent: 'projects/my-project/locations/my-location',
397
+ *
398
+ * // Request body metadata
399
+ * requestBody: {
400
+ * // request body parameters
401
+ * // {
402
+ * // "createTime": "my_createTime",
403
+ * // "deleteTime": "my_deleteTime",
404
+ * // "expireTime": "my_expireTime",
405
+ * // "name": "my_name",
406
+ * // "updateTime": "my_updateTime"
407
+ * // }
408
+ * },
409
+ * });
410
+ * console.log(res.data);
411
+ *
412
+ * // Example response
413
+ * // {
414
+ * // "createTime": "my_createTime",
415
+ * // "deleteTime": "my_deleteTime",
416
+ * // "expireTime": "my_expireTime",
417
+ * // "name": "my_name",
418
+ * // "updateTime": "my_updateTime"
419
+ * // }
420
+ * }
421
+ *
422
+ * main().catch(e => {
423
+ * console.error(e);
424
+ * throw e;
425
+ * });
426
+ *
427
+ * ```
361
428
  *
362
429
  * @param params - Parameters for request
363
430
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -449,6 +516,59 @@ export namespace biglake_v1 {
449
516
 
450
517
  /**
451
518
  * Deletes an existing catalog specified by the catalog ID.
519
+ * @example
520
+ * ```js
521
+ * // Before running the sample:
522
+ * // - Enable the API at:
523
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
524
+ * // - Login into gcloud by running:
525
+ * // ```sh
526
+ * // $ gcloud auth application-default login
527
+ * // ```
528
+ * // - Install the npm module by running:
529
+ * // ```sh
530
+ * // $ npm install googleapis
531
+ * // ```
532
+ *
533
+ * const {google} = require('googleapis');
534
+ * const biglake = google.biglake('v1');
535
+ *
536
+ * async function main() {
537
+ * const auth = new google.auth.GoogleAuth({
538
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
539
+ * scopes: [
540
+ * 'https://www.googleapis.com/auth/bigquery',
541
+ * 'https://www.googleapis.com/auth/cloud-platform',
542
+ * ],
543
+ * });
544
+ *
545
+ * // Acquire an auth client, and bind it to all future calls
546
+ * const authClient = await auth.getClient();
547
+ * google.options({auth: authClient});
548
+ *
549
+ * // Do the magic
550
+ * const res = await biglake.projects.locations.catalogs.delete({
551
+ * // Required. The name of the catalog to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
552
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog',
553
+ * });
554
+ * console.log(res.data);
555
+ *
556
+ * // Example response
557
+ * // {
558
+ * // "createTime": "my_createTime",
559
+ * // "deleteTime": "my_deleteTime",
560
+ * // "expireTime": "my_expireTime",
561
+ * // "name": "my_name",
562
+ * // "updateTime": "my_updateTime"
563
+ * // }
564
+ * }
565
+ *
566
+ * main().catch(e => {
567
+ * console.error(e);
568
+ * throw e;
569
+ * });
570
+ *
571
+ * ```
452
572
  *
453
573
  * @param params - Parameters for request
454
574
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -537,6 +657,59 @@ export namespace biglake_v1 {
537
657
 
538
658
  /**
539
659
  * Gets the catalog specified by the resource name.
660
+ * @example
661
+ * ```js
662
+ * // Before running the sample:
663
+ * // - Enable the API at:
664
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
665
+ * // - Login into gcloud by running:
666
+ * // ```sh
667
+ * // $ gcloud auth application-default login
668
+ * // ```
669
+ * // - Install the npm module by running:
670
+ * // ```sh
671
+ * // $ npm install googleapis
672
+ * // ```
673
+ *
674
+ * const {google} = require('googleapis');
675
+ * const biglake = google.biglake('v1');
676
+ *
677
+ * async function main() {
678
+ * const auth = new google.auth.GoogleAuth({
679
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
680
+ * scopes: [
681
+ * 'https://www.googleapis.com/auth/bigquery',
682
+ * 'https://www.googleapis.com/auth/cloud-platform',
683
+ * ],
684
+ * });
685
+ *
686
+ * // Acquire an auth client, and bind it to all future calls
687
+ * const authClient = await auth.getClient();
688
+ * google.options({auth: authClient});
689
+ *
690
+ * // Do the magic
691
+ * const res = await biglake.projects.locations.catalogs.get({
692
+ * // Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
693
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog',
694
+ * });
695
+ * console.log(res.data);
696
+ *
697
+ * // Example response
698
+ * // {
699
+ * // "createTime": "my_createTime",
700
+ * // "deleteTime": "my_deleteTime",
701
+ * // "expireTime": "my_expireTime",
702
+ * // "name": "my_name",
703
+ * // "updateTime": "my_updateTime"
704
+ * // }
705
+ * }
706
+ *
707
+ * main().catch(e => {
708
+ * console.error(e);
709
+ * throw e;
710
+ * });
711
+ *
712
+ * ```
540
713
  *
541
714
  * @param params - Parameters for request
542
715
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -625,6 +798,60 @@ export namespace biglake_v1 {
625
798
 
626
799
  /**
627
800
  * List all catalogs in a specified project.
801
+ * @example
802
+ * ```js
803
+ * // Before running the sample:
804
+ * // - Enable the API at:
805
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
806
+ * // - Login into gcloud by running:
807
+ * // ```sh
808
+ * // $ gcloud auth application-default login
809
+ * // ```
810
+ * // - Install the npm module by running:
811
+ * // ```sh
812
+ * // $ npm install googleapis
813
+ * // ```
814
+ *
815
+ * const {google} = require('googleapis');
816
+ * const biglake = google.biglake('v1');
817
+ *
818
+ * async function main() {
819
+ * const auth = new google.auth.GoogleAuth({
820
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
821
+ * scopes: [
822
+ * 'https://www.googleapis.com/auth/bigquery',
823
+ * 'https://www.googleapis.com/auth/cloud-platform',
824
+ * ],
825
+ * });
826
+ *
827
+ * // Acquire an auth client, and bind it to all future calls
828
+ * const authClient = await auth.getClient();
829
+ * google.options({auth: authClient});
830
+ *
831
+ * // Do the magic
832
+ * const res = await biglake.projects.locations.catalogs.list({
833
+ * // The maximum number of catalogs to return. The service may return fewer than this value. If unspecified, at most 50 catalogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
834
+ * pageSize: 'placeholder-value',
835
+ * // A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCatalogs` must match the call that provided the page token.
836
+ * pageToken: 'placeholder-value',
837
+ * // Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number\}/locations/{location_id\}
838
+ * parent: 'projects/my-project/locations/my-location',
839
+ * });
840
+ * console.log(res.data);
841
+ *
842
+ * // Example response
843
+ * // {
844
+ * // "catalogs": [],
845
+ * // "nextPageToken": "my_nextPageToken"
846
+ * // }
847
+ * }
848
+ *
849
+ * main().catch(e => {
850
+ * console.error(e);
851
+ * throw e;
852
+ * });
853
+ *
854
+ * ```
628
855
  *
629
856
  * @param params - Parameters for request
630
857
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -775,6 +1002,77 @@ export namespace biglake_v1 {
775
1002
 
776
1003
  /**
777
1004
  * Creates a new database.
1005
+ * @example
1006
+ * ```js
1007
+ * // Before running the sample:
1008
+ * // - Enable the API at:
1009
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1010
+ * // - Login into gcloud by running:
1011
+ * // ```sh
1012
+ * // $ gcloud auth application-default login
1013
+ * // ```
1014
+ * // - Install the npm module by running:
1015
+ * // ```sh
1016
+ * // $ npm install googleapis
1017
+ * // ```
1018
+ *
1019
+ * const {google} = require('googleapis');
1020
+ * const biglake = google.biglake('v1');
1021
+ *
1022
+ * async function main() {
1023
+ * const auth = new google.auth.GoogleAuth({
1024
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1025
+ * scopes: [
1026
+ * 'https://www.googleapis.com/auth/bigquery',
1027
+ * 'https://www.googleapis.com/auth/cloud-platform',
1028
+ * ],
1029
+ * });
1030
+ *
1031
+ * // Acquire an auth client, and bind it to all future calls
1032
+ * const authClient = await auth.getClient();
1033
+ * google.options({auth: authClient});
1034
+ *
1035
+ * // Do the magic
1036
+ * const res = await biglake.projects.locations.catalogs.databases.create({
1037
+ * // Required. The ID to use for the database, which will become the final component of the database's resource name.
1038
+ * databaseId: 'placeholder-value',
1039
+ * // Required. The parent resource where this database will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
1040
+ * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog',
1041
+ *
1042
+ * // Request body metadata
1043
+ * requestBody: {
1044
+ * // request body parameters
1045
+ * // {
1046
+ * // "createTime": "my_createTime",
1047
+ * // "deleteTime": "my_deleteTime",
1048
+ * // "expireTime": "my_expireTime",
1049
+ * // "hiveOptions": {},
1050
+ * // "name": "my_name",
1051
+ * // "type": "my_type",
1052
+ * // "updateTime": "my_updateTime"
1053
+ * // }
1054
+ * },
1055
+ * });
1056
+ * console.log(res.data);
1057
+ *
1058
+ * // Example response
1059
+ * // {
1060
+ * // "createTime": "my_createTime",
1061
+ * // "deleteTime": "my_deleteTime",
1062
+ * // "expireTime": "my_expireTime",
1063
+ * // "hiveOptions": {},
1064
+ * // "name": "my_name",
1065
+ * // "type": "my_type",
1066
+ * // "updateTime": "my_updateTime"
1067
+ * // }
1068
+ * }
1069
+ *
1070
+ * main().catch(e => {
1071
+ * console.error(e);
1072
+ * throw e;
1073
+ * });
1074
+ *
1075
+ * ```
778
1076
  *
779
1077
  * @param params - Parameters for request
780
1078
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -867,6 +1165,61 @@ export namespace biglake_v1 {
867
1165
 
868
1166
  /**
869
1167
  * Deletes an existing database specified by the database ID.
1168
+ * @example
1169
+ * ```js
1170
+ * // Before running the sample:
1171
+ * // - Enable the API at:
1172
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1173
+ * // - Login into gcloud by running:
1174
+ * // ```sh
1175
+ * // $ gcloud auth application-default login
1176
+ * // ```
1177
+ * // - Install the npm module by running:
1178
+ * // ```sh
1179
+ * // $ npm install googleapis
1180
+ * // ```
1181
+ *
1182
+ * const {google} = require('googleapis');
1183
+ * const biglake = google.biglake('v1');
1184
+ *
1185
+ * async function main() {
1186
+ * const auth = new google.auth.GoogleAuth({
1187
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1188
+ * scopes: [
1189
+ * 'https://www.googleapis.com/auth/bigquery',
1190
+ * 'https://www.googleapis.com/auth/cloud-platform',
1191
+ * ],
1192
+ * });
1193
+ *
1194
+ * // Acquire an auth client, and bind it to all future calls
1195
+ * const authClient = await auth.getClient();
1196
+ * google.options({auth: authClient});
1197
+ *
1198
+ * // Do the magic
1199
+ * const res = await biglake.projects.locations.catalogs.databases.delete({
1200
+ * // Required. The name of the database to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
1201
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1202
+ * });
1203
+ * console.log(res.data);
1204
+ *
1205
+ * // Example response
1206
+ * // {
1207
+ * // "createTime": "my_createTime",
1208
+ * // "deleteTime": "my_deleteTime",
1209
+ * // "expireTime": "my_expireTime",
1210
+ * // "hiveOptions": {},
1211
+ * // "name": "my_name",
1212
+ * // "type": "my_type",
1213
+ * // "updateTime": "my_updateTime"
1214
+ * // }
1215
+ * }
1216
+ *
1217
+ * main().catch(e => {
1218
+ * console.error(e);
1219
+ * throw e;
1220
+ * });
1221
+ *
1222
+ * ```
870
1223
  *
871
1224
  * @param params - Parameters for request
872
1225
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -956,6 +1309,61 @@ export namespace biglake_v1 {
956
1309
 
957
1310
  /**
958
1311
  * Gets the database specified by the resource name.
1312
+ * @example
1313
+ * ```js
1314
+ * // Before running the sample:
1315
+ * // - Enable the API at:
1316
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1317
+ * // - Login into gcloud by running:
1318
+ * // ```sh
1319
+ * // $ gcloud auth application-default login
1320
+ * // ```
1321
+ * // - Install the npm module by running:
1322
+ * // ```sh
1323
+ * // $ npm install googleapis
1324
+ * // ```
1325
+ *
1326
+ * const {google} = require('googleapis');
1327
+ * const biglake = google.biglake('v1');
1328
+ *
1329
+ * async function main() {
1330
+ * const auth = new google.auth.GoogleAuth({
1331
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1332
+ * scopes: [
1333
+ * 'https://www.googleapis.com/auth/bigquery',
1334
+ * 'https://www.googleapis.com/auth/cloud-platform',
1335
+ * ],
1336
+ * });
1337
+ *
1338
+ * // Acquire an auth client, and bind it to all future calls
1339
+ * const authClient = await auth.getClient();
1340
+ * google.options({auth: authClient});
1341
+ *
1342
+ * // Do the magic
1343
+ * const res = await biglake.projects.locations.catalogs.databases.get({
1344
+ * // Required. The name of the database to retrieve. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
1345
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1346
+ * });
1347
+ * console.log(res.data);
1348
+ *
1349
+ * // Example response
1350
+ * // {
1351
+ * // "createTime": "my_createTime",
1352
+ * // "deleteTime": "my_deleteTime",
1353
+ * // "expireTime": "my_expireTime",
1354
+ * // "hiveOptions": {},
1355
+ * // "name": "my_name",
1356
+ * // "type": "my_type",
1357
+ * // "updateTime": "my_updateTime"
1358
+ * // }
1359
+ * }
1360
+ *
1361
+ * main().catch(e => {
1362
+ * console.error(e);
1363
+ * throw e;
1364
+ * });
1365
+ *
1366
+ * ```
959
1367
  *
960
1368
  * @param params - Parameters for request
961
1369
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1045,6 +1453,60 @@ export namespace biglake_v1 {
1045
1453
 
1046
1454
  /**
1047
1455
  * List all databases in a specified catalog.
1456
+ * @example
1457
+ * ```js
1458
+ * // Before running the sample:
1459
+ * // - Enable the API at:
1460
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1461
+ * // - Login into gcloud by running:
1462
+ * // ```sh
1463
+ * // $ gcloud auth application-default login
1464
+ * // ```
1465
+ * // - Install the npm module by running:
1466
+ * // ```sh
1467
+ * // $ npm install googleapis
1468
+ * // ```
1469
+ *
1470
+ * const {google} = require('googleapis');
1471
+ * const biglake = google.biglake('v1');
1472
+ *
1473
+ * async function main() {
1474
+ * const auth = new google.auth.GoogleAuth({
1475
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1476
+ * scopes: [
1477
+ * 'https://www.googleapis.com/auth/bigquery',
1478
+ * 'https://www.googleapis.com/auth/cloud-platform',
1479
+ * ],
1480
+ * });
1481
+ *
1482
+ * // Acquire an auth client, and bind it to all future calls
1483
+ * const authClient = await auth.getClient();
1484
+ * google.options({auth: authClient});
1485
+ *
1486
+ * // Do the magic
1487
+ * const res = await biglake.projects.locations.catalogs.databases.list({
1488
+ * // The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 50 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
1489
+ * pageSize: 'placeholder-value',
1490
+ * // A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token.
1491
+ * pageToken: 'placeholder-value',
1492
+ * // Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
1493
+ * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog',
1494
+ * });
1495
+ * console.log(res.data);
1496
+ *
1497
+ * // Example response
1498
+ * // {
1499
+ * // "databases": [],
1500
+ * // "nextPageToken": "my_nextPageToken"
1501
+ * // }
1502
+ * }
1503
+ *
1504
+ * main().catch(e => {
1505
+ * console.error(e);
1506
+ * throw e;
1507
+ * });
1508
+ *
1509
+ * ```
1048
1510
  *
1049
1511
  * @param params - Parameters for request
1050
1512
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1139,6 +1601,77 @@ export namespace biglake_v1 {
1139
1601
 
1140
1602
  /**
1141
1603
  * Updates an existing database specified by the database ID.
1604
+ * @example
1605
+ * ```js
1606
+ * // Before running the sample:
1607
+ * // - Enable the API at:
1608
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1609
+ * // - Login into gcloud by running:
1610
+ * // ```sh
1611
+ * // $ gcloud auth application-default login
1612
+ * // ```
1613
+ * // - Install the npm module by running:
1614
+ * // ```sh
1615
+ * // $ npm install googleapis
1616
+ * // ```
1617
+ *
1618
+ * const {google} = require('googleapis');
1619
+ * const biglake = google.biglake('v1');
1620
+ *
1621
+ * async function main() {
1622
+ * const auth = new google.auth.GoogleAuth({
1623
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1624
+ * scopes: [
1625
+ * 'https://www.googleapis.com/auth/bigquery',
1626
+ * 'https://www.googleapis.com/auth/cloud-platform',
1627
+ * ],
1628
+ * });
1629
+ *
1630
+ * // Acquire an auth client, and bind it to all future calls
1631
+ * const authClient = await auth.getClient();
1632
+ * google.options({auth: authClient});
1633
+ *
1634
+ * // Do the magic
1635
+ * const res = await biglake.projects.locations.catalogs.databases.patch({
1636
+ * // Output only. The resource name. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
1637
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1638
+ * // The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
1639
+ * updateMask: 'placeholder-value',
1640
+ *
1641
+ * // Request body metadata
1642
+ * requestBody: {
1643
+ * // request body parameters
1644
+ * // {
1645
+ * // "createTime": "my_createTime",
1646
+ * // "deleteTime": "my_deleteTime",
1647
+ * // "expireTime": "my_expireTime",
1648
+ * // "hiveOptions": {},
1649
+ * // "name": "my_name",
1650
+ * // "type": "my_type",
1651
+ * // "updateTime": "my_updateTime"
1652
+ * // }
1653
+ * },
1654
+ * });
1655
+ * console.log(res.data);
1656
+ *
1657
+ * // Example response
1658
+ * // {
1659
+ * // "createTime": "my_createTime",
1660
+ * // "deleteTime": "my_deleteTime",
1661
+ * // "expireTime": "my_expireTime",
1662
+ * // "hiveOptions": {},
1663
+ * // "name": "my_name",
1664
+ * // "type": "my_type",
1665
+ * // "updateTime": "my_updateTime"
1666
+ * // }
1667
+ * }
1668
+ *
1669
+ * main().catch(e => {
1670
+ * console.error(e);
1671
+ * throw e;
1672
+ * });
1673
+ *
1674
+ * ```
1142
1675
  *
1143
1676
  * @param params - Parameters for request
1144
1677
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1297,6 +1830,82 @@ export namespace biglake_v1 {
1297
1830
 
1298
1831
  /**
1299
1832
  * Creates a new table.
1833
+ * @example
1834
+ * ```js
1835
+ * // Before running the sample:
1836
+ * // - Enable the API at:
1837
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1838
+ * // - Login into gcloud by running:
1839
+ * // ```sh
1840
+ * // $ gcloud auth application-default login
1841
+ * // ```
1842
+ * // - Install the npm module by running:
1843
+ * // ```sh
1844
+ * // $ npm install googleapis
1845
+ * // ```
1846
+ *
1847
+ * const {google} = require('googleapis');
1848
+ * const biglake = google.biglake('v1');
1849
+ *
1850
+ * async function main() {
1851
+ * const auth = new google.auth.GoogleAuth({
1852
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1853
+ * scopes: [
1854
+ * 'https://www.googleapis.com/auth/bigquery',
1855
+ * 'https://www.googleapis.com/auth/cloud-platform',
1856
+ * ],
1857
+ * });
1858
+ *
1859
+ * // Acquire an auth client, and bind it to all future calls
1860
+ * const authClient = await auth.getClient();
1861
+ * google.options({auth: authClient});
1862
+ *
1863
+ * // Do the magic
1864
+ * const res = await biglake.projects.locations.catalogs.databases.tables.create(
1865
+ * {
1866
+ * // Required. The parent resource where this table will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
1867
+ * parent:
1868
+ * 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1869
+ * // Required. The ID to use for the table, which will become the final component of the table's resource name.
1870
+ * tableId: 'placeholder-value',
1871
+ *
1872
+ * // Request body metadata
1873
+ * requestBody: {
1874
+ * // request body parameters
1875
+ * // {
1876
+ * // "createTime": "my_createTime",
1877
+ * // "deleteTime": "my_deleteTime",
1878
+ * // "etag": "my_etag",
1879
+ * // "expireTime": "my_expireTime",
1880
+ * // "hiveOptions": {},
1881
+ * // "name": "my_name",
1882
+ * // "type": "my_type",
1883
+ * // "updateTime": "my_updateTime"
1884
+ * // }
1885
+ * },
1886
+ * },
1887
+ * );
1888
+ * console.log(res.data);
1889
+ *
1890
+ * // Example response
1891
+ * // {
1892
+ * // "createTime": "my_createTime",
1893
+ * // "deleteTime": "my_deleteTime",
1894
+ * // "etag": "my_etag",
1895
+ * // "expireTime": "my_expireTime",
1896
+ * // "hiveOptions": {},
1897
+ * // "name": "my_name",
1898
+ * // "type": "my_type",
1899
+ * // "updateTime": "my_updateTime"
1900
+ * // }
1901
+ * }
1902
+ *
1903
+ * main().catch(e => {
1904
+ * console.error(e);
1905
+ * throw e;
1906
+ * });
1907
+ *
1908
+ * ```
1300
1909
  *
1301
1910
  * @param params - Parameters for request
1302
1911
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1389,6 +1998,64 @@ export namespace biglake_v1 {
1389
1998
 
1390
1999
  /**
1391
2000
  * Deletes an existing table specified by the table ID.
2001
+ * @example
2002
+ * ```js
2003
+ * // Before running the sample:
2004
+ * // - Enable the API at:
2005
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
2006
+ * // - Login into gcloud by running:
2007
+ * // ```sh
2008
+ * // $ gcloud auth application-default login
2009
+ * // ```
2010
+ * // - Install the npm module by running:
2011
+ * // ```sh
2012
+ * // $ npm install googleapis
2013
+ * // ```
2014
+ *
2015
+ * const {google} = require('googleapis');
2016
+ * const biglake = google.biglake('v1');
2017
+ *
2018
+ * async function main() {
2019
+ * const auth = new google.auth.GoogleAuth({
2020
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2021
+ * scopes: [
2022
+ * 'https://www.googleapis.com/auth/bigquery',
2023
+ * 'https://www.googleapis.com/auth/cloud-platform',
2024
+ * ],
2025
+ * });
2026
+ *
2027
+ * // Acquire an auth client, and bind it to all future calls
2028
+ * const authClient = await auth.getClient();
2029
+ * google.options({auth: authClient});
2030
+ *
2031
+ * // Do the magic
2032
+ * const res = await biglake.projects.locations.catalogs.databases.tables.delete(
2033
+ * {
2034
+ * // Required. The name of the table to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}/tables/{table_id\}
2035
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
2036
+ * },
2037
+ * );
2038
+ * console.log(res.data);
2039
+ *
2040
+ * // Example response
2041
+ * // {
2042
+ * // "createTime": "my_createTime",
2043
+ * // "deleteTime": "my_deleteTime",
2044
+ * // "etag": "my_etag",
2045
+ * // "expireTime": "my_expireTime",
2046
+ * // "hiveOptions": {},
2047
+ * // "name": "my_name",
2048
+ * // "type": "my_type",
2049
+ * // "updateTime": "my_updateTime"
2050
+ * // }
2051
+ * }
2052
+ *
2053
+ * main().catch(e => {
2054
+ * console.error(e);
2055
+ * throw e;
2056
+ * });
2057
+ *
2058
+ * ```
1392
2059
  *
1393
2060
  * @param params - Parameters for request
1394
2061
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1478,6 +2145,62 @@ export namespace biglake_v1 {
1478
2145
 
1479
2146
  /**
1480
2147
  * Gets the table specified by the resource name.
2148
+ * @example
2149
+ * ```js
2150
+ * // Before running the sample:
2151
+ * // - Enable the API at:
2152
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
2153
+ * // - Login into gcloud by running:
2154
+ * // ```sh
2155
+ * // $ gcloud auth application-default login
2156
+ * // ```
2157
+ * // - Install the npm module by running:
2158
+ * // ```sh
2159
+ * // $ npm install googleapis
2160
+ * // ```
2161
+ *
2162
+ * const {google} = require('googleapis');
2163
+ * const biglake = google.biglake('v1');
2164
+ *
2165
+ * async function main() {
2166
+ * const auth = new google.auth.GoogleAuth({
2167
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2168
+ * scopes: [
2169
+ * 'https://www.googleapis.com/auth/bigquery',
2170
+ * 'https://www.googleapis.com/auth/cloud-platform',
2171
+ * ],
2172
+ * });
2173
+ *
2174
+ * // Acquire an auth client, and bind it to all future calls
2175
+ * const authClient = await auth.getClient();
2176
+ * google.options({auth: authClient});
2177
+ *
2178
+ * // Do the magic
2179
+ * const res = await biglake.projects.locations.catalogs.databases.tables.get({
2180
+ * // Required. The name of the table to retrieve. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}/tables/{table_id\}
2181
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
2182
+ * });
2183
+ * console.log(res.data);
2184
+ *
2185
+ * // Example response
2186
+ * // {
2187
+ * // "createTime": "my_createTime",
2188
+ * // "deleteTime": "my_deleteTime",
2189
+ * // "etag": "my_etag",
2190
+ * // "expireTime": "my_expireTime",
2191
+ * // "hiveOptions": {},
2192
+ * // "name": "my_name",
2193
+ * // "type": "my_type",
2194
+ * // "updateTime": "my_updateTime"
2195
+ * // }
2196
+ * }
2197
+ *
2198
+ * main().catch(e => {
2199
+ * console.error(e);
2200
+ * throw e;
2201
+ * });
2202
+ *
2203
+ * ```
1481
2204
  *
1482
2205
  * @param params - Parameters for request
1483
2206
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1567,6 +2290,63 @@ export namespace biglake_v1 {
1567
2290
 
1568
2291
  /**
1569
2292
  * List all tables in a specified database.
2293
+ * @example
2294
+ * ```js
2295
+ * // Before running the sample:
2296
+ * // - Enable the API at:
2297
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
2298
+ * // - Login into gcloud by running:
2299
+ * // ```sh
2300
+ * // $ gcloud auth application-default login
2301
+ * // ```
2302
+ * // - Install the npm module by running:
2303
+ * // ```sh
2304
+ * // $ npm install googleapis
2305
+ * // ```
2306
+ *
2307
+ * const {google} = require('googleapis');
2308
+ * const biglake = google.biglake('v1');
2309
+ *
2310
+ * async function main() {
2311
+ * const auth = new google.auth.GoogleAuth({
2312
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2313
+ * scopes: [
2314
+ * 'https://www.googleapis.com/auth/bigquery',
2315
+ * 'https://www.googleapis.com/auth/cloud-platform',
2316
+ * ],
2317
+ * });
2318
+ *
2319
+ * // Acquire an auth client, and bind it to all future calls
2320
+ * const authClient = await auth.getClient();
2321
+ * google.options({auth: authClient});
2322
+ *
2323
+ * // Do the magic
2324
+ * const res = await biglake.projects.locations.catalogs.databases.tables.list({
2325
+ * // The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
2326
+ * pageSize: 'placeholder-value',
2327
+ * // A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.
2328
+ * pageToken: 'placeholder-value',
2329
+ * // Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
2330
+ * parent:
2331
+ * 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
2332
+ * // The view for the returned tables.
2333
+ * view: 'placeholder-value',
2334
+ * });
2335
+ * console.log(res.data);
2336
+ *
2337
+ * // Example response
2338
+ * // {
2339
+ * // "nextPageToken": "my_nextPageToken",
2340
+ * // "tables": []
2341
+ * // }
2342
+ * }
2343
+ *
2344
+ * main().catch(e => {
2345
+ * console.error(e);
2346
+ * throw e;
2347
+ * });
2348
+ *
2349
+ * ```
1570
2350
  *
1571
2351
  * @param params - Parameters for request
1572
2352
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1659,6 +2439,79 @@ export namespace biglake_v1 {
1659
2439
 
1660
2440
  /**
1661
2441
  * Updates an existing table specified by the table ID.
2442
+ * @example
2443
+ * ```js
2444
+ * // Before running the sample:
2445
+ * // - Enable the API at:
2446
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
2447
+ * // - Login into gcloud by running:
2448
+ * // ```sh
2449
+ * // $ gcloud auth application-default login
2450
+ * // ```
2451
+ * // - Install the npm module by running:
2452
+ * // ```sh
2453
+ * // $ npm install googleapis
2454
+ * // ```
2455
+ *
2456
+ * const {google} = require('googleapis');
2457
+ * const biglake = google.biglake('v1');
2458
+ *
2459
+ * async function main() {
2460
+ * const auth = new google.auth.GoogleAuth({
2461
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2462
+ * scopes: [
2463
+ * 'https://www.googleapis.com/auth/bigquery',
2464
+ * 'https://www.googleapis.com/auth/cloud-platform',
2465
+ * ],
2466
+ * });
2467
+ *
2468
+ * // Acquire an auth client, and bind it to all future calls
2469
+ * const authClient = await auth.getClient();
2470
+ * google.options({auth: authClient});
2471
+ *
2472
+ * // Do the magic
2473
+ * const res = await biglake.projects.locations.catalogs.databases.tables.patch({
2474
+ * // Output only. The resource name. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}/tables/{table_id\}
2475
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
2476
+ * // The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.
2477
+ * updateMask: 'placeholder-value',
2478
+ *
2479
+ * // Request body metadata
2480
+ * requestBody: {
2481
+ * // request body parameters
2482
+ * // {
2483
+ * // "createTime": "my_createTime",
2484
+ * // "deleteTime": "my_deleteTime",
2485
+ * // "etag": "my_etag",
2486
+ * // "expireTime": "my_expireTime",
2487
+ * // "hiveOptions": {},
2488
+ * // "name": "my_name",
2489
+ * // "type": "my_type",
2490
+ * // "updateTime": "my_updateTime"
2491
+ * // }
2492
+ * },
2493
+ * });
2494
+ * console.log(res.data);
2495
+ *
2496
+ * // Example response
2497
+ * // {
2498
+ * // "createTime": "my_createTime",
2499
+ * // "deleteTime": "my_deleteTime",
2500
+ * // "etag": "my_etag",
2501
+ * // "expireTime": "my_expireTime",
2502
+ * // "hiveOptions": {},
2503
+ * // "name": "my_name",
2504
+ * // "type": "my_type",
2505
+ * // "updateTime": "my_updateTime"
2506
+ * // }
2507
+ * }
2508
+ *
2509
+ * main().catch(e => {
2510
+ * console.error(e);
2511
+ * throw e;
2512
+ * });
2513
+ *
2514
+ * ```
1662
2515
  *
1663
2516
  * @param params - Parameters for request
1664
2517
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1748,6 +2601,72 @@ export namespace biglake_v1 {
1748
2601
 
1749
2602
  /**
1750
2603
  * Renames an existing table specified by the table ID.
2604
+ * @example
2605
+ * ```js
2606
+ * // Before running the sample:
2607
+ * // - Enable the API at:
2608
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
2609
+ * // - Login into gcloud by running:
2610
+ * // ```sh
2611
+ * // $ gcloud auth application-default login
2612
+ * // ```
2613
+ * // - Install the npm module by running:
2614
+ * // ```sh
2615
+ * // $ npm install googleapis
2616
+ * // ```
2617
+ *
2618
+ * const {google} = require('googleapis');
2619
+ * const biglake = google.biglake('v1');
2620
+ *
2621
+ * async function main() {
2622
+ * const auth = new google.auth.GoogleAuth({
2623
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2624
+ * scopes: [
2625
+ * 'https://www.googleapis.com/auth/bigquery',
2626
+ * 'https://www.googleapis.com/auth/cloud-platform',
2627
+ * ],
2628
+ * });
2629
+ *
2630
+ * // Acquire an auth client, and bind it to all future calls
2631
+ * const authClient = await auth.getClient();
2632
+ * google.options({auth: authClient});
2633
+ *
2634
+ * // Do the magic
2635
+ * const res = await biglake.projects.locations.catalogs.databases.tables.rename(
2636
+ * {
2637
+ * // Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}/tables/{table_id\}
2638
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
2639
+ *
2640
+ * // Request body metadata
2641
+ * requestBody: {
2642
+ * // request body parameters
2643
+ * // {
2644
+ * // "newName": "my_newName"
2645
+ * // }
2646
+ * },
2647
+ * },
2648
+ * );
2649
+ * console.log(res.data);
2650
+ *
2651
+ * // Example response
2652
+ * // {
2653
+ * // "createTime": "my_createTime",
2654
+ * // "deleteTime": "my_deleteTime",
2655
+ * // "etag": "my_etag",
2656
+ * // "expireTime": "my_expireTime",
2657
+ * // "hiveOptions": {},
2658
+ * // "name": "my_name",
2659
+ * // "type": "my_type",
2660
+ * // "updateTime": "my_updateTime"
2661
+ * // }
2662
+ * }
2663
+ *
2664
+ * main().catch(e => {
2665
+ * console.error(e);
2666
+ * throw e;
2667
+ * });
2668
+ *
2669
+ * ```
1751
2670
  *
1752
2671
  * @param params - Parameters for request
1753
2672
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.