@maxim_mazurok/gapi.client.bigquery-v2 0.0.20240323 → 0.0.20240418
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 +30 -8
- 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: 20240418
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -361,7 +361,7 @@ declare namespace gapi.client {
|
|
|
361
361
|
encoding?: string;
|
|
362
362
|
/** Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C). */
|
|
363
363
|
fieldDelimiter?: string;
|
|
364
|
-
/**
|
|
364
|
+
/** Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. */
|
|
365
365
|
nullMarker?: string;
|
|
366
366
|
/** Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. */
|
|
367
367
|
preserveAsciiControlCharacters?: boolean;
|
|
@@ -442,6 +442,8 @@ declare namespace gapi.client {
|
|
|
442
442
|
location?: string;
|
|
443
443
|
/** Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. */
|
|
444
444
|
maxTimeTravelHours?: string;
|
|
445
|
+
/** Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. */
|
|
446
|
+
restrictions?: RestrictionConfig;
|
|
445
447
|
/** Output only. Reserved for future use. */
|
|
446
448
|
satisfiesPzi?: boolean;
|
|
447
449
|
/** Output only. Reserved for future use. */
|
|
@@ -457,7 +459,7 @@ declare namespace gapi.client {
|
|
|
457
459
|
/** Required. The friendly short name of the tag value, e.g. "production". */
|
|
458
460
|
tagValue?: string;
|
|
459
461
|
}>;
|
|
460
|
-
/** 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.
|
|
462
|
+
/** 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. */
|
|
461
463
|
type?: string;
|
|
462
464
|
}
|
|
463
465
|
interface DatasetAccessEntry {
|
|
@@ -518,10 +520,14 @@ declare namespace gapi.client {
|
|
|
518
520
|
interface DifferentialPrivacyPolicy {
|
|
519
521
|
/** Optional. The total delta budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of delta that is pre-defined by the contributor through the privacy policy delta_per_query field. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget. */
|
|
520
522
|
deltaBudget?: number;
|
|
523
|
+
/** Output only. The delta budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase. */
|
|
524
|
+
deltaBudgetRemaining?: number;
|
|
521
525
|
/** Optional. The delta value that is used per query. Delta represents the probability that any row will fail to be epsilon differentially private. Indicates the risk associated with exposing aggregate rows in the result of a query. */
|
|
522
526
|
deltaPerQuery?: number;
|
|
523
527
|
/** Optional. The total epsilon budget for all queries against the privacy-protected view. Each subscriber query against this view charges the amount of epsilon they request in their query. If there is sufficient budget, then the subscriber query attempts to complete. It might still fail due to other reasons, in which case the charge is refunded. If there is insufficient budget the query is rejected. There might be multiple charge attempts if a single query references multiple views. In this case there must be sufficient budget for all charges or the query is rejected and charges are refunded in best effort. The budget does not have a refresh policy and can only be updated via ALTER VIEW or circumvented by creating a new view that can be queried with a fresh budget. */
|
|
524
528
|
epsilonBudget?: number;
|
|
529
|
+
/** Output only. The epsilon budget remaining. If budget is exhausted, no more queries are allowed. Note that the budget for queries that are in progress is deducted before the query executes. If the query fails or is cancelled then the budget is refunded. In this case the amount of budget remaining can increase. */
|
|
530
|
+
epsilonBudgetRemaining?: number;
|
|
525
531
|
/** Optional. The maximum epsilon value that a query can consume. If the subscriber specifies epsilon as a parameter in a SELECT query, it must be less than or equal to this value. The epsilon parameter controls the amount of noise that is added to the groups — a higher epsilon means less noise. */
|
|
526
532
|
maxEpsilonPerQuery?: number;
|
|
527
533
|
/** Optional. The maximum groups contributed value that is used per query. Represents the maximum number of groups to which each protected entity can contribute. Changing this value does not improve or worsen privacy. The best value for accuracy and utility depends on the query and data. */
|
|
@@ -769,6 +775,10 @@ declare namespace gapi.client {
|
|
|
769
775
|
/** The numerical feature value. This is the centroid value for this feature. */
|
|
770
776
|
numericalValue?: number;
|
|
771
777
|
}
|
|
778
|
+
interface ForeignTypeInfo {
|
|
779
|
+
/** Required. Specifies the system which defines the foreign data type. */
|
|
780
|
+
typeSystem?: string;
|
|
781
|
+
}
|
|
772
782
|
interface GetIamPolicyRequest {
|
|
773
783
|
/** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
|
|
774
784
|
options?: GetPolicyOptions;
|
|
@@ -1046,7 +1056,7 @@ declare namespace gapi.client {
|
|
|
1046
1056
|
clustering?: Clustering;
|
|
1047
1057
|
/** 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. */
|
|
1048
1058
|
connectionProperties?: ConnectionProperty[];
|
|
1049
|
-
/** Optional. [Experimental] Configures the load job to
|
|
1059
|
+
/** 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. */
|
|
1050
1060
|
copyFilesOnly?: boolean;
|
|
1051
1061
|
/** Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */
|
|
1052
1062
|
createDisposition?: string;
|
|
@@ -1257,7 +1267,7 @@ declare namespace gapi.client {
|
|
|
1257
1267
|
reservation_id?: string;
|
|
1258
1268
|
/** Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. */
|
|
1259
1269
|
reservationUsage?: Array<{
|
|
1260
|
-
/** Reservation name or "unreserved" for on-demand
|
|
1270
|
+
/** Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. */
|
|
1261
1271
|
name?: string;
|
|
1262
1272
|
/** Total slot milliseconds used by the reservation for a particular job. */
|
|
1263
1273
|
slotMs?: string;
|
|
@@ -1340,7 +1350,7 @@ declare namespace gapi.client {
|
|
|
1340
1350
|
referencedTables?: TableReference[];
|
|
1341
1351
|
/** Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. */
|
|
1342
1352
|
reservationUsage?: Array<{
|
|
1343
|
-
/** Reservation name or "unreserved" for on-demand
|
|
1353
|
+
/** Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. */
|
|
1344
1354
|
name?: string;
|
|
1345
1355
|
/** Total slot milliseconds used by the reservation for a particular job. */
|
|
1346
1356
|
slotMs?: string;
|
|
@@ -1477,7 +1487,7 @@ declare namespace gapi.client {
|
|
|
1477
1487
|
tableReference?: TableReference;
|
|
1478
1488
|
}
|
|
1479
1489
|
interface MaterializedViewDefinition {
|
|
1480
|
-
/** Optional. This option declares
|
|
1490
|
+
/** Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. */
|
|
1481
1491
|
allowNonIncrementalDefinition?: boolean;
|
|
1482
1492
|
/** Optional. Enable automatic refresh of the materialized view when the base table is updated. The default value is "true". */
|
|
1483
1493
|
enableRefresh?: boolean;
|
|
@@ -1593,6 +1603,8 @@ declare namespace gapi.client {
|
|
|
1593
1603
|
enableListInference?: boolean;
|
|
1594
1604
|
/** Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. */
|
|
1595
1605
|
enumAsString?: boolean;
|
|
1606
|
+
/** Optional. Will indicate how to represent a parquet map if present. */
|
|
1607
|
+
mapTargetType?: string;
|
|
1596
1608
|
}
|
|
1597
1609
|
interface PartitionedColumn {
|
|
1598
1610
|
/** Output only. The name of the partition column. */
|
|
@@ -1861,6 +1873,10 @@ declare namespace gapi.client {
|
|
|
1861
1873
|
/** Output only. The name of the speech recognizer to use for speech recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`. Customers can specify this field at model creation. If not specified, a default recognizer `projects/{model project}/locations/global/recognizers/_` will be used. See more details at [recognizers](https://cloud.google.com/speech-to-text/v2/docs/reference/rest/v2/projects.locations.recognizers) */
|
|
1862
1874
|
speechRecognizer?: string;
|
|
1863
1875
|
}
|
|
1876
|
+
interface RestrictionConfig {
|
|
1877
|
+
/** Output only. Specifies the type of dataset/table restriction. */
|
|
1878
|
+
type?: string;
|
|
1879
|
+
}
|
|
1864
1880
|
interface Routine {
|
|
1865
1881
|
/** Optional. */
|
|
1866
1882
|
arguments?: Argument[];
|
|
@@ -2194,6 +2210,8 @@ declare namespace gapi.client {
|
|
|
2194
2210
|
requirePartitionFilter?: boolean;
|
|
2195
2211
|
/** [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on [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, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production". */
|
|
2196
2212
|
resourceTags?: {[P in string]: string};
|
|
2213
|
+
/** Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. */
|
|
2214
|
+
restrictions?: RestrictionConfig;
|
|
2197
2215
|
/** Optional. Describes the schema of this table. */
|
|
2198
2216
|
schema?: TableSchema;
|
|
2199
2217
|
/** Output only. A URL that can be used to access this resource again. */
|
|
@@ -2297,6 +2315,8 @@ declare namespace gapi.client {
|
|
|
2297
2315
|
description?: string;
|
|
2298
2316
|
/** Optional. Describes the nested schema fields if the type property is set to RECORD. */
|
|
2299
2317
|
fields?: TableFieldSchema[];
|
|
2318
|
+
/** 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. */
|
|
2319
|
+
foreignTypeDefinition?: string;
|
|
2300
2320
|
/** 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". */
|
|
2301
2321
|
maxLength?: string;
|
|
2302
2322
|
/** Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. */
|
|
@@ -2403,6 +2423,8 @@ declare namespace gapi.client {
|
|
|
2403
2423
|
interface TableSchema {
|
|
2404
2424
|
/** Describes the fields in a table. */
|
|
2405
2425
|
fields?: TableFieldSchema[];
|
|
2426
|
+
/** Optional. Specifies metadata of the foreign data type definition in field schema (TableFieldSchema.foreign_type_definition). */
|
|
2427
|
+
foreignTypeInfo?: ForeignTypeInfo;
|
|
2406
2428
|
}
|
|
2407
2429
|
interface TestIamPermissionsRequest {
|
|
2408
2430
|
/** The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */
|
|
@@ -2793,7 +2815,7 @@ declare namespace gapi.client {
|
|
|
2793
2815
|
callback?: string;
|
|
2794
2816
|
/** Selector specifying which fields to include in a partial response. */
|
|
2795
2817
|
fields?: string;
|
|
2796
|
-
/** An expression for filtering the results of the request by label. The syntax is \"labels.<name>[:<value>]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See [Filtering datasets using labels](/bigquery/docs/
|
|
2818
|
+
/** An expression for filtering the results of the request by label. The syntax is \"labels.<name>[:<value>]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See [Filtering datasets using labels](/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. */
|
|
2797
2819
|
filter?: string;
|
|
2798
2820
|
/** 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. */
|
|
2799
2821
|
key?: string;
|