@maxim_mazurok/gapi.client.bigquery-v2 0.0.20220903 → 0.0.20220913

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 +55 -41
  2. package/package.json +1 -1
  3. package/tests.ts +5 -1
package/index.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
11
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
12
  // Generated from: https://bigquery.googleapis.com/$discovery/rest?version=v2
13
- // Revision: 20220903
13
+ // Revision: 20220913
14
14
 
15
15
  /// <reference types="gapi.client" />
16
16
 
@@ -471,6 +471,13 @@ declare namespace gapi.client {
471
471
  */
472
472
  skipLeadingRows?: string;
473
473
  }
474
+ interface DataMaskingStatistics {
475
+ /**
476
+ * [Output-only] [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the
477
+ * discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
478
+ */
479
+ dataMaskingApplied?: boolean;
480
+ }
474
481
  interface Dataset {
475
482
  /**
476
483
  * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed
@@ -1176,6 +1183,11 @@ declare namespace gapi.client {
1176
1183
  * actions occur as one atomic update upon job completion.
1177
1184
  */
1178
1185
  createDisposition?: string;
1186
+ /**
1187
+ * If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs
1188
+ * the load job in non-session mode.
1189
+ */
1190
+ createSession?: boolean;
1179
1191
  /**
1180
1192
  * [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field
1181
1193
  * determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING
@@ -1458,6 +1470,8 @@ declare namespace gapi.client {
1458
1470
  copy?: JobStatistics5;
1459
1471
  /** [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. */
1460
1472
  creationTime?: string;
1473
+ /** [Output-only] Statistics for data masking. Present only for query and extract jobs. */
1474
+ dataMaskingStatistics?: DataMaskingStatistics;
1461
1475
  /** [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. */
1462
1476
  endTime?: string;
1463
1477
  /** [Output-only] Statistics for an extract job. */
@@ -1500,15 +1514,15 @@ declare namespace gapi.client {
1500
1514
  transactionInfo?: TransactionInfo;
1501
1515
  }
1502
1516
  interface JobStatistics2 {
1503
- /** BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. */
1517
+ /** BI Engine specific Statistics. [Output only] BI Engine specific Statistics. */
1504
1518
  biEngineStatistics?: BiEngineStatistics;
1505
- /** [Output-only] Billing tier for the job. */
1519
+ /** [Output only] Billing tier for the job. */
1506
1520
  billingTier?: number;
1507
- /** [Output-only] Whether the query result was fetched from the query cache. */
1521
+ /** [Output only] Whether the query result was fetched from the query cache. */
1508
1522
  cacheHit?: boolean;
1509
- /** [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. */
1523
+ /** [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. */
1510
1524
  ddlAffectedRowAccessPolicyCount?: string;
1511
- /** [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. */
1525
+ /** [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. */
1512
1526
  ddlDestinationTable?: TableReference;
1513
1527
  /**
1514
1528
  * The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the
@@ -1516,46 +1530,46 @@ declare namespace gapi.client {
1516
1530
  * exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
1517
1531
  */
1518
1532
  ddlOperationPerformed?: string;
1519
- /** [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. */
1533
+ /** [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. */
1520
1534
  ddlTargetDataset?: DatasetReference;
1521
1535
  /** The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. */
1522
1536
  ddlTargetRoutine?: RoutineReference;
1523
- /** [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. */
1537
+ /** [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. */
1524
1538
  ddlTargetRowAccessPolicy?: RowAccessPolicyReference;
1525
- /** [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. */
1539
+ /** [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. */
1526
1540
  ddlTargetTable?: TableReference;
1527
- /** [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. */
1541
+ /** [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. */
1528
1542
  dmlStats?: DmlStatistics;
1529
- /** [Output-only] The original estimate of bytes processed for the job. */
1543
+ /** [Output only] The original estimate of bytes processed for the job. */
1530
1544
  estimatedBytesProcessed?: string;
1531
- /** [Output-only] Statistics of a BigQuery ML training job. */
1545
+ /** [Output only] Statistics of a BigQuery ML training job. */
1532
1546
  mlStatistics?: MlStatistics;
1533
- /** [Output-only, Beta] Information about create model query job progress. */
1547
+ /** [Output only, Beta] Information about create model query job progress. */
1534
1548
  modelTraining?: BigQueryModelTraining;
1535
- /** [Output-only, Beta] Deprecated; do not use. */
1549
+ /** [Output only, Beta] Deprecated; do not use. */
1536
1550
  modelTrainingCurrentIteration?: number;
1537
- /** [Output-only, Beta] Deprecated; do not use. */
1551
+ /** [Output only, Beta] Deprecated; do not use. */
1538
1552
  modelTrainingExpectedTotalIteration?: string;
1539
- /** [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1553
+ /** [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
1540
1554
  numDmlAffectedRows?: string;
1541
- /** [Output-only] Describes execution plan for the query. */
1555
+ /** [Output only] Describes execution plan for the query. */
1542
1556
  queryPlan?: ExplainQueryStage[];
1543
- /** [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. */
1557
+ /** [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job. */
1544
1558
  referencedRoutines?: RoutineReference[];
1545
- /** [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. */
1559
+ /** [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. */
1546
1560
  referencedTables?: TableReference[];
1547
- /** [Output-only] Job resource usage breakdown by reservation. */
1561
+ /** [Output only] Job resource usage breakdown by reservation. */
1548
1562
  reservationUsage?: Array<{
1549
- /** [Output-only] Reservation name or "unreserved" for on-demand resources usage. */
1563
+ /** [Output only] Reservation name or "unreserved" for on-demand resources usage. */
1550
1564
  name?: string;
1551
- /** [Output-only] Slot-milliseconds the job spent in the given reservation. */
1565
+ /** [Output only] Slot-milliseconds the job spent in the given reservation. */
1552
1566
  slotMs?: string;
1553
1567
  }>;
1554
- /** [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */
1568
+ /** [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */
1555
1569
  schema?: TableSchema;
1556
- /** [Output-only] Search query specific statistics. */
1570
+ /** [Output only] Search query specific statistics. */
1557
1571
  searchStatistics?: SearchStatistics;
1558
- /** [Output-only] Statistics of a Spark procedure job. */
1572
+ /** [Output only] Statistics of a Spark procedure job. */
1559
1573
  sparkStatistics?: SparkStatistics;
1560
1574
  /**
1561
1575
  * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see
@@ -1568,20 +1582,20 @@ declare namespace gapi.client {
1568
1582
  * SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
1569
1583
  */
1570
1584
  statementType?: string;
1571
- /** [Output-only] [Beta] Describes a timeline of job execution. */
1585
+ /** [Output only] [Beta] Describes a timeline of job execution. */
1572
1586
  timeline?: QueryTimelineSample[];
1573
- /** [Output-only] Total bytes billed for the job. */
1587
+ /** [Output only] Total bytes billed for the job. */
1574
1588
  totalBytesBilled?: string;
1575
- /** [Output-only] Total bytes processed for the job. */
1589
+ /** [Output only] Total bytes processed for the job. */
1576
1590
  totalBytesProcessed?: string;
1577
1591
  /**
1578
- * [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate
1592
+ * [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate
1579
1593
  * is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
1580
1594
  */
1581
1595
  totalBytesProcessedAccuracy?: string;
1582
- /** [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. */
1596
+ /** [Output only] Total number of partitions processed from all partitioned tables referenced in the job. */
1583
1597
  totalPartitionsProcessed?: string;
1584
- /** [Output-only] Slot-milliseconds for the job. */
1598
+ /** [Output only] Slot-milliseconds for the job. */
1585
1599
  totalSlotMs?: string;
1586
1600
  /** Standard SQL only: list of undeclared query parameters detected during a dry run validation. */
1587
1601
  undeclaredQueryParameters?: QueryParameter[];
@@ -1731,7 +1745,7 @@ declare namespace gapi.client {
1731
1745
  * trial_id.
1732
1746
  */
1733
1747
  optimalTrialIds?: string[];
1734
- /** Output only. Information for all training runs in increasing order of start_time. */
1748
+ /** Information for all training runs in increasing order of start_time. */
1735
1749
  trainingRuns?: TrainingRun[];
1736
1750
  }
1737
1751
  interface ModelDefinition {
@@ -2725,25 +2739,25 @@ declare namespace gapi.client {
2725
2739
  warmStart?: boolean;
2726
2740
  }
2727
2741
  interface TrainingRun {
2728
- /** Global explanation contains the explanation of top features on the class level. Applies to classification models only. */
2742
+ /** Output only. Global explanation contains the explanation of top features on the class level. Applies to classification models only. */
2729
2743
  classLevelGlobalExplanations?: GlobalExplanation[];
2730
- /** Data split result of the training run. Only set when the input data is actually split. */
2744
+ /** Output only. Data split result of the training run. Only set when the input data is actually split. */
2731
2745
  dataSplitResult?: DataSplitResult;
2732
- /** The evaluation metrics over training/eval data that were computed at the end of training. */
2746
+ /** Output only. The evaluation metrics over training/eval data that were computed at the end of training. */
2733
2747
  evaluationMetrics?: EvaluationMetrics;
2734
- /** Global explanation contains the explanation of top features on the model level. Applies to both regression and classification models. */
2748
+ /** Output only. Global explanation contains the explanation of top features on the model level. Applies to both regression and classification models. */
2735
2749
  modelLevelGlobalExplanation?: GlobalExplanation;
2736
- /** Output of each iteration run, results.size() <= max_iterations. */
2750
+ /** Output only. Output of each iteration run, results.size() <= max_iterations. */
2737
2751
  results?: IterationResult[];
2738
- /** The start time of this training run. */
2752
+ /** Output only. The start time of this training run. */
2739
2753
  startTime?: string;
2740
- /** Options that were used for this training run, includes user specified and default options that were used. */
2754
+ /** Output only. Options that were used for this training run, includes user specified and default options that were used. */
2741
2755
  trainingOptions?: TrainingOptions;
2742
- /** The start time of this training run, in milliseconds since epoch. */
2756
+ /** Output only. The start time of this training run, in milliseconds since epoch. */
2743
2757
  trainingStartTime?: string;
2744
2758
  /** The model id in Vertex AI Model Registry for this training run */
2745
2759
  vertexAiModelId?: string;
2746
- /** The model version in Vertex AI Model Registry for this training run */
2760
+ /** Output only. The model version in Vertex AI Model Registry for this training run */
2747
2761
  vertexAiModelVersion?: string;
2748
2762
  }
2749
2763
  interface TransactionInfo {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.bigquery-v2",
3
- "version": "0.0.20220903",
3
+ "version": "0.0.20220913",
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: 20220903
6
+ // Revision: 20220913
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -374,6 +374,7 @@ gapi.load('client', async () => {
374
374
  }
375
375
  ],
376
376
  createDisposition: "Test string",
377
+ createSession: true,
377
378
  decimalTargetTypes: [
378
379
  "Test string"
379
380
  ],
@@ -657,6 +658,9 @@ gapi.load('client', async () => {
657
658
  copied_rows: "Test string",
658
659
  },
659
660
  creationTime: "Test string",
661
+ dataMaskingStatistics: {
662
+ dataMaskingApplied: true,
663
+ },
660
664
  endTime: "Test string",
661
665
  extract: {
662
666
  destinationUriFileCounts: [