@maxim_mazurok/gapi.client.bigquery-v2 0.0.20240214 → 0.0.20240323

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://bigquery.googleapis.com/$discovery/rest?version=v2
-// Revision: 20240214
+// Revision: 20240323
 
 /// <reference types="gapi.client" />
 
@@ -418,6 +418,8 @@ declare namespace gapi.client {
       description?: string;
       /** Output only. A hash of the resource. */
       etag?: string;
+      /** Optional. Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset. */
+      externalCatalogDatasetOptions?: ExternalCatalogDatasetOptions;
       /** Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL. */
       externalDatasetReference?: ExternalDatasetReference;
       /** Optional. A descriptive name for the dataset. */
@@ -432,6 +434,8 @@ declare namespace gapi.client {
       labels?: {[P in string]: string};
       /** Output only. The date when this dataset was last modified, in milliseconds since the epoch. */
       lastModifiedTime?: string;
+      /** Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED. */
+      linkedDatasetMetadata?: LinkedDatasetMetadata;
       /** Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored. */
       linkedDatasetSource?: LinkedDatasetSource;
       /** The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */
@@ -511,6 +515,20 @@ declare namespace gapi.client {
       /** Optional. The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. */
       labels?: {[P in string]: string};
     }
+    interface DifferentialPrivacyPolicy {
+      /** 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. */
+      deltaBudget?: number;
+      /** 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. */
+      deltaPerQuery?: number;
+      /** 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. */
+      epsilonBudget?: number;
+      /** 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. */
+      maxEpsilonPerQuery?: number;
+      /** 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. */
+      maxGroupsContributed?: string;
+      /** Optional. The privacy unit column associated with this policy. Differential privacy policies can only have one privacy unit column per data source object (table, view). */
+      privacyUnitColumn?: string;
+    }
     interface DimensionalityReductionMetrics {
       /** Total percentage of variance explained by the selected principal components. */
       totalExplainedVarianceRatio?: number;
@@ -667,6 +685,20 @@ declare namespace gapi.client {
       /** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
       title?: string;
     }
+    interface ExternalCatalogDatasetOptions {
+      /** Optional. The storage location URI for all tables in the dataset. Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters. */
+      defaultStorageLocationUri?: string;
+      /** Optional. A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2Mib. */
+      parameters?: {[P in string]: string};
+    }
+    interface ExternalCatalogTableOptions {
+      /** Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table from BigQuery Engine. The connection_id can have the form `..` or `projects//locations//connections/`. */
+      connectionId?: string;
+      /** Optional. A map of key value pairs defining the parameters and properties of the open source table. Corresponds with hive meta store table parameters. Maximum size of 4Mib. */
+      parameters?: {[P in string]: string};
+      /** Optional. A storage descriptor containing information about the physical storage of this table. */
+      storageDescriptor?: StorageDescriptor;
+    }
     interface ExternalDataConfiguration {
       /** Try to detect schema and format options automatically. Any option specified explicitly will be honored. */
       autodetect?: boolean;
@@ -1376,6 +1408,12 @@ declare namespace gapi.client {
       /** Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'. */
       state?: string;
     }
+    interface JoinRestrictionPolicy {
+      /** Optional. The only columns that joins are allowed on. This field is must be specified for join_conditions JOIN_ANY and JOIN_ALL and it cannot be set for JOIN_BLOCKED. */
+      joinAllowedColumns?: string[];
+      /** Optional. Specifies if a join is required or not on queries for the view. Default is JOIN_CONDITION_UNSPECIFIED. */
+      joinCondition?: string;
+    }
     interface JsonObject {
       [key: string]: any;
     }
@@ -1384,6 +1422,10 @@ declare namespace gapi.client {
       encoding?: string;
     }
     interface JsonValue {}
+    interface LinkedDatasetMetadata {
+      /** Output only. Specifies whether Linked Dataset is currently in a linked state or not. */
+      linkState?: string;
+    }
     interface LinkedDatasetSource {
       /** The source dataset reference contains project numbers and not project ids. */
       sourceDataset?: DatasetReference;
@@ -1552,6 +1594,18 @@ declare namespace gapi.client {
       /** Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. */
       enumAsString?: boolean;
     }
+    interface PartitionedColumn {
+      /** Output only. The name of the partition column. */
+      field?: string;
+    }
+    interface PartitioningDefinition {
+      /** Output only. Details about each partitioning column. BigQuery native tables only support 1 partitioning column. Other table types may support 0, 1 or more partitioning columns. */
+      partitionedColumn?: PartitionedColumn[];
+    }
+    interface PartitionSkew {
+      /** Output only. Source stages which produce skewed data. */
+      skewSources?: SkewSource[];
+    }
     interface PerformanceInsights {
       /** Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. */
       avgPreviousExecutionMs?: string;
@@ -1583,6 +1637,10 @@ declare namespace gapi.client {
     interface PrivacyPolicy {
       /** Optional. Policy used for aggregation thresholds. */
       aggregationThresholdPolicy?: AggregationThresholdPolicy;
+      /** Optional. Policy used for differential privacy. */
+      differentialPrivacyPolicy?: DifferentialPrivacyPolicy;
+      /** Optional. Join restriction policy is outside of the one of policies, since this policy can be set along with other policies. This policy gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view. */
+      joinRestrictionPolicy?: JoinRestrictionPolicy;
     }
     interface ProjectList {
       /** A hash of the page of results. */
@@ -1915,6 +1973,14 @@ declare namespace gapi.client {
       /** Specifies the index usage mode for the query. */
       indexUsageMode?: string;
     }
+    interface SerDeInfo {
+      /** Optional. Name of the SerDe. The maximum length is 256 characters. */
+      name?: string;
+      /** Optional. Key-value pairs that define the initialization parameters for the serialization library. Maximum size 10 Kib. */
+      parameters?: {[P in string]: string};
+      /** Required. Specifies a fully-qualified class name of the serialization library that is responsible for the translation of data between table representation and the underlying low-level input and output format structures. The maximum length is 256 characters. */
+      serializationLibrary?: string;
+    }
     interface SessionInfo {
       /** Output only. The id of the session. */
       sessionId?: string;
@@ -1925,6 +1991,10 @@ declare namespace gapi.client {
       /** OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */
       updateMask?: string;
     }
+    interface SkewSource {
+      /** Output only. Stage id of the skew source stage. */
+      stageId?: string;
+    }
     interface SnapshotDefinition {
       /** Required. Reference describing the ID of the table that was snapshot. */
       baseTableReference?: TableReference;
@@ -1962,9 +2032,9 @@ declare namespace gapi.client {
     interface SparkStatistics {
       /** Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI. */
       endpoints?: {[P in string]: string};
-      /** Output only. The Google Cloud Storage bucket that is used as the default filesystem by the Spark application. This fields is only filled when the Spark procedure uses the INVOKER security mode. It is inferred from the system variable @@spark_proc_properties.staging_bucket if it is provided. Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]` */
+      /** Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]` */
       gcsStagingBucket?: string;
-      /** Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses DEFINER security mode, the Cloud KMS key is inferred from the Spark connection associated with the procedure if it is provided. Otherwise the key is inferred from the default key of the Spark connection's project if the CMEK organization policy is enforced. If the Spark procedure uses INVOKER security mode, the Cloud KMS encryption key is inferred from the system variable @@spark_proc_properties.kms_key_name if it is provided. Otherwise, the key is inferred fromt he default key of the BigQuery job's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` */
+      /** Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` */
       kmsKeyName?: string;
       /** Output only. Logging info is used to generate a link to Cloud Logging. */
       loggingInfo?: SparkLoggingInfo;
@@ -1986,6 +2056,8 @@ declare namespace gapi.client {
       highCardinalityJoins?: HighCardinalityJoin[];
       /** Output only. True if the stage has insufficient shuffle quota. */
       insufficientShuffleQuota?: boolean;
+      /** Output only. Partition skew in the stage. */
+      partitionSkew?: PartitionSkew;
       /** Output only. True if the stage has a slot contention issue. */
       slotContention?: boolean;
       /** Output only. The stage id that the insight mapped to. */
@@ -2015,6 +2087,16 @@ declare namespace gapi.client {
       /** The columns in this table type */
       columns?: StandardSqlField[];
     }
+    interface StorageDescriptor {
+      /** Optional. Specifies the fully qualified class name of the InputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcInputFormat"). The maximum length is 128 characters. */
+      inputFormat?: string;
+      /** Optional. The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes. */
+      locationUri?: string;
+      /** Optional. Specifies the fully qualified class name of the OutputFormat (e.g. "org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat"). The maximum length is 128 characters. */
+      outputFormat?: string;
+      /** Optional. Serializer and deserializer information. */
+      serdeInfo?: SerDeInfo;
+    }
     interface Streamingbuffer {
       /** Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer. */
       estimatedBytes?: string;
@@ -2054,6 +2136,8 @@ declare namespace gapi.client {
       etag?: string;
       /** Optional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables. */
       expirationTime?: string;
+      /** Optional. Options defining open source compatible table. */
+      externalCatalogTableOptions?: ExternalCatalogTableOptions;
       /** Optional. Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. */
       externalDataConfiguration?: ExternalDataConfiguration;
       /** Optional. A descriptive name for this table. */
@@ -2100,6 +2184,8 @@ declare namespace gapi.client {
       numTotalLogicalBytes?: string;
       /** Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. */
       numTotalPhysicalBytes?: string;
+      /** Output only. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, and iceberg partitioned tables. */
+      partitionDefinition?: PartitioningDefinition;
       /** If specified, configures range partitioning for this table. */
       rangePartitioning?: RangePartitioning;
       /** Optional. Output only. Table references of all replicas currently active on the table. */
@@ -2226,14 +2312,14 @@ declare namespace gapi.client {
       precision?: string;
       /** Represents the type of a field element. */
       rangeElementType?: {
-        /** Required. The type of a field element. See TableFieldSchema.type. */
+        /** Required. The type of a field element. For more information, see TableFieldSchema.type. */
         type?: string;
       };
       /** Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. */
       roundingMode?: string;
       /** Optional. See documentation for precision. */
       scale?: string;
-      /** Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) Use of RECORD/STRUCT indicates that the field contains a nested schema. */
+      /** Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE ([Preview](/products/#product-launch-stages)) Use of RECORD/STRUCT indicates that the field contains a nested schema. */
       type?: string;
     }
     interface TableList {
@@ -2545,7 +2631,7 @@ declare namespace gapi.client {
       type?: StandardSqlDataType;
     }
     interface UndeleteDatasetRequest {
-      /** Optional. The exact time when the dataset was deleted. If not specified, it will undelete the most recently deleted version. */
+      /** Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. */
       deletionTime?: string;
     }
     interface UserDefinedFunctionResource {
@@ -3496,6 +3582,36 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<Routine>;
+      /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
+      getIamPolicy(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** 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. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
+          resource: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GetIamPolicyRequest
+      ): Request<Policy>;
       /** Creates a new routine in the dataset. */
       insert(request: {
         /** V1 error format. */
@@ -3595,6 +3711,36 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListRoutinesResponse>;
+      /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
+      setIamPolicy(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** 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. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
+          resource: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: SetIamPolicyRequest
+      ): Request<Policy>;
       /** Updates information in an existing routine. The update method replaces the entire Routine resource. */
       update(request: {
         /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.bigquery-v2",
-  "version": "0.0.20240214",
+  "version": "0.0.20240323",
   "description": "TypeScript typings for BigQuery API v2",
   "repository": {
     "type": "git",

package/readme.md

@@ -244,6 +244,11 @@ await gapi.client.bigquery.routines.get({
   routineId: 'routineId',
 });
 
+/*
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+*/
+await gapi.client.bigquery.routines.getIamPolicy({resource: 'resource'});
+
 /*
 Creates a new routine in the dataset.
 */
@@ -260,6 +265,11 @@ await gapi.client.bigquery.routines.list({
   projectId: 'projectId',
 });
 
+/*
+Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+*/
+await gapi.client.bigquery.routines.setIamPolicy({resource: 'resource'});
+
 /*
 Updates information in an existing routine. The update method replaces the entire Routine resource.
 */