@maxim_mazurok/gapi.client.bigquery-v2 0.1.20260620 → 0.2.20260620
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 +20 -70
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -205,10 +205,7 @@ declare namespace gapi.client {
|
|
|
205
205
|
exemptedMembers?: string[];
|
|
206
206
|
/** The log type that this config enables. */
|
|
207
207
|
logType?:
|
|
208
|
-
| '
|
|
209
|
-
| 'ADMIN_READ'
|
|
210
|
-
| 'DATA_WRITE'
|
|
211
|
-
| 'DATA_READ';
|
|
208
|
+
'LOG_TYPE_UNSPECIFIED' | 'ADMIN_READ' | 'DATA_WRITE' | 'DATA_READ';
|
|
212
209
|
}
|
|
213
210
|
interface AvroOptions {
|
|
214
211
|
/** Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). */
|
|
@@ -243,10 +240,7 @@ declare namespace gapi.client {
|
|
|
243
240
|
| 'FULL_QUERY';
|
|
244
241
|
/** Output only. Specifies which mode of BI Engine acceleration was performed (if any). */
|
|
245
242
|
biEngineMode?:
|
|
246
|
-
| '
|
|
247
|
-
| 'DISABLED'
|
|
248
|
-
| 'PARTIAL'
|
|
249
|
-
| 'FULL';
|
|
243
|
+
'ACCELERATION_MODE_UNSPECIFIED' | 'DISABLED' | 'PARTIAL' | 'FULL';
|
|
250
244
|
/** In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. */
|
|
251
245
|
biEngineReasons?: BiEngineReason[];
|
|
252
246
|
}
|
|
@@ -565,9 +559,7 @@ declare namespace gapi.client {
|
|
|
565
559
|
selfLink?: string;
|
|
566
560
|
/** Optional. Updates storage_billing_model for the dataset. */
|
|
567
561
|
storageBillingModel?:
|
|
568
|
-
| '
|
|
569
|
-
| 'LOGICAL'
|
|
570
|
-
| 'PHYSICAL';
|
|
562
|
+
'STORAGE_BILLING_MODEL_UNSPECIFIED' | 'LOGICAL' | 'PHYSICAL';
|
|
571
563
|
/** Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. */
|
|
572
564
|
tags?: {
|
|
573
565
|
/** Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. */
|
|
@@ -666,9 +658,7 @@ declare namespace gapi.client {
|
|
|
666
658
|
deletedRowCount?: string;
|
|
667
659
|
/** Output only. DML mode used. */
|
|
668
660
|
dmlMode?:
|
|
669
|
-
| '
|
|
670
|
-
| 'COARSE_GRAINED_DML'
|
|
671
|
-
| 'FINE_GRAINED_DML';
|
|
661
|
+
'DML_MODE_UNSPECIFIED' | 'COARSE_GRAINED_DML' | 'FINE_GRAINED_DML';
|
|
672
662
|
/** Output only. Reason for disabling fine-grained DML if applicable. */
|
|
673
663
|
fineGrainedDmlUnusedReason?:
|
|
674
664
|
| 'FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED'
|
|
@@ -879,9 +869,7 @@ declare namespace gapi.client {
|
|
|
879
869
|
maxBadRecords?: number;
|
|
880
870
|
/** Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source. */
|
|
881
871
|
metadataCacheMode?:
|
|
882
|
-
| '
|
|
883
|
-
| 'AUTOMATIC'
|
|
884
|
-
| 'MANUAL';
|
|
872
|
+
'METADATA_CACHE_MODE_UNSPECIFIED' | 'AUTOMATIC' | 'MANUAL';
|
|
885
873
|
/** Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type. */
|
|
886
874
|
objectMetadata?: 'OBJECT_METADATA_UNSPECIFIED' | 'DIRECTORY' | 'SIMPLE';
|
|
887
875
|
/** Optional. Additional properties to set if sourceFormat is set to PARQUET. */
|
|
@@ -1162,9 +1150,7 @@ declare namespace gapi.client {
|
|
|
1162
1150
|
interface IncrementalResultStats {
|
|
1163
1151
|
/** Output only. Reason why incremental query results are/were not written by the query. */
|
|
1164
1152
|
disabledReason?:
|
|
1165
|
-
| '
|
|
1166
|
-
| 'OTHER'
|
|
1167
|
-
| 'UNSUPPORTED_OPERATOR';
|
|
1153
|
+
'DISABLED_REASON_UNSPECIFIED' | 'OTHER' | 'UNSUPPORTED_OPERATOR';
|
|
1168
1154
|
/** Output only. Additional human-readable clarification, if available, for DisabledReason. */
|
|
1169
1155
|
disabledReasonDetails?: string;
|
|
1170
1156
|
/** Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt. */
|
|
@@ -1351,10 +1337,7 @@ declare namespace gapi.client {
|
|
|
1351
1337
|
clustering?: Clustering;
|
|
1352
1338
|
/** Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. */
|
|
1353
1339
|
columnNameCharacterMap?:
|
|
1354
|
-
| '
|
|
1355
|
-
| 'STRICT'
|
|
1356
|
-
| 'V1'
|
|
1357
|
-
| 'V2';
|
|
1340
|
+
'COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED' | 'STRICT' | 'V1' | 'V2';
|
|
1358
1341
|
/** Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. */
|
|
1359
1342
|
connectionProperties?: ConnectionProperty[];
|
|
1360
1343
|
/** Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. */
|
|
@@ -1423,9 +1406,7 @@ declare namespace gapi.client {
|
|
|
1423
1406
|
skipLeadingRows?: number;
|
|
1424
1407
|
/** Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. */
|
|
1425
1408
|
sourceColumnMatch?:
|
|
1426
|
-
| '
|
|
1427
|
-
| 'POSITION'
|
|
1428
|
-
| 'NAME';
|
|
1409
|
+
'SOURCE_COLUMN_MATCH_UNSPECIFIED' | 'POSITION' | 'NAME';
|
|
1429
1410
|
/** Optional. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. */
|
|
1430
1411
|
sourceFormat?: string;
|
|
1431
1412
|
/** [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. */
|
|
@@ -1928,9 +1909,7 @@ declare namespace gapi.client {
|
|
|
1928
1909
|
| 'CONTRIBUTION_ANALYSIS';
|
|
1929
1910
|
/** Output only. Training type of the job. */
|
|
1930
1911
|
trainingType?:
|
|
1931
|
-
| '
|
|
1932
|
-
| 'SINGLE_TRAINING'
|
|
1933
|
-
| 'HPARAM_TUNING';
|
|
1912
|
+
'TRAINING_TYPE_UNSPECIFIED' | 'SINGLE_TRAINING' | 'HPARAM_TUNING';
|
|
1934
1913
|
}
|
|
1935
1914
|
interface Model {
|
|
1936
1915
|
/** The best trial_id across all training runs. */
|
|
@@ -2224,9 +2203,7 @@ declare namespace gapi.client {
|
|
|
2224
2203
|
queryParameters?: QueryParameter[];
|
|
2225
2204
|
/** Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available. */
|
|
2226
2205
|
queryResultsFormat?:
|
|
2227
|
-
| '
|
|
2228
|
-
| 'STRUCT_ENCODING'
|
|
2229
|
-
| 'ARROW';
|
|
2206
|
+
'QUERY_RESULTS_FORMAT_UNSPECIFIED' | 'STRUCT_ENCODING' | 'ARROW';
|
|
2230
2207
|
/** Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. */
|
|
2231
2208
|
requestId?: string;
|
|
2232
2209
|
/** Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. */
|
|
@@ -2395,9 +2372,7 @@ declare namespace gapi.client {
|
|
|
2395
2372
|
description?: string;
|
|
2396
2373
|
/** Optional. The determinism level of the JavaScript UDF, if defined. */
|
|
2397
2374
|
determinismLevel?:
|
|
2398
|
-
| '
|
|
2399
|
-
| 'DETERMINISTIC'
|
|
2400
|
-
| 'NOT_DETERMINISTIC';
|
|
2375
|
+
'DETERMINISM_LEVEL_UNSPECIFIED' | 'DETERMINISTIC' | 'NOT_DETERMINISTIC';
|
|
2401
2376
|
/** Output only. A hash of this resource. */
|
|
2402
2377
|
etag?: string;
|
|
2403
2378
|
/** Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) */
|
|
@@ -2443,10 +2418,7 @@ declare namespace gapi.client {
|
|
|
2443
2418
|
buildDuration?: string;
|
|
2444
2419
|
/** Output only. The current build state of the routine. */
|
|
2445
2420
|
buildState?:
|
|
2446
|
-
| '
|
|
2447
|
-
| 'IN_PROGRESS'
|
|
2448
|
-
| 'SUCCEEDED'
|
|
2449
|
-
| 'FAILED';
|
|
2421
|
+
'BUILD_STATE_UNSPECIFIED' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED';
|
|
2450
2422
|
/** Output only. The time when the build state was updated last. */
|
|
2451
2423
|
buildStateUpdateTime?: string;
|
|
2452
2424
|
/** Output only. A result object that will be present only if the build has failed. */
|
|
@@ -2499,9 +2471,7 @@ declare namespace gapi.client {
|
|
|
2499
2471
|
interface ScriptOptions {
|
|
2500
2472
|
/** Determines which statement in the script represents the "key result", used to populate the schema and query results of the script job. Default is LAST. */
|
|
2501
2473
|
keyResultStatement?:
|
|
2502
|
-
| '
|
|
2503
|
-
| 'LAST'
|
|
2504
|
-
| 'FIRST_SELECT';
|
|
2474
|
+
'KEY_RESULT_STATEMENT_KIND_UNSPECIFIED' | 'LAST' | 'FIRST_SELECT';
|
|
2505
2475
|
/** Limit on the number of bytes billed per statement. Exceeding this budget results in an error. */
|
|
2506
2476
|
statementByteBudget?: string;
|
|
2507
2477
|
/** Timeout period for each statement in a script. */
|
|
@@ -2524,9 +2494,7 @@ declare namespace gapi.client {
|
|
|
2524
2494
|
interface ScriptStatistics {
|
|
2525
2495
|
/** Whether this child job was a statement or expression. */
|
|
2526
2496
|
evaluationKind?:
|
|
2527
|
-
| '
|
|
2528
|
-
| 'STATEMENT'
|
|
2529
|
-
| 'EXPRESSION';
|
|
2497
|
+
'EVALUATION_KIND_UNSPECIFIED' | 'STATEMENT' | 'EXPRESSION';
|
|
2530
2498
|
/** Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. */
|
|
2531
2499
|
stackFrames?: ScriptStackFrame[];
|
|
2532
2500
|
}
|
|
@@ -2767,9 +2735,7 @@ declare namespace gapi.client {
|
|
|
2767
2735
|
location?: string;
|
|
2768
2736
|
/** Optional. If set, overrides the default managed table type configured in the dataset. */
|
|
2769
2737
|
managedTableType?:
|
|
2770
|
-
| '
|
|
2771
|
-
| 'NATIVE'
|
|
2772
|
-
| 'BIGLAKE';
|
|
2738
|
+
'MANAGED_TABLE_TYPE_UNSPECIFIED' | 'NATIVE' | 'BIGLAKE';
|
|
2773
2739
|
/** Optional. The materialized view definition. */
|
|
2774
2740
|
materializedView?: MaterializedViewDefinition;
|
|
2775
2741
|
/** Output only. The materialized view status. */
|
|
@@ -3118,12 +3084,7 @@ declare namespace gapi.client {
|
|
|
3118
3084
|
cleanSpikesAndDips?: boolean;
|
|
3119
3085
|
/** Enums for color space, used for processing images in Object Table. See more details at https://www.tensorflow.org/io/tutorials/colorspace. */
|
|
3120
3086
|
colorSpace?:
|
|
3121
|
-
| '
|
|
3122
|
-
| 'RGB'
|
|
3123
|
-
| 'HSV'
|
|
3124
|
-
| 'YIQ'
|
|
3125
|
-
| 'YUV'
|
|
3126
|
-
| 'GRAYSCALE';
|
|
3087
|
+
'COLOR_SPACE_UNSPECIFIED' | 'RGB' | 'HSV' | 'YIQ' | 'YUV' | 'GRAYSCALE';
|
|
3127
3088
|
/** Subsample ratio of columns for each level for boosted tree models. */
|
|
3128
3089
|
colsampleBylevel?: number;
|
|
3129
3090
|
/** Subsample ratio of columns for each node(split) for boosted tree models. */
|
|
@@ -3380,14 +3341,10 @@ declare namespace gapi.client {
|
|
|
3380
3341
|
learnRate?: number;
|
|
3381
3342
|
/** The strategy to determine learn rate for the current iteration. */
|
|
3382
3343
|
learnRateStrategy?:
|
|
3383
|
-
| '
|
|
3384
|
-
| 'LINE_SEARCH'
|
|
3385
|
-
| 'CONSTANT';
|
|
3344
|
+
'LEARN_RATE_STRATEGY_UNSPECIFIED' | 'LINE_SEARCH' | 'CONSTANT';
|
|
3386
3345
|
/** Type of loss function used during training run. */
|
|
3387
3346
|
lossType?:
|
|
3388
|
-
| '
|
|
3389
|
-
| 'MEAN_SQUARED_LOSS'
|
|
3390
|
-
| 'MEAN_LOG_LOSS';
|
|
3347
|
+
'LOSS_TYPE_UNSPECIFIED' | 'MEAN_SQUARED_LOSS' | 'MEAN_LOG_LOSS';
|
|
3391
3348
|
/** The type of the machine used to deploy and serve the model. */
|
|
3392
3349
|
machineType?: string;
|
|
3393
3350
|
/** The maximum number of iterations in training. Used only for iterative training algorithms. */
|
|
@@ -3473,11 +3430,7 @@ declare namespace gapi.client {
|
|
|
3473
3430
|
timeSeriesTimestampColumn?: string;
|
|
3474
3431
|
/** Tree construction algorithm for boosted tree models. */
|
|
3475
3432
|
treeMethod?:
|
|
3476
|
-
| '
|
|
3477
|
-
| 'AUTO'
|
|
3478
|
-
| 'EXACT'
|
|
3479
|
-
| 'APPROX'
|
|
3480
|
-
| 'HIST';
|
|
3433
|
+
'TREE_METHOD_UNSPECIFIED' | 'AUTO' | 'EXACT' | 'APPROX' | 'HIST';
|
|
3481
3434
|
/** Smoothing window size for the trend component. When a positive value is specified, a center moving average smoothing is applied on the history trend. When the smoothing window is out of the boundary at the beginning or the end of the trend, the first element or the last element is padded to fill the smoothing window before the average is applied. */
|
|
3482
3435
|
trendSmoothingWindowSize?: string;
|
|
3483
3436
|
/** User column specified for matrix factorization models. */
|
|
@@ -4179,10 +4132,7 @@ declare namespace gapi.client {
|
|
|
4179
4132
|
quotaUser?: string;
|
|
4180
4133
|
/** Filter for job state */
|
|
4181
4134
|
stateFilter?:
|
|
4182
|
-
| 'done'
|
|
4183
|
-
| 'pending'
|
|
4184
|
-
| 'running'
|
|
4185
|
-
| ('done' | 'pending' | 'running')[];
|
|
4135
|
+
'done' | 'pending' | 'running' | ('done' | 'pending' | 'running')[];
|
|
4186
4136
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4187
4137
|
upload_protocol?: string;
|
|
4188
4138
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|