@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/build/v1.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
3
2
  import { Readable } from 'stream';
4
3
  export declare namespace biglake_v1 {
@@ -294,6 +293,73 @@ export declare namespace biglake_v1 {
294
293
  constructor(context: APIRequestContext);
295
294
  /**
296
295
  * Creates a new catalog.
296
+ * @example
297
+ * ```js
298
+ * // Before running the sample:
299
+ * // - Enable the API at:
300
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
301
+ * // - Login into gcloud by running:
302
+ * // ```sh
303
+ * // $ gcloud auth application-default login
304
+ * // ```
305
+ * // - Install the npm module by running:
306
+ * // ```sh
307
+ * // $ npm install googleapis
308
+ * // ```
309
+ *
310
+ * const {google} = require('googleapis');
311
+ * const biglake = google.biglake('v1');
312
+ *
313
+ * async function main() {
314
+ * const auth = new google.auth.GoogleAuth({
315
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
316
+ * scopes: [
317
+ * 'https://www.googleapis.com/auth/bigquery',
318
+ * 'https://www.googleapis.com/auth/cloud-platform',
319
+ * ],
320
+ * });
321
+ *
322
+ * // Acquire an auth client, and bind it to all future calls
323
+ * const authClient = await auth.getClient();
324
+ * google.options({auth: authClient});
325
+ *
326
+ * // Do the magic
327
+ * const res = await biglake.projects.locations.catalogs.create({
328
+ * // Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
329
+ * catalogId: 'placeholder-value',
330
+ * // Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}
331
+ * parent: 'projects/my-project/locations/my-location',
332
+ *
333
+ * // Request body metadata
334
+ * requestBody: {
335
+ * // request body parameters
336
+ * // {
337
+ * // "createTime": "my_createTime",
338
+ * // "deleteTime": "my_deleteTime",
339
+ * // "expireTime": "my_expireTime",
340
+ * // "name": "my_name",
341
+ * // "updateTime": "my_updateTime"
342
+ * // }
343
+ * },
344
+ * });
345
+ * console.log(res.data);
346
+ *
347
+ * // Example response
348
+ * // {
349
+ * // "createTime": "my_createTime",
350
+ * // "deleteTime": "my_deleteTime",
351
+ * // "expireTime": "my_expireTime",
352
+ * // "name": "my_name",
353
+ * // "updateTime": "my_updateTime"
354
+ * // }
355
+ * }
356
+ *
357
+ * main().catch(e => {
358
+ * console.error(e);
359
+ * throw e;
360
+ * });
361
+ *
362
+ * ```
297
363
  *
298
364
  * @param params - Parameters for request
299
365
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -308,6 +374,59 @@ export declare namespace biglake_v1 {
308
374
  create(callback: BodyResponseCallback<Schema$Catalog>): void;
309
375
  /**
310
376
  * Deletes an existing catalog specified by the catalog ID.
377
+ * @example
378
+ * ```js
379
+ * // Before running the sample:
380
+ * // - Enable the API at:
381
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
382
+ * // - Login into gcloud by running:
383
+ * // ```sh
384
+ * // $ gcloud auth application-default login
385
+ * // ```
386
+ * // - Install the npm module by running:
387
+ * // ```sh
388
+ * // $ npm install googleapis
389
+ * // ```
390
+ *
391
+ * const {google} = require('googleapis');
392
+ * const biglake = google.biglake('v1');
393
+ *
394
+ * async function main() {
395
+ * const auth = new google.auth.GoogleAuth({
396
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
397
+ * scopes: [
398
+ * 'https://www.googleapis.com/auth/bigquery',
399
+ * 'https://www.googleapis.com/auth/cloud-platform',
400
+ * ],
401
+ * });
402
+ *
403
+ * // Acquire an auth client, and bind it to all future calls
404
+ * const authClient = await auth.getClient();
405
+ * google.options({auth: authClient});
406
+ *
407
+ * // Do the magic
408
+ * const res = await biglake.projects.locations.catalogs.delete({
409
+ * // Required. The name of the catalog to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
410
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog',
411
+ * });
412
+ * console.log(res.data);
413
+ *
414
+ * // Example response
415
+ * // {
416
+ * // "createTime": "my_createTime",
417
+ * // "deleteTime": "my_deleteTime",
418
+ * // "expireTime": "my_expireTime",
419
+ * // "name": "my_name",
420
+ * // "updateTime": "my_updateTime"
421
+ * // }
422
+ * }
423
+ *
424
+ * main().catch(e => {
425
+ * console.error(e);
426
+ * throw e;
427
+ * });
428
+ *
429
+ * ```
311
430
  *
312
431
  * @param params - Parameters for request
313
432
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -322,6 +441,59 @@ export declare namespace biglake_v1 {
322
441
  delete(callback: BodyResponseCallback<Schema$Catalog>): void;
323
442
  /**
324
443
  * Gets the catalog specified by the resource name.
444
+ * @example
445
+ * ```js
446
+ * // Before running the sample:
447
+ * // - Enable the API at:
448
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
449
+ * // - Login into gcloud by running:
450
+ * // ```sh
451
+ * // $ gcloud auth application-default login
452
+ * // ```
453
+ * // - Install the npm module by running:
454
+ * // ```sh
455
+ * // $ npm install googleapis
456
+ * // ```
457
+ *
458
+ * const {google} = require('googleapis');
459
+ * const biglake = google.biglake('v1');
460
+ *
461
+ * async function main() {
462
+ * const auth = new google.auth.GoogleAuth({
463
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
464
+ * scopes: [
465
+ * 'https://www.googleapis.com/auth/bigquery',
466
+ * 'https://www.googleapis.com/auth/cloud-platform',
467
+ * ],
468
+ * });
469
+ *
470
+ * // Acquire an auth client, and bind it to all future calls
471
+ * const authClient = await auth.getClient();
472
+ * google.options({auth: authClient});
473
+ *
474
+ * // Do the magic
475
+ * const res = await biglake.projects.locations.catalogs.get({
476
+ * // Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
477
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog',
478
+ * });
479
+ * console.log(res.data);
480
+ *
481
+ * // Example response
482
+ * // {
483
+ * // "createTime": "my_createTime",
484
+ * // "deleteTime": "my_deleteTime",
485
+ * // "expireTime": "my_expireTime",
486
+ * // "name": "my_name",
487
+ * // "updateTime": "my_updateTime"
488
+ * // }
489
+ * }
490
+ *
491
+ * main().catch(e => {
492
+ * console.error(e);
493
+ * throw e;
494
+ * });
495
+ *
496
+ * ```
325
497
  *
326
498
  * @param params - Parameters for request
327
499
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -336,6 +508,60 @@ export declare namespace biglake_v1 {
336
508
  get(callback: BodyResponseCallback<Schema$Catalog>): void;
337
509
  /**
338
510
  * List all catalogs in a specified project.
511
+ * @example
512
+ * ```js
513
+ * // Before running the sample:
514
+ * // - Enable the API at:
515
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
516
+ * // - Login into gcloud by running:
517
+ * // ```sh
518
+ * // $ gcloud auth application-default login
519
+ * // ```
520
+ * // - Install the npm module by running:
521
+ * // ```sh
522
+ * // $ npm install googleapis
523
+ * // ```
524
+ *
525
+ * const {google} = require('googleapis');
526
+ * const biglake = google.biglake('v1');
527
+ *
528
+ * async function main() {
529
+ * const auth = new google.auth.GoogleAuth({
530
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
531
+ * scopes: [
532
+ * 'https://www.googleapis.com/auth/bigquery',
533
+ * 'https://www.googleapis.com/auth/cloud-platform',
534
+ * ],
535
+ * });
536
+ *
537
+ * // Acquire an auth client, and bind it to all future calls
538
+ * const authClient = await auth.getClient();
539
+ * google.options({auth: authClient});
540
+ *
541
+ * // Do the magic
542
+ * const res = await biglake.projects.locations.catalogs.list({
543
+ * // 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.
544
+ * pageSize: 'placeholder-value',
545
+ * // 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.
546
+ * pageToken: 'placeholder-value',
547
+ * // Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number\}/locations/{location_id\}
548
+ * parent: 'projects/my-project/locations/my-location',
549
+ * });
550
+ * console.log(res.data);
551
+ *
552
+ * // Example response
553
+ * // {
554
+ * // "catalogs": [],
555
+ * // "nextPageToken": "my_nextPageToken"
556
+ * // }
557
+ * }
558
+ *
559
+ * main().catch(e => {
560
+ * console.error(e);
561
+ * throw e;
562
+ * });
563
+ *
564
+ * ```
339
565
  *
340
566
  * @param params - Parameters for request
341
567
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -395,6 +621,77 @@ export declare namespace biglake_v1 {
395
621
  constructor(context: APIRequestContext);
396
622
  /**
397
623
  * Creates a new database.
624
+ * @example
625
+ * ```js
626
+ * // Before running the sample:
627
+ * // - Enable the API at:
628
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
629
+ * // - Login into gcloud by running:
630
+ * // ```sh
631
+ * // $ gcloud auth application-default login
632
+ * // ```
633
+ * // - Install the npm module by running:
634
+ * // ```sh
635
+ * // $ npm install googleapis
636
+ * // ```
637
+ *
638
+ * const {google} = require('googleapis');
639
+ * const biglake = google.biglake('v1');
640
+ *
641
+ * async function main() {
642
+ * const auth = new google.auth.GoogleAuth({
643
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
644
+ * scopes: [
645
+ * 'https://www.googleapis.com/auth/bigquery',
646
+ * 'https://www.googleapis.com/auth/cloud-platform',
647
+ * ],
648
+ * });
649
+ *
650
+ * // Acquire an auth client, and bind it to all future calls
651
+ * const authClient = await auth.getClient();
652
+ * google.options({auth: authClient});
653
+ *
654
+ * // Do the magic
655
+ * const res = await biglake.projects.locations.catalogs.databases.create({
656
+ * // Required. The ID to use for the database, which will become the final component of the database's resource name.
657
+ * databaseId: 'placeholder-value',
658
+ * // Required. The parent resource where this database will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
659
+ * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog',
660
+ *
661
+ * // Request body metadata
662
+ * requestBody: {
663
+ * // request body parameters
664
+ * // {
665
+ * // "createTime": "my_createTime",
666
+ * // "deleteTime": "my_deleteTime",
667
+ * // "expireTime": "my_expireTime",
668
+ * // "hiveOptions": {},
669
+ * // "name": "my_name",
670
+ * // "type": "my_type",
671
+ * // "updateTime": "my_updateTime"
672
+ * // }
673
+ * },
674
+ * });
675
+ * console.log(res.data);
676
+ *
677
+ * // Example response
678
+ * // {
679
+ * // "createTime": "my_createTime",
680
+ * // "deleteTime": "my_deleteTime",
681
+ * // "expireTime": "my_expireTime",
682
+ * // "hiveOptions": {},
683
+ * // "name": "my_name",
684
+ * // "type": "my_type",
685
+ * // "updateTime": "my_updateTime"
686
+ * // }
687
+ * }
688
+ *
689
+ * main().catch(e => {
690
+ * console.error(e);
691
+ * throw e;
692
+ * });
693
+ *
694
+ * ```
398
695
  *
399
696
  * @param params - Parameters for request
400
697
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -409,6 +706,61 @@ export declare namespace biglake_v1 {
409
706
  create(callback: BodyResponseCallback<Schema$Database>): void;
410
707
  /**
411
708
  * Deletes an existing database specified by the database ID.
709
+ * @example
710
+ * ```js
711
+ * // Before running the sample:
712
+ * // - Enable the API at:
713
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
714
+ * // - Login into gcloud by running:
715
+ * // ```sh
716
+ * // $ gcloud auth application-default login
717
+ * // ```
718
+ * // - Install the npm module by running:
719
+ * // ```sh
720
+ * // $ npm install googleapis
721
+ * // ```
722
+ *
723
+ * const {google} = require('googleapis');
724
+ * const biglake = google.biglake('v1');
725
+ *
726
+ * async function main() {
727
+ * const auth = new google.auth.GoogleAuth({
728
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
729
+ * scopes: [
730
+ * 'https://www.googleapis.com/auth/bigquery',
731
+ * 'https://www.googleapis.com/auth/cloud-platform',
732
+ * ],
733
+ * });
734
+ *
735
+ * // Acquire an auth client, and bind it to all future calls
736
+ * const authClient = await auth.getClient();
737
+ * google.options({auth: authClient});
738
+ *
739
+ * // Do the magic
740
+ * const res = await biglake.projects.locations.catalogs.databases.delete({
741
+ * // Required. The name of the database to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
742
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
743
+ * });
744
+ * console.log(res.data);
745
+ *
746
+ * // Example response
747
+ * // {
748
+ * // "createTime": "my_createTime",
749
+ * // "deleteTime": "my_deleteTime",
750
+ * // "expireTime": "my_expireTime",
751
+ * // "hiveOptions": {},
752
+ * // "name": "my_name",
753
+ * // "type": "my_type",
754
+ * // "updateTime": "my_updateTime"
755
+ * // }
756
+ * }
757
+ *
758
+ * main().catch(e => {
759
+ * console.error(e);
760
+ * throw e;
761
+ * });
762
+ *
763
+ * ```
412
764
  *
413
765
  * @param params - Parameters for request
414
766
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -423,6 +775,61 @@ export declare namespace biglake_v1 {
423
775
  delete(callback: BodyResponseCallback<Schema$Database>): void;
424
776
  /**
425
777
  * Gets the database specified by the resource name.
778
+ * @example
779
+ * ```js
780
+ * // Before running the sample:
781
+ * // - Enable the API at:
782
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
783
+ * // - Login into gcloud by running:
784
+ * // ```sh
785
+ * // $ gcloud auth application-default login
786
+ * // ```
787
+ * // - Install the npm module by running:
788
+ * // ```sh
789
+ * // $ npm install googleapis
790
+ * // ```
791
+ *
792
+ * const {google} = require('googleapis');
793
+ * const biglake = google.biglake('v1');
794
+ *
795
+ * async function main() {
796
+ * const auth = new google.auth.GoogleAuth({
797
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
798
+ * scopes: [
799
+ * 'https://www.googleapis.com/auth/bigquery',
800
+ * 'https://www.googleapis.com/auth/cloud-platform',
801
+ * ],
802
+ * });
803
+ *
804
+ * // Acquire an auth client, and bind it to all future calls
805
+ * const authClient = await auth.getClient();
806
+ * google.options({auth: authClient});
807
+ *
808
+ * // Do the magic
809
+ * const res = await biglake.projects.locations.catalogs.databases.get({
810
+ * // Required. The name of the database to retrieve. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
811
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
812
+ * });
813
+ * console.log(res.data);
814
+ *
815
+ * // Example response
816
+ * // {
817
+ * // "createTime": "my_createTime",
818
+ * // "deleteTime": "my_deleteTime",
819
+ * // "expireTime": "my_expireTime",
820
+ * // "hiveOptions": {},
821
+ * // "name": "my_name",
822
+ * // "type": "my_type",
823
+ * // "updateTime": "my_updateTime"
824
+ * // }
825
+ * }
826
+ *
827
+ * main().catch(e => {
828
+ * console.error(e);
829
+ * throw e;
830
+ * });
831
+ *
832
+ * ```
426
833
  *
427
834
  * @param params - Parameters for request
428
835
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -437,6 +844,60 @@ export declare namespace biglake_v1 {
437
844
  get(callback: BodyResponseCallback<Schema$Database>): void;
438
845
  /**
439
846
  * List all databases in a specified catalog.
847
+ * @example
848
+ * ```js
849
+ * // Before running the sample:
850
+ * // - Enable the API at:
851
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
852
+ * // - Login into gcloud by running:
853
+ * // ```sh
854
+ * // $ gcloud auth application-default login
855
+ * // ```
856
+ * // - Install the npm module by running:
857
+ * // ```sh
858
+ * // $ npm install googleapis
859
+ * // ```
860
+ *
861
+ * const {google} = require('googleapis');
862
+ * const biglake = google.biglake('v1');
863
+ *
864
+ * async function main() {
865
+ * const auth = new google.auth.GoogleAuth({
866
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
867
+ * scopes: [
868
+ * 'https://www.googleapis.com/auth/bigquery',
869
+ * 'https://www.googleapis.com/auth/cloud-platform',
870
+ * ],
871
+ * });
872
+ *
873
+ * // Acquire an auth client, and bind it to all future calls
874
+ * const authClient = await auth.getClient();
875
+ * google.options({auth: authClient});
876
+ *
877
+ * // Do the magic
878
+ * const res = await biglake.projects.locations.catalogs.databases.list({
879
+ * // 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.
880
+ * pageSize: 'placeholder-value',
881
+ * // 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.
882
+ * pageToken: 'placeholder-value',
883
+ * // Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}
884
+ * parent: 'projects/my-project/locations/my-location/catalogs/my-catalog',
885
+ * });
886
+ * console.log(res.data);
887
+ *
888
+ * // Example response
889
+ * // {
890
+ * // "databases": [],
891
+ * // "nextPageToken": "my_nextPageToken"
892
+ * // }
893
+ * }
894
+ *
895
+ * main().catch(e => {
896
+ * console.error(e);
897
+ * throw e;
898
+ * });
899
+ *
900
+ * ```
440
901
  *
441
902
  * @param params - Parameters for request
442
903
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -451,6 +912,77 @@ export declare namespace biglake_v1 {
451
912
  list(callback: BodyResponseCallback<Schema$ListDatabasesResponse>): void;
452
913
  /**
453
914
  * Updates an existing database specified by the database ID.
915
+ * @example
916
+ * ```js
917
+ * // Before running the sample:
918
+ * // - Enable the API at:
919
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
920
+ * // - Login into gcloud by running:
921
+ * // ```sh
922
+ * // $ gcloud auth application-default login
923
+ * // ```
924
+ * // - Install the npm module by running:
925
+ * // ```sh
926
+ * // $ npm install googleapis
927
+ * // ```
928
+ *
929
+ * const {google} = require('googleapis');
930
+ * const biglake = google.biglake('v1');
931
+ *
932
+ * async function main() {
933
+ * const auth = new google.auth.GoogleAuth({
934
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
935
+ * scopes: [
936
+ * 'https://www.googleapis.com/auth/bigquery',
937
+ * 'https://www.googleapis.com/auth/cloud-platform',
938
+ * ],
939
+ * });
940
+ *
941
+ * // Acquire an auth client, and bind it to all future calls
942
+ * const authClient = await auth.getClient();
943
+ * google.options({auth: authClient});
944
+ *
945
+ * // Do the magic
946
+ * const res = await biglake.projects.locations.catalogs.databases.patch({
947
+ * // Output only. The resource name. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
948
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
949
+ * // 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.
950
+ * updateMask: 'placeholder-value',
951
+ *
952
+ * // Request body metadata
953
+ * requestBody: {
954
+ * // request body parameters
955
+ * // {
956
+ * // "createTime": "my_createTime",
957
+ * // "deleteTime": "my_deleteTime",
958
+ * // "expireTime": "my_expireTime",
959
+ * // "hiveOptions": {},
960
+ * // "name": "my_name",
961
+ * // "type": "my_type",
962
+ * // "updateTime": "my_updateTime"
963
+ * // }
964
+ * },
965
+ * });
966
+ * console.log(res.data);
967
+ *
968
+ * // Example response
969
+ * // {
970
+ * // "createTime": "my_createTime",
971
+ * // "deleteTime": "my_deleteTime",
972
+ * // "expireTime": "my_expireTime",
973
+ * // "hiveOptions": {},
974
+ * // "name": "my_name",
975
+ * // "type": "my_type",
976
+ * // "updateTime": "my_updateTime"
977
+ * // }
978
+ * }
979
+ *
980
+ * main().catch(e => {
981
+ * console.error(e);
982
+ * throw e;
983
+ * });
984
+ *
985
+ * ```
454
986
  *
455
987
  * @param params - Parameters for request
456
988
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -523,6 +1055,82 @@ export declare namespace biglake_v1 {
523
1055
  constructor(context: APIRequestContext);
524
1056
  /**
525
1057
  * Creates a new table.
1058
+ * @example
1059
+ * ```js
1060
+ * // Before running the sample:
1061
+ * // - Enable the API at:
1062
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1063
+ * // - Login into gcloud by running:
1064
+ * // ```sh
1065
+ * // $ gcloud auth application-default login
1066
+ * // ```
1067
+ * // - Install the npm module by running:
1068
+ * // ```sh
1069
+ * // $ npm install googleapis
1070
+ * // ```
1071
+ *
1072
+ * const {google} = require('googleapis');
1073
+ * const biglake = google.biglake('v1');
1074
+ *
1075
+ * async function main() {
1076
+ * const auth = new google.auth.GoogleAuth({
1077
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1078
+ * scopes: [
1079
+ * 'https://www.googleapis.com/auth/bigquery',
1080
+ * 'https://www.googleapis.com/auth/cloud-platform',
1081
+ * ],
1082
+ * });
1083
+ *
1084
+ * // Acquire an auth client, and bind it to all future calls
1085
+ * const authClient = await auth.getClient();
1086
+ * google.options({auth: authClient});
1087
+ *
1088
+ * // Do the magic
1089
+ * const res = await biglake.projects.locations.catalogs.databases.tables.create(
1090
+ * {
1091
+ * // 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\}
1092
+ * parent:
1093
+ * 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1094
+ * // Required. The ID to use for the table, which will become the final component of the table's resource name.
1095
+ * tableId: 'placeholder-value',
1096
+ *
1097
+ * // Request body metadata
1098
+ * requestBody: {
1099
+ * // request body parameters
1100
+ * // {
1101
+ * // "createTime": "my_createTime",
1102
+ * // "deleteTime": "my_deleteTime",
1103
+ * // "etag": "my_etag",
1104
+ * // "expireTime": "my_expireTime",
1105
+ * // "hiveOptions": {},
1106
+ * // "name": "my_name",
1107
+ * // "type": "my_type",
1108
+ * // "updateTime": "my_updateTime"
1109
+ * // }
1110
+ * },
1111
+ * },
1112
+ * );
1113
+ * console.log(res.data);
1114
+ *
1115
+ * // Example response
1116
+ * // {
1117
+ * // "createTime": "my_createTime",
1118
+ * // "deleteTime": "my_deleteTime",
1119
+ * // "etag": "my_etag",
1120
+ * // "expireTime": "my_expireTime",
1121
+ * // "hiveOptions": {},
1122
+ * // "name": "my_name",
1123
+ * // "type": "my_type",
1124
+ * // "updateTime": "my_updateTime"
1125
+ * // }
1126
+ * }
1127
+ *
1128
+ * main().catch(e => {
1129
+ * console.error(e);
1130
+ * throw e;
1131
+ * });
1132
+ *
1133
+ * ```
526
1134
  *
527
1135
  * @param params - Parameters for request
528
1136
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -537,6 +1145,64 @@ export declare namespace biglake_v1 {
537
1145
  create(callback: BodyResponseCallback<Schema$Table>): void;
538
1146
  /**
539
1147
  * Deletes an existing table specified by the table ID.
1148
+ * @example
1149
+ * ```js
1150
+ * // Before running the sample:
1151
+ * // - Enable the API at:
1152
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1153
+ * // - Login into gcloud by running:
1154
+ * // ```sh
1155
+ * // $ gcloud auth application-default login
1156
+ * // ```
1157
+ * // - Install the npm module by running:
1158
+ * // ```sh
1159
+ * // $ npm install googleapis
1160
+ * // ```
1161
+ *
1162
+ * const {google} = require('googleapis');
1163
+ * const biglake = google.biglake('v1');
1164
+ *
1165
+ * async function main() {
1166
+ * const auth = new google.auth.GoogleAuth({
1167
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1168
+ * scopes: [
1169
+ * 'https://www.googleapis.com/auth/bigquery',
1170
+ * 'https://www.googleapis.com/auth/cloud-platform',
1171
+ * ],
1172
+ * });
1173
+ *
1174
+ * // Acquire an auth client, and bind it to all future calls
1175
+ * const authClient = await auth.getClient();
1176
+ * google.options({auth: authClient});
1177
+ *
1178
+ * // Do the magic
1179
+ * const res = await biglake.projects.locations.catalogs.databases.tables.delete(
1180
+ * {
1181
+ * // 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\}
1182
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
1183
+ * },
1184
+ * );
1185
+ * console.log(res.data);
1186
+ *
1187
+ * // Example response
1188
+ * // {
1189
+ * // "createTime": "my_createTime",
1190
+ * // "deleteTime": "my_deleteTime",
1191
+ * // "etag": "my_etag",
1192
+ * // "expireTime": "my_expireTime",
1193
+ * // "hiveOptions": {},
1194
+ * // "name": "my_name",
1195
+ * // "type": "my_type",
1196
+ * // "updateTime": "my_updateTime"
1197
+ * // }
1198
+ * }
1199
+ *
1200
+ * main().catch(e => {
1201
+ * console.error(e);
1202
+ * throw e;
1203
+ * });
1204
+ *
1205
+ * ```
540
1206
  *
541
1207
  * @param params - Parameters for request
542
1208
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -551,6 +1217,62 @@ export declare namespace biglake_v1 {
551
1217
  delete(callback: BodyResponseCallback<Schema$Table>): void;
552
1218
  /**
553
1219
  * Gets the table specified by the resource name.
1220
+ * @example
1221
+ * ```js
1222
+ * // Before running the sample:
1223
+ * // - Enable the API at:
1224
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1225
+ * // - Login into gcloud by running:
1226
+ * // ```sh
1227
+ * // $ gcloud auth application-default login
1228
+ * // ```
1229
+ * // - Install the npm module by running:
1230
+ * // ```sh
1231
+ * // $ npm install googleapis
1232
+ * // ```
1233
+ *
1234
+ * const {google} = require('googleapis');
1235
+ * const biglake = google.biglake('v1');
1236
+ *
1237
+ * async function main() {
1238
+ * const auth = new google.auth.GoogleAuth({
1239
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1240
+ * scopes: [
1241
+ * 'https://www.googleapis.com/auth/bigquery',
1242
+ * 'https://www.googleapis.com/auth/cloud-platform',
1243
+ * ],
1244
+ * });
1245
+ *
1246
+ * // Acquire an auth client, and bind it to all future calls
1247
+ * const authClient = await auth.getClient();
1248
+ * google.options({auth: authClient});
1249
+ *
1250
+ * // Do the magic
1251
+ * const res = await biglake.projects.locations.catalogs.databases.tables.get({
1252
+ * // 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\}
1253
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
1254
+ * });
1255
+ * console.log(res.data);
1256
+ *
1257
+ * // Example response
1258
+ * // {
1259
+ * // "createTime": "my_createTime",
1260
+ * // "deleteTime": "my_deleteTime",
1261
+ * // "etag": "my_etag",
1262
+ * // "expireTime": "my_expireTime",
1263
+ * // "hiveOptions": {},
1264
+ * // "name": "my_name",
1265
+ * // "type": "my_type",
1266
+ * // "updateTime": "my_updateTime"
1267
+ * // }
1268
+ * }
1269
+ *
1270
+ * main().catch(e => {
1271
+ * console.error(e);
1272
+ * throw e;
1273
+ * });
1274
+ *
1275
+ * ```
554
1276
  *
555
1277
  * @param params - Parameters for request
556
1278
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -565,6 +1287,63 @@ export declare namespace biglake_v1 {
565
1287
  get(callback: BodyResponseCallback<Schema$Table>): void;
566
1288
  /**
567
1289
  * List all tables in a specified database.
1290
+ * @example
1291
+ * ```js
1292
+ * // Before running the sample:
1293
+ * // - Enable the API at:
1294
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1295
+ * // - Login into gcloud by running:
1296
+ * // ```sh
1297
+ * // $ gcloud auth application-default login
1298
+ * // ```
1299
+ * // - Install the npm module by running:
1300
+ * // ```sh
1301
+ * // $ npm install googleapis
1302
+ * // ```
1303
+ *
1304
+ * const {google} = require('googleapis');
1305
+ * const biglake = google.biglake('v1');
1306
+ *
1307
+ * async function main() {
1308
+ * const auth = new google.auth.GoogleAuth({
1309
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1310
+ * scopes: [
1311
+ * 'https://www.googleapis.com/auth/bigquery',
1312
+ * 'https://www.googleapis.com/auth/cloud-platform',
1313
+ * ],
1314
+ * });
1315
+ *
1316
+ * // Acquire an auth client, and bind it to all future calls
1317
+ * const authClient = await auth.getClient();
1318
+ * google.options({auth: authClient});
1319
+ *
1320
+ * // Do the magic
1321
+ * const res = await biglake.projects.locations.catalogs.databases.tables.list({
1322
+ * // 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.
1323
+ * pageSize: 'placeholder-value',
1324
+ * // 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.
1325
+ * pageToken: 'placeholder-value',
1326
+ * // Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}
1327
+ * parent:
1328
+ * 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database',
1329
+ * // The view for the returned tables.
1330
+ * view: 'placeholder-value',
1331
+ * });
1332
+ * console.log(res.data);
1333
+ *
1334
+ * // Example response
1335
+ * // {
1336
+ * // "nextPageToken": "my_nextPageToken",
1337
+ * // "tables": []
1338
+ * // }
1339
+ * }
1340
+ *
1341
+ * main().catch(e => {
1342
+ * console.error(e);
1343
+ * throw e;
1344
+ * });
1345
+ *
1346
+ * ```
568
1347
  *
569
1348
  * @param params - Parameters for request
570
1349
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -579,6 +1358,79 @@ export declare namespace biglake_v1 {
579
1358
  list(callback: BodyResponseCallback<Schema$ListTablesResponse>): void;
580
1359
  /**
581
1360
  * Updates an existing table specified by the table ID.
1361
+ * @example
1362
+ * ```js
1363
+ * // Before running the sample:
1364
+ * // - Enable the API at:
1365
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1366
+ * // - Login into gcloud by running:
1367
+ * // ```sh
1368
+ * // $ gcloud auth application-default login
1369
+ * // ```
1370
+ * // - Install the npm module by running:
1371
+ * // ```sh
1372
+ * // $ npm install googleapis
1373
+ * // ```
1374
+ *
1375
+ * const {google} = require('googleapis');
1376
+ * const biglake = google.biglake('v1');
1377
+ *
1378
+ * async function main() {
1379
+ * const auth = new google.auth.GoogleAuth({
1380
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1381
+ * scopes: [
1382
+ * 'https://www.googleapis.com/auth/bigquery',
1383
+ * 'https://www.googleapis.com/auth/cloud-platform',
1384
+ * ],
1385
+ * });
1386
+ *
1387
+ * // Acquire an auth client, and bind it to all future calls
1388
+ * const authClient = await auth.getClient();
1389
+ * google.options({auth: authClient});
1390
+ *
1391
+ * // Do the magic
1392
+ * const res = await biglake.projects.locations.catalogs.databases.tables.patch({
1393
+ * // Output only. The resource name. Format: projects/{project_id_or_number\}/locations/{location_id\}/catalogs/{catalog_id\}/databases/{database_id\}/tables/{table_id\}
1394
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
1395
+ * // 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.
1396
+ * updateMask: 'placeholder-value',
1397
+ *
1398
+ * // Request body metadata
1399
+ * requestBody: {
1400
+ * // request body parameters
1401
+ * // {
1402
+ * // "createTime": "my_createTime",
1403
+ * // "deleteTime": "my_deleteTime",
1404
+ * // "etag": "my_etag",
1405
+ * // "expireTime": "my_expireTime",
1406
+ * // "hiveOptions": {},
1407
+ * // "name": "my_name",
1408
+ * // "type": "my_type",
1409
+ * // "updateTime": "my_updateTime"
1410
+ * // }
1411
+ * },
1412
+ * });
1413
+ * console.log(res.data);
1414
+ *
1415
+ * // Example response
1416
+ * // {
1417
+ * // "createTime": "my_createTime",
1418
+ * // "deleteTime": "my_deleteTime",
1419
+ * // "etag": "my_etag",
1420
+ * // "expireTime": "my_expireTime",
1421
+ * // "hiveOptions": {},
1422
+ * // "name": "my_name",
1423
+ * // "type": "my_type",
1424
+ * // "updateTime": "my_updateTime"
1425
+ * // }
1426
+ * }
1427
+ *
1428
+ * main().catch(e => {
1429
+ * console.error(e);
1430
+ * throw e;
1431
+ * });
1432
+ *
1433
+ * ```
582
1434
  *
583
1435
  * @param params - Parameters for request
584
1436
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -593,6 +1445,72 @@ export declare namespace biglake_v1 {
593
1445
  patch(callback: BodyResponseCallback<Schema$Table>): void;
594
1446
  /**
595
1447
  * Renames an existing table specified by the table ID.
1448
+ * @example
1449
+ * ```js
1450
+ * // Before running the sample:
1451
+ * // - Enable the API at:
1452
+ * // https://console.developers.google.com/apis/api/biglake.googleapis.com
1453
+ * // - Login into gcloud by running:
1454
+ * // ```sh
1455
+ * // $ gcloud auth application-default login
1456
+ * // ```
1457
+ * // - Install the npm module by running:
1458
+ * // ```sh
1459
+ * // $ npm install googleapis
1460
+ * // ```
1461
+ *
1462
+ * const {google} = require('googleapis');
1463
+ * const biglake = google.biglake('v1');
1464
+ *
1465
+ * async function main() {
1466
+ * const auth = new google.auth.GoogleAuth({
1467
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1468
+ * scopes: [
1469
+ * 'https://www.googleapis.com/auth/bigquery',
1470
+ * 'https://www.googleapis.com/auth/cloud-platform',
1471
+ * ],
1472
+ * });
1473
+ *
1474
+ * // Acquire an auth client, and bind it to all future calls
1475
+ * const authClient = await auth.getClient();
1476
+ * google.options({auth: authClient});
1477
+ *
1478
+ * // Do the magic
1479
+ * const res = await biglake.projects.locations.catalogs.databases.tables.rename(
1480
+ * {
1481
+ * // 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\}
1482
+ * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/databases/my-database/tables/my-table',
1483
+ *
1484
+ * // Request body metadata
1485
+ * requestBody: {
1486
+ * // request body parameters
1487
+ * // {
1488
+ * // "newName": "my_newName"
1489
+ * // }
1490
+ * },
1491
+ * },
1492
+ * );
1493
+ * console.log(res.data);
1494
+ *
1495
+ * // Example response
1496
+ * // {
1497
+ * // "createTime": "my_createTime",
1498
+ * // "deleteTime": "my_deleteTime",
1499
+ * // "etag": "my_etag",
1500
+ * // "expireTime": "my_expireTime",
1501
+ * // "hiveOptions": {},
1502
+ * // "name": "my_name",
1503
+ * // "type": "my_type",
1504
+ * // "updateTime": "my_updateTime"
1505
+ * // }
1506
+ * }
1507
+ *
1508
+ * main().catch(e => {
1509
+ * console.error(e);
1510
+ * throw e;
1511
+ * });
1512
+ *
1513
+ * ```
596
1514
  *
597
1515
  * @param params - Parameters for request
598
1516
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.