@maxim_mazurok/gapi.client.bigquery-v2 0.1.20260211 → 0.1.20260314
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/index.d.ts +91 -5
- package/package.json +1 -1
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:
|
|
12
|
+
// Revision: 20260314
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -428,6 +428,8 @@ declare namespace gapi.client {
|
|
|
428
428
|
/** [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. */
|
|
429
429
|
view?: TableReference;
|
|
430
430
|
}>;
|
|
431
|
+
/** Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake */
|
|
432
|
+
catalogSource?: string;
|
|
431
433
|
/** Output only. The time when this dataset was created, in milliseconds since the epoch. */
|
|
432
434
|
creationTime?: string;
|
|
433
435
|
/** Required. A reference that identifies the dataset. */
|
|
@@ -489,7 +491,7 @@ declare namespace gapi.client {
|
|
|
489
491
|
/** Required. The friendly short name of the tag value, e.g. "production". */
|
|
490
492
|
tagValue?: string;
|
|
491
493
|
}>;
|
|
492
|
-
/** Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. */
|
|
494
|
+
/** Output only. Same as `type` in `ListFormatDataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. */
|
|
493
495
|
type?: string;
|
|
494
496
|
}
|
|
495
497
|
interface DatasetAccessEntry {
|
|
@@ -501,6 +503,8 @@ declare namespace gapi.client {
|
|
|
501
503
|
interface DatasetList {
|
|
502
504
|
/** An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */
|
|
503
505
|
datasets?: Array<{
|
|
506
|
+
/** Output only. The origin of the dataset, one of: * (Unset) - Native BigQuery Dataset. * BIGLAKE - Dataset is backed by a namespace stored natively in Biglake. */
|
|
507
|
+
catalogSource?: string;
|
|
504
508
|
/** The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID. */
|
|
505
509
|
datasetReference?: DatasetReference;
|
|
506
510
|
/** Output only. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL. */
|
|
@@ -515,6 +519,8 @@ declare namespace gapi.client {
|
|
|
515
519
|
labels?: {[P in string]: string};
|
|
516
520
|
/** The geographic location where the dataset resides. */
|
|
517
521
|
location?: string;
|
|
522
|
+
/** Output only. Same as `type` in `Dataset`. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog, * BIGLAKE_ICEBERG - a Biglake dataset accessible through the Iceberg API, * BIGLAKE_HIVE - a Biglake dataset accessible through the Hive API. */
|
|
523
|
+
type?: string;
|
|
518
524
|
}>;
|
|
519
525
|
/** Output only. A hash value of the results page. You can use this property to determine if the page has changed since the last request. */
|
|
520
526
|
etag?: string;
|
|
@@ -574,6 +580,10 @@ declare namespace gapi.client {
|
|
|
574
580
|
interface DmlStatistics {
|
|
575
581
|
/** Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. */
|
|
576
582
|
deletedRowCount?: string;
|
|
583
|
+
/** Output only. DML mode used. */
|
|
584
|
+
dmlMode?: string;
|
|
585
|
+
/** Output only. Reason for disabling fine-grained DML if applicable. */
|
|
586
|
+
fineGrainedDmlUnusedReason?: string;
|
|
577
587
|
/** Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements */
|
|
578
588
|
insertedRowCount?: string;
|
|
579
589
|
/** Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. */
|
|
@@ -788,7 +798,7 @@ declare namespace gapi.client {
|
|
|
788
798
|
timeFormat?: string;
|
|
789
799
|
/** Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values. */
|
|
790
800
|
timestampFormat?: string;
|
|
791
|
-
/** Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV
|
|
801
|
+
/** Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. */
|
|
792
802
|
timestampTargetPrecision?: number[];
|
|
793
803
|
/** Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles). */
|
|
794
804
|
timeZone?: string;
|
|
@@ -843,6 +853,54 @@ declare namespace gapi.client {
|
|
|
843
853
|
/** Required. The query that defines the view. */
|
|
844
854
|
query?: string;
|
|
845
855
|
}
|
|
856
|
+
interface GenAiErrorStats {
|
|
857
|
+
/** A list of unique errors at query level (up to 5, truncated to 100 chars) */
|
|
858
|
+
errors?: string[];
|
|
859
|
+
}
|
|
860
|
+
interface GenAiFunctionCostOptimizationStats {
|
|
861
|
+
/** System generated message to provide insights into cost optimization state. */
|
|
862
|
+
message?: string;
|
|
863
|
+
/** Number of rows inferred via cost optimized workflow. */
|
|
864
|
+
numCostOptimizedRows?: string;
|
|
865
|
+
}
|
|
866
|
+
interface GenAiFunctionErrorStats {
|
|
867
|
+
/** A list of unique errors at function level (up to 5, truncated to 100 chars). */
|
|
868
|
+
errors?: string[];
|
|
869
|
+
/** Number of failed rows processed by the function */
|
|
870
|
+
numFailedRows?: string;
|
|
871
|
+
}
|
|
872
|
+
interface GenAiFunctionStats {
|
|
873
|
+
/** Cost optimization stats if applied on the rows processed by the function. */
|
|
874
|
+
costOptimizationStats?: GenAiFunctionCostOptimizationStats;
|
|
875
|
+
/** Error stats for the function. */
|
|
876
|
+
errorStats?: GenAiFunctionErrorStats;
|
|
877
|
+
/** Name of the function. */
|
|
878
|
+
functionName?: string;
|
|
879
|
+
/** Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. */
|
|
880
|
+
numProcessedRows?: string;
|
|
881
|
+
/** User input prompt of the function (truncated to 20 chars). */
|
|
882
|
+
prompt?: string;
|
|
883
|
+
}
|
|
884
|
+
interface GenAiStats {
|
|
885
|
+
/** Job level error stats across all GenAi functions */
|
|
886
|
+
errorStats?: GenAiErrorStats;
|
|
887
|
+
/** Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview */
|
|
888
|
+
functionStats?: GenAiFunctionStats[];
|
|
889
|
+
}
|
|
890
|
+
interface GeneratedColumn {
|
|
891
|
+
/** Definition of the expression used to generate the field. */
|
|
892
|
+
generatedExpressionInfo?: GeneratedExpressionInfo;
|
|
893
|
+
/** Optional. Dictates when system generated values are used to populate the field. */
|
|
894
|
+
generatedMode?: string;
|
|
895
|
+
}
|
|
896
|
+
interface GeneratedExpressionInfo {
|
|
897
|
+
/** Optional. Whether the column generation is done asynchronously. */
|
|
898
|
+
asynchronous?: boolean;
|
|
899
|
+
/** Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. */
|
|
900
|
+
generationExpression?: string;
|
|
901
|
+
/** Optional. Whether the generated column is stored in the table. */
|
|
902
|
+
stored?: boolean;
|
|
903
|
+
}
|
|
846
904
|
interface GetIamPolicyRequest {
|
|
847
905
|
/** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
|
|
848
906
|
options?: GetPolicyOptions;
|
|
@@ -1222,7 +1280,7 @@ declare namespace gapi.client {
|
|
|
1222
1280
|
timePartitioning?: TimePartitioning;
|
|
1223
1281
|
/** Optional. Date format used for parsing TIMESTAMP values. */
|
|
1224
1282
|
timestampFormat?: string;
|
|
1225
|
-
/** Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV
|
|
1283
|
+
/** Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, and AVRO. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. */
|
|
1226
1284
|
timestampTargetPrecision?: number[];
|
|
1227
1285
|
/** Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. */
|
|
1228
1286
|
timeZone?: string;
|
|
@@ -1440,6 +1498,8 @@ declare namespace gapi.client {
|
|
|
1440
1498
|
exportDataStatistics?: ExportDataStatistics;
|
|
1441
1499
|
/** Output only. Job cost breakdown as bigquery internal cost and external service costs. */
|
|
1442
1500
|
externalServiceCosts?: ExternalServiceCost[];
|
|
1501
|
+
/** Output only. Statistics related to GenAI usage in the query. */
|
|
1502
|
+
genAiStats?: GenAiStats;
|
|
1443
1503
|
/** Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. */
|
|
1444
1504
|
incrementalResultStats?: IncrementalResultStats;
|
|
1445
1505
|
/** Output only. Statistics for a LOAD query. */
|
|
@@ -1464,6 +1524,8 @@ declare namespace gapi.client {
|
|
|
1464
1524
|
queryInfo?: QueryInfo;
|
|
1465
1525
|
/** Output only. Describes execution plan for the query. */
|
|
1466
1526
|
queryPlan?: ExplainQueryStage[];
|
|
1527
|
+
/** Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. */
|
|
1528
|
+
referencedPropertyGraphs?: PropertyGraphReference[];
|
|
1467
1529
|
/** Output only. Referenced routines for the job. */
|
|
1468
1530
|
referencedRoutines?: RoutineReference[];
|
|
1469
1531
|
/** Output only. Referenced tables for the job. */
|
|
@@ -1783,7 +1845,7 @@ declare namespace gapi.client {
|
|
|
1783
1845
|
kind?: string;
|
|
1784
1846
|
/** Use this token to request the next page of results. */
|
|
1785
1847
|
nextPageToken?: string;
|
|
1786
|
-
/** Projects to which the user has at least READ access. */
|
|
1848
|
+
/** Projects to which the user has at least READ access. This field can be omitted if `totalItems` is 0. */
|
|
1787
1849
|
projects?: Array<{
|
|
1788
1850
|
/** A descriptive name for this project. A wrapper is used here because friendlyName can be set to the empty string. */
|
|
1789
1851
|
friendlyName?: string;
|
|
@@ -1803,6 +1865,14 @@ declare namespace gapi.client {
|
|
|
1803
1865
|
/** Required. ID of the project. Can be either the numeric ID or the assigned ID of the project. */
|
|
1804
1866
|
projectId?: string;
|
|
1805
1867
|
}
|
|
1868
|
+
interface PropertyGraphReference {
|
|
1869
|
+
/** Required. The ID of the dataset containing this property graph. */
|
|
1870
|
+
datasetId?: string;
|
|
1871
|
+
/** Required. The ID of the project containing this property graph. */
|
|
1872
|
+
projectId?: string;
|
|
1873
|
+
/** Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. */
|
|
1874
|
+
propertyGraphId?: string;
|
|
1875
|
+
}
|
|
1806
1876
|
interface PruningStats {
|
|
1807
1877
|
/** The number of parallel inputs matched. */
|
|
1808
1878
|
postCmetaPruningParallelInputCount?: string;
|
|
@@ -2042,6 +2112,8 @@ declare namespace gapi.client {
|
|
|
2042
2112
|
interface Routine {
|
|
2043
2113
|
/** Optional. */
|
|
2044
2114
|
arguments?: Argument[];
|
|
2115
|
+
/** Output only. The build status of the routine. This field is only applicable to Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) */
|
|
2116
|
+
buildStatus?: RoutineBuildStatus;
|
|
2045
2117
|
/** Output only. The time when this routine was created, in milliseconds since the epoch. */
|
|
2046
2118
|
creationTime?: string;
|
|
2047
2119
|
/** Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). */
|
|
@@ -2081,6 +2153,18 @@ declare namespace gapi.client {
|
|
|
2081
2153
|
/** Optional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn't guarantee that the procedure will successfully execute at runtime. If `strictMode` is set to `TRUE`, the procedure body is further checked for errors such as non-existent tables or columns. The `CREATE PROCEDURE` statement fails if the body fails any of these checks. If `strictMode` is set to `FALSE`, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify `strictMode=FALSE` to avoid non-existent procedure errors during validation. Default value is `TRUE`. */
|
|
2082
2154
|
strictMode?: boolean;
|
|
2083
2155
|
}
|
|
2156
|
+
interface RoutineBuildStatus {
|
|
2157
|
+
/** Output only. The time taken for the image build. Populated only after the build succeeds or fails. */
|
|
2158
|
+
buildDuration?: string;
|
|
2159
|
+
/** Output only. The current build state of the routine. */
|
|
2160
|
+
buildState?: string;
|
|
2161
|
+
/** Output only. The time when the build state was updated last. */
|
|
2162
|
+
buildStateUpdateTime?: string;
|
|
2163
|
+
/** Output only. A result object that will be present only if the build has failed. */
|
|
2164
|
+
errorResult?: ErrorProto;
|
|
2165
|
+
/** Output only. The size of the image in bytes. Populated only after the build succeeds. */
|
|
2166
|
+
imageSizeBytes?: string;
|
|
2167
|
+
}
|
|
2084
2168
|
interface RoutineReference {
|
|
2085
2169
|
/** Required. The ID of the dataset containing this routine. */
|
|
2086
2170
|
datasetId?: string;
|
|
@@ -2509,6 +2593,8 @@ declare namespace gapi.client {
|
|
|
2509
2593
|
fields?: TableFieldSchema[];
|
|
2510
2594
|
/** Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. */
|
|
2511
2595
|
foreignTypeDefinition?: string;
|
|
2596
|
+
/** Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). */
|
|
2597
|
+
generatedColumn?: GeneratedColumn;
|
|
2512
2598
|
/** Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". */
|
|
2513
2599
|
maxLength?: string;
|
|
2514
2600
|
/** Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */
|