@maxim_mazurok/gapi.client.bigquery-v2 0.0.20241208 → 0.0.20250112
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 +25 -13
- 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: 20250112
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -329,7 +329,7 @@ declare namespace gapi.client {
|
|
|
329
329
|
clusterSize?: string;
|
|
330
330
|
}
|
|
331
331
|
interface Clustering {
|
|
332
|
-
/** One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes.
|
|
332
|
+
/** One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations). */
|
|
333
333
|
fields?: string[];
|
|
334
334
|
}
|
|
335
335
|
interface ClusteringMetrics {
|
|
@@ -702,13 +702,13 @@ declare namespace gapi.client {
|
|
|
702
702
|
interface ExternalCatalogDatasetOptions {
|
|
703
703
|
/** Optional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters. */
|
|
704
704
|
defaultStorageLocationUri?: string;
|
|
705
|
-
/** Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of
|
|
705
|
+
/** Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2MiB. */
|
|
706
706
|
parameters?: {[P in string]: string};
|
|
707
707
|
}
|
|
708
708
|
interface ExternalCatalogTableOptions {
|
|
709
|
-
/** Optional.
|
|
709
|
+
/** Optional. A connection ID that specifies the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or Amazon S3. This connection is needed to read the open source table from BigQuery. The connection_id format must be either `..` or `projects//locations//connections/`. */
|
|
710
710
|
connectionId?: string;
|
|
711
|
-
/** Optional. A map of key
|
|
711
|
+
/** Optional. A map of the key-value pairs defining the parameters and properties of the open source table. Corresponds with Hive metastore table parameters. Maximum size of 4MiB. */
|
|
712
712
|
parameters?: {[P in string]: string};
|
|
713
713
|
/** Optional. A storage descriptor containing information about the physical storage of this table. */
|
|
714
714
|
storageDescriptor?: StorageDescriptor;
|
|
@@ -1379,7 +1379,7 @@ declare namespace gapi.client {
|
|
|
1379
1379
|
searchStatistics?: SearchStatistics;
|
|
1380
1380
|
/** Output only. Statistics of a Spark procedure job. */
|
|
1381
1381
|
sparkStatistics?: SparkStatistics;
|
|
1382
|
-
/** Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/
|
|
1382
|
+
/** Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. */
|
|
1383
1383
|
statementType?: string;
|
|
1384
1384
|
/** Output only. Describes a timeline of job execution. */
|
|
1385
1385
|
timeline?: QueryTimelineSample[];
|
|
@@ -1505,7 +1505,7 @@ declare namespace gapi.client {
|
|
|
1505
1505
|
tableReference?: TableReference;
|
|
1506
1506
|
}
|
|
1507
1507
|
interface MaterializedViewDefinition {
|
|
1508
|
-
/** Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. */
|
|
1508
|
+
/** Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. Non-incremental materialized views support an expanded range of SQL queries. The `allow_non_incremental_definition` option can't be changed after the materialized view is created. */
|
|
1509
1509
|
allowNonIncrementalDefinition?: boolean;
|
|
1510
1510
|
/** Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is "true". */
|
|
1511
1511
|
enableRefresh?: boolean;
|
|
@@ -1757,7 +1757,7 @@ declare namespace gapi.client {
|
|
|
1757
1757
|
kind?: string;
|
|
1758
1758
|
/** Optional. The labels associated with this query. Labels can be used to organize and group query jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key. */
|
|
1759
1759
|
labels?: {[P in string]: string};
|
|
1760
|
-
/** The geographic location where the job should run.
|
|
1760
|
+
/** The geographic location where the job should run. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). */
|
|
1761
1761
|
location?: string;
|
|
1762
1762
|
/** Optional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used. */
|
|
1763
1763
|
maximumBytesBilled?: string;
|
|
@@ -1783,8 +1783,12 @@ declare namespace gapi.client {
|
|
|
1783
1783
|
interface QueryResponse {
|
|
1784
1784
|
/** Whether the query result was fetched from the query cache. */
|
|
1785
1785
|
cacheHit?: boolean;
|
|
1786
|
+
/** Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries. */
|
|
1787
|
+
creationTime?: string;
|
|
1786
1788
|
/** Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. */
|
|
1787
1789
|
dmlStats?: DmlStatistics;
|
|
1790
|
+
/** Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state. */
|
|
1791
|
+
endTime?: string;
|
|
1788
1792
|
/** Output only. The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages). */
|
|
1789
1793
|
errors?: ErrorProto[];
|
|
1790
1794
|
/** 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. */
|
|
@@ -1795,6 +1799,8 @@ declare namespace gapi.client {
|
|
|
1795
1799
|
jobReference?: JobReference;
|
|
1796
1800
|
/** The resource type. */
|
|
1797
1801
|
kind?: string;
|
|
1802
|
+
/** Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations */
|
|
1803
|
+
location?: string;
|
|
1798
1804
|
/** Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. */
|
|
1799
1805
|
numDmlAffectedRows?: string;
|
|
1800
1806
|
/** A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results). */
|
|
@@ -1807,10 +1813,16 @@ declare namespace gapi.client {
|
|
|
1807
1813
|
schema?: TableSchema;
|
|
1808
1814
|
/** Output only. Information of the session if this job is part of one. */
|
|
1809
1815
|
sessionInfo?: SessionInfo;
|
|
1816
|
+
/** Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE. */
|
|
1817
|
+
startTime?: string;
|
|
1818
|
+
/** Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only. */
|
|
1819
|
+
totalBytesBilled?: string;
|
|
1810
1820
|
/** The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. */
|
|
1811
1821
|
totalBytesProcessed?: string;
|
|
1812
1822
|
/** The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. */
|
|
1813
1823
|
totalRows?: string;
|
|
1824
|
+
/** Output only. Number of slot ms the user is actually billed for. */
|
|
1825
|
+
totalSlotMs?: string;
|
|
1814
1826
|
}
|
|
1815
1827
|
interface QueryTimelineSample {
|
|
1816
1828
|
/** Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. */
|
|
@@ -2511,7 +2523,7 @@ declare namespace gapi.client {
|
|
|
2511
2523
|
dartNormalizeType?: string;
|
|
2512
2524
|
/** The data frequency of a time series. */
|
|
2513
2525
|
dataFrequency?: string;
|
|
2514
|
-
/** The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#
|
|
2526
|
+
/** The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data_type_properties */
|
|
2515
2527
|
dataSplitColumn?: string;
|
|
2516
2528
|
/** The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2. */
|
|
2517
2529
|
dataSplitEvalFraction?: number;
|
|
@@ -3090,7 +3102,7 @@ declare namespace gapi.client {
|
|
|
3090
3102
|
jobId: string;
|
|
3091
3103
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3092
3104
|
key?: string;
|
|
3093
|
-
/** The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`)
|
|
3105
|
+
/** The geographic location of the job. You must [specify the location](https://cloud.google.com/bigquery/docs/locations#specify_locations) to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) */
|
|
3094
3106
|
location?: string;
|
|
3095
3107
|
/** OAuth 2.0 token for the current user. */
|
|
3096
3108
|
oauth_token?: string;
|
|
@@ -3121,7 +3133,7 @@ declare namespace gapi.client {
|
|
|
3121
3133
|
jobId: string;
|
|
3122
3134
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3123
3135
|
key?: string;
|
|
3124
|
-
/** The geographic location of the job. Required.
|
|
3136
|
+
/** The geographic location of the job. Required. For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). */
|
|
3125
3137
|
location?: string;
|
|
3126
3138
|
/** OAuth 2.0 token for the current user. */
|
|
3127
3139
|
oauth_token?: string;
|
|
@@ -3152,7 +3164,7 @@ declare namespace gapi.client {
|
|
|
3152
3164
|
jobId: string;
|
|
3153
3165
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3154
3166
|
key?: string;
|
|
3155
|
-
/** The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#
|
|
3167
|
+
/** The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). */
|
|
3156
3168
|
location?: string;
|
|
3157
3169
|
/** OAuth 2.0 token for the current user. */
|
|
3158
3170
|
oauth_token?: string;
|
|
@@ -3185,7 +3197,7 @@ declare namespace gapi.client {
|
|
|
3185
3197
|
jobId: string;
|
|
3186
3198
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3187
3199
|
key?: string;
|
|
3188
|
-
/** The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#
|
|
3200
|
+
/** The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see how to [specify locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). */
|
|
3189
3201
|
location?: string;
|
|
3190
3202
|
/** Maximum number of results to read. */
|
|
3191
3203
|
maxResults?: number;
|