@maxim_mazurok/gapi.client.bigquery-v2 0.0.20230812 → 0.0.20231008

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 +73 -6
  2. package/package.json +1 -1
  3. package/tests.ts +23 -7
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://bigquery.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20230812
12
+ // Revision: 20231008
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -48,6 +48,18 @@ declare namespace gapi.client {
48
48
  threshold?:
49
49
  number;
50
50
  }
51
+ interface AggregationThresholdPolicy {
52
+ /**
53
+ * Optional. The privacy unit column(s) associated with this policy. For now, only one column per data source object (table, view) is allowed as a privacy unit column. Representing as
54
+ * a repeated field in metadata for extensibility to multiple columns in future. Duplicates and Repeated struct fields are not allowed. For nested fields, use dot notation
55
+ * ("outer.inner")
56
+ */
57
+ privacyUnitColumns?:
58
+ string[];
59
+ /** Optional. The threshold for the "aggregation threshold" policy. */
60
+ threshold?:
61
+ string;
62
+ }
51
63
  interface Argument {
52
64
  /** Optional. Defaults to FIXED_TYPE. */
53
65
  argumentKind?:
@@ -55,6 +67,12 @@ declare namespace gapi.client {
55
67
  /** Required unless argument_kind = ANY_TYPE. */
56
68
  dataType?:
57
69
  StandardSqlDataType;
70
+ /**
71
+ * Optional. Whether the argument is an aggregate function parameter. Must be Unset for routine types other than AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is
72
+ * equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is equivalent to omitting "NOT AGGREGATE" clause in DDL.
73
+ */
74
+ isAggregate?:
75
+ boolean;
58
76
  /** Optional. Specifies whether the argument is input or output. Can be set for procedures only. */
59
77
  mode?:
60
78
  string;
@@ -598,7 +616,7 @@ declare namespace gapi.client {
598
616
  fieldDelimiter?:
599
617
  string;
600
618
  /** [Optional] An custom string that will represent a NULL value in CSV import data. */
601
- null_marker?:
619
+ nullMarker?:
602
620
  string;
603
621
  /**
604
622
  * [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored
@@ -1491,6 +1509,12 @@ declare namespace gapi.client {
1491
1509
  /** [Output-only] Opaque ID field of the job */
1492
1510
  id?:
1493
1511
  string;
1512
+ /**
1513
+ * [Output-only] If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always
1514
+ * be created.
1515
+ */
1516
+ jobCreationReason?:
1517
+ any;
1494
1518
  /** [Optional] Reference describing the unique-per-user name of the job. */
1495
1519
  jobReference?:
1496
1520
  JobReference;
@@ -1927,6 +1951,11 @@ declare namespace gapi.client {
1927
1951
  writeDisposition?:
1928
1952
  string;
1929
1953
  }
1954
+ interface JobCreationReason {
1955
+ /** Output only. Specifies the high level reason why a Job was created. */
1956
+ code?:
1957
+ string;
1958
+ }
1930
1959
  interface JobList {
1931
1960
  /** A hash of this page of results. */
1932
1961
  etag?:
@@ -2075,7 +2104,7 @@ declare namespace gapi.client {
2075
2104
  */
2076
2105
  ddlOperationPerformed?:
2077
2106
  string;
2078
- /** [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. */
2107
+ /** [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries. */
2079
2108
  ddlTargetDataset?:
2080
2109
  DatasetReference;
2081
2110
  /** The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */
@@ -2481,6 +2510,11 @@ declare namespace gapi.client {
2481
2510
  principalComponentId?:
2482
2511
  string;
2483
2512
  }
2513
+ interface PrivacyPolicy {
2514
+ /** Optional. Policy used for aggregation thresholds. */
2515
+ aggregationThresholdPolicy?:
2516
+ AggregationThresholdPolicy;
2517
+ }
2484
2518
  interface ProjectList {
2485
2519
  /** A hash of the page of results */
2486
2520
  etag?:
@@ -2587,6 +2621,12 @@ declare namespace gapi.client {
2587
2621
  */
2588
2622
  dryRun?:
2589
2623
  boolean;
2624
+ /**
2625
+ * Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be
2626
+ * created.
2627
+ */
2628
+ jobCreationMode?:
2629
+ string;
2590
2630
  /** The resource type of the request. */
2591
2631
  kind?:
2592
2632
  string;
@@ -2673,6 +2713,13 @@ declare namespace gapi.client {
2673
2713
  /** Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. */
2674
2714
  jobComplete?:
2675
2715
  boolean;
2716
+ /**
2717
+ * Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be
2718
+ * interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available.
2719
+ * Jobs will always be created.
2720
+ */
2721
+ jobCreationReason?:
2722
+ any;
2676
2723
  /**
2677
2724
  * Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the
2678
2725
  * results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
@@ -2688,6 +2735,9 @@ declare namespace gapi.client {
2688
2735
  /** A token used for paging results. */
2689
2736
  pageToken?:
2690
2737
  string;
2738
+ /** Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated. */
2739
+ queryId?:
2740
+ string;
2691
2741
  /**
2692
2742
  * An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference
2693
2743
  * returned above.
@@ -2829,7 +2879,10 @@ declare namespace gapi.client {
2829
2879
  /** Output only. The time when this routine was created, in milliseconds since the epoch. */
2830
2880
  creationTime?:
2831
2881
  string;
2832
- /** Optional. Data governance specific option, if the value is DATA_MASKING, the function will be validated as masking functions. */
2882
+ /**
2883
+ * Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking
2884
+ * routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask).
2885
+ */
2833
2886
  dataGovernanceType?:
2834
2887
  string;
2835
2888
  /**
@@ -2883,6 +2936,9 @@ declare namespace gapi.client {
2883
2936
  /** Required. The type of routine. */
2884
2937
  routineType?:
2885
2938
  string;
2939
+ /** Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration. */
2940
+ securityMode?:
2941
+ string;
2886
2942
  /** Optional. Spark specific options. */
2887
2943
  sparkOptions?:
2888
2944
  SparkOptions;
@@ -3023,10 +3079,10 @@ declare namespace gapi.client {
3023
3079
  }
3024
3080
  interface SparkLoggingInfo {
3025
3081
  /** [Output-only] Project ID used for logging */
3026
- project_id?:
3082
+ projectId?:
3027
3083
  string;
3028
3084
  /** [Output-only] Resource type used for logging */
3029
- resource_type?:
3085
+ resourceType?:
3030
3086
  string;
3031
3087
  }
3032
3088
  interface SparkOptions {
@@ -3114,6 +3170,7 @@ declare namespace gapi.client {
3114
3170
  StandardSqlDataType;
3115
3171
  }
3116
3172
  interface StandardSqlStructType {
3173
+ /** Fields within the struct. */
3117
3174
  fields?:
3118
3175
  StandardSqlField[];
3119
3176
  }
@@ -3260,6 +3317,13 @@ declare namespace gapi.client {
3260
3317
  /** [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. */
3261
3318
  requirePartitionFilter?:
3262
3319
  boolean;
3320
+ /**
3321
+ * [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on
3322
+ * [tags](https://cloud.google.com/iam/docs/tags-access-control#definitions). An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key,
3323
+ * e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production".
3324
+ */
3325
+ resourceTags?:
3326
+ { [P in string]: string };
3263
3327
  /** [Optional] Describes the schema of this table. */
3264
3328
  schema?:
3265
3329
  TableSchema;
@@ -3994,6 +4058,9 @@ declare namespace gapi.client {
3994
4058
  /** Dataset ID of the requested dataset */
3995
4059
  datasetId:
3996
4060
  string;
4061
+ /** Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned. Allowed values: METADATA, ACL, FULL. */
4062
+ datasetView?:
4063
+ string;
3997
4064
  /** Selector specifying which fields to include in a partial response. */
3998
4065
  fields?:
3999
4066
  string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.bigquery-v2",
3
- "version": "0.0.20230812",
3
+ "version": "0.0.20231008",
4
4
  "description": "TypeScript typings for BigQuery API v2",
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: 20230812
6
+ // Revision: 20231008
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -53,6 +53,7 @@ gapi.load('client', async () => {
53
53
  /** Returns the dataset specified by datasetID. */
54
54
  await gapi.client.bigquery.datasets.get({
55
55
  datasetId: "Test string",
56
+ datasetView: "Test string",
56
57
  projectId: "Test string",
57
58
  });
58
59
  /** Creates a new empty dataset. */
@@ -596,7 +597,7 @@ gapi.load('client', async () => {
596
597
  allowQuotedNewlines: true,
597
598
  encoding: "Test string",
598
599
  fieldDelimiter: "Test string",
599
- null_marker: "Test string",
600
+ nullMarker: "Test string",
600
601
  preserveAsciiControlCharacters: true,
601
602
  quote: "Test string",
602
603
  skipLeadingRows: "Test string",
@@ -684,6 +685,7 @@ gapi.load('client', async () => {
684
685
  },
685
686
  etag: "Test string",
686
687
  id: "Test string",
688
+ jobCreationReason: 42,
687
689
  jobReference: {
688
690
  jobId: "Test string",
689
691
  location: "Test string",
@@ -895,8 +897,8 @@ gapi.load('client', async () => {
895
897
  A: "Test string"
896
898
  },
897
899
  loggingInfo: {
898
- project_id: "Test string",
899
- resource_type: "Test string",
900
+ projectId: "Test string",
901
+ resourceType: "Test string",
900
902
  },
901
903
  sparkJobId: "Test string",
902
904
  sparkJobLocation: "Test string",
@@ -1027,6 +1029,7 @@ gapi.load('client', async () => {
1027
1029
  projectId: "Test string",
1028
1030
  },
1029
1031
  dryRun: true,
1032
+ jobCreationMode: "Test string",
1030
1033
  kind: "Test string",
1031
1034
  labels: {
1032
1035
  A: "Test string"
@@ -2135,6 +2138,7 @@ gapi.load('client', async () => {
2135
2138
  },
2136
2139
  typeKind: "Test string",
2137
2140
  },
2141
+ isAggregate: true,
2138
2142
  mode: "Test string",
2139
2143
  name: "Test string",
2140
2144
  }
@@ -2192,6 +2196,7 @@ gapi.load('client', async () => {
2192
2196
  routineId: "Test string",
2193
2197
  },
2194
2198
  routineType: "Test string",
2199
+ securityMode: "Test string",
2195
2200
  sparkOptions: {
2196
2201
  archiveUris: [
2197
2202
  "Test string"
@@ -2247,6 +2252,7 @@ gapi.load('client', async () => {
2247
2252
  },
2248
2253
  typeKind: "Test string",
2249
2254
  },
2255
+ isAggregate: true,
2250
2256
  mode: "Test string",
2251
2257
  name: "Test string",
2252
2258
  }
@@ -2304,6 +2310,7 @@ gapi.load('client', async () => {
2304
2310
  routineId: "Test string",
2305
2311
  },
2306
2312
  routineType: "Test string",
2313
+ securityMode: "Test string",
2307
2314
  sparkOptions: {
2308
2315
  archiveUris: [
2309
2316
  "Test string"
@@ -2473,7 +2480,7 @@ gapi.load('client', async () => {
2473
2480
  allowQuotedNewlines: true,
2474
2481
  encoding: "Test string",
2475
2482
  fieldDelimiter: "Test string",
2476
- null_marker: "Test string",
2483
+ nullMarker: "Test string",
2477
2484
  preserveAsciiControlCharacters: true,
2478
2485
  quote: "Test string",
2479
2486
  skipLeadingRows: "Test string",
@@ -2614,6 +2621,9 @@ gapi.load('client', async () => {
2614
2621
  },
2615
2622
  },
2616
2623
  requirePartitionFilter: true,
2624
+ resourceTags: {
2625
+ A: "Test string"
2626
+ },
2617
2627
  schema: {
2618
2628
  fields: [
2619
2629
  {
@@ -2784,7 +2794,7 @@ gapi.load('client', async () => {
2784
2794
  allowQuotedNewlines: true,
2785
2795
  encoding: "Test string",
2786
2796
  fieldDelimiter: "Test string",
2787
- null_marker: "Test string",
2797
+ nullMarker: "Test string",
2788
2798
  preserveAsciiControlCharacters: true,
2789
2799
  quote: "Test string",
2790
2800
  skipLeadingRows: "Test string",
@@ -2925,6 +2935,9 @@ gapi.load('client', async () => {
2925
2935
  },
2926
2936
  },
2927
2937
  requirePartitionFilter: true,
2938
+ resourceTags: {
2939
+ A: "Test string"
2940
+ },
2928
2941
  schema: {
2929
2942
  fields: [
2930
2943
  {
@@ -3136,7 +3149,7 @@ gapi.load('client', async () => {
3136
3149
  allowQuotedNewlines: true,
3137
3150
  encoding: "Test string",
3138
3151
  fieldDelimiter: "Test string",
3139
- null_marker: "Test string",
3152
+ nullMarker: "Test string",
3140
3153
  preserveAsciiControlCharacters: true,
3141
3154
  quote: "Test string",
3142
3155
  skipLeadingRows: "Test string",
@@ -3277,6 +3290,9 @@ gapi.load('client', async () => {
3277
3290
  },
3278
3291
  },
3279
3292
  requirePartitionFilter: true,
3293
+ resourceTags: {
3294
+ A: "Test string"
3295
+ },
3280
3296
  schema: {
3281
3297
  fields: [
3282
3298
  {