@maxim_mazurok/gapi.client.bigquerydatapolicy-v2 0.0.20260304 → 0.1.20260513
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 +58 -33
- package/package.json +1 -1
- package/readme.md +17 -0
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://bigquerydatapolicy.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260513
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -42,7 +42,11 @@ declare namespace gapi.client {
|
|
|
42
42
|
/** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
|
|
43
43
|
exemptedMembers?: string[];
|
|
44
44
|
/** The log type that this config enables. */
|
|
45
|
-
logType?:
|
|
45
|
+
logType?:
|
|
46
|
+
| 'LOG_TYPE_UNSPECIFIED'
|
|
47
|
+
| 'ADMIN_READ'
|
|
48
|
+
| 'DATA_WRITE'
|
|
49
|
+
| 'DATA_READ';
|
|
46
50
|
}
|
|
47
51
|
interface Binding {
|
|
48
52
|
/** The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|
|
@@ -58,19 +62,40 @@ declare namespace gapi.client {
|
|
|
58
62
|
/** Required. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name. */
|
|
59
63
|
dataPolicyId?: string;
|
|
60
64
|
}
|
|
65
|
+
interface DataGovernanceTag {
|
|
66
|
+
/** Optional. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example `parent-id/pii` where `parent-id` is the ID of the parent organization or project resource for this tag key. */
|
|
67
|
+
key?: string;
|
|
68
|
+
/** Optional. Specifies the tag value as the short name, for example `sensitive`. */
|
|
69
|
+
value?: string;
|
|
70
|
+
}
|
|
61
71
|
interface DataMaskingPolicy {
|
|
62
72
|
/** Optional. A predefined masking expression. */
|
|
63
|
-
predefinedExpression?:
|
|
73
|
+
predefinedExpression?:
|
|
74
|
+
| 'PREDEFINED_EXPRESSION_UNSPECIFIED'
|
|
75
|
+
| 'SHA256'
|
|
76
|
+
| 'ALWAYS_NULL'
|
|
77
|
+
| 'DEFAULT_MASKING_VALUE'
|
|
78
|
+
| 'LAST_FOUR_CHARACTERS'
|
|
79
|
+
| 'FIRST_FOUR_CHARACTERS'
|
|
80
|
+
| 'EMAIL_MASK'
|
|
81
|
+
| 'DATE_YEAR_MASK'
|
|
82
|
+
| 'RANDOM_HASH';
|
|
64
83
|
/** Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`. */
|
|
65
84
|
routine?: string;
|
|
66
85
|
}
|
|
67
86
|
interface DataPolicy {
|
|
87
|
+
/** Optional. Data Governance tag bound to the Data Policy. */
|
|
88
|
+
dataGovernanceTag?: DataGovernanceTag;
|
|
68
89
|
/** Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY. */
|
|
69
90
|
dataMaskingPolicy?: DataMaskingPolicy;
|
|
70
91
|
/** Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name. */
|
|
71
92
|
dataPolicyId?: string;
|
|
72
93
|
/** Required. Type of data policy. */
|
|
73
|
-
dataPolicyType?:
|
|
94
|
+
dataPolicyType?:
|
|
95
|
+
| 'DATA_POLICY_TYPE_UNSPECIFIED'
|
|
96
|
+
| 'DATA_MASKING_POLICY'
|
|
97
|
+
| 'RAW_DATA_ACCESS_POLICY'
|
|
98
|
+
| 'COLUMN_LEVEL_SECURITY_POLICY';
|
|
74
99
|
/** The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls. */
|
|
75
100
|
etag?: string;
|
|
76
101
|
/** Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated. */
|
|
@@ -80,7 +105,7 @@ declare namespace gapi.client {
|
|
|
80
105
|
/** Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies. */
|
|
81
106
|
policyTag?: string;
|
|
82
107
|
/** Output only. The version of the Data Policy resource. */
|
|
83
|
-
version?:
|
|
108
|
+
version?: 'VERSION_UNSPECIFIED' | 'V1' | 'V2';
|
|
84
109
|
}
|
|
85
110
|
interface Empty {}
|
|
86
111
|
interface Expr {
|
|
@@ -139,11 +164,11 @@ declare namespace gapi.client {
|
|
|
139
164
|
/** Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored. */
|
|
140
165
|
addGrantees(request: {
|
|
141
166
|
/** V1 error format. */
|
|
142
|
-
'$.xgafv'?:
|
|
167
|
+
'$.xgafv'?: '1' | '2';
|
|
143
168
|
/** OAuth access token. */
|
|
144
169
|
access_token?: string;
|
|
145
170
|
/** Data format for response. */
|
|
146
|
-
alt?:
|
|
171
|
+
alt?: 'json' | 'media' | 'proto';
|
|
147
172
|
/** JSONP */
|
|
148
173
|
callback?: string;
|
|
149
174
|
/** Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. */
|
|
@@ -168,11 +193,11 @@ declare namespace gapi.client {
|
|
|
168
193
|
addGrantees(
|
|
169
194
|
request: {
|
|
170
195
|
/** V1 error format. */
|
|
171
|
-
'$.xgafv'?:
|
|
196
|
+
'$.xgafv'?: '1' | '2';
|
|
172
197
|
/** OAuth access token. */
|
|
173
198
|
access_token?: string;
|
|
174
199
|
/** Data format for response. */
|
|
175
|
-
alt?:
|
|
200
|
+
alt?: 'json' | 'media' | 'proto';
|
|
176
201
|
/** JSONP */
|
|
177
202
|
callback?: string;
|
|
178
203
|
/** Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. */
|
|
@@ -197,11 +222,11 @@ declare namespace gapi.client {
|
|
|
197
222
|
/** Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type. */
|
|
198
223
|
create(request: {
|
|
199
224
|
/** V1 error format. */
|
|
200
|
-
'$.xgafv'?:
|
|
225
|
+
'$.xgafv'?: '1' | '2';
|
|
201
226
|
/** OAuth access token. */
|
|
202
227
|
access_token?: string;
|
|
203
228
|
/** Data format for response. */
|
|
204
|
-
alt?:
|
|
229
|
+
alt?: 'json' | 'media' | 'proto';
|
|
205
230
|
/** JSONP */
|
|
206
231
|
callback?: string;
|
|
207
232
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -226,11 +251,11 @@ declare namespace gapi.client {
|
|
|
226
251
|
create(
|
|
227
252
|
request: {
|
|
228
253
|
/** V1 error format. */
|
|
229
|
-
'$.xgafv'?:
|
|
254
|
+
'$.xgafv'?: '1' | '2';
|
|
230
255
|
/** OAuth access token. */
|
|
231
256
|
access_token?: string;
|
|
232
257
|
/** Data format for response. */
|
|
233
|
-
alt?:
|
|
258
|
+
alt?: 'json' | 'media' | 'proto';
|
|
234
259
|
/** JSONP */
|
|
235
260
|
callback?: string;
|
|
236
261
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -255,11 +280,11 @@ declare namespace gapi.client {
|
|
|
255
280
|
/** Deletes the data policy specified by its resource name. */
|
|
256
281
|
delete(request?: {
|
|
257
282
|
/** V1 error format. */
|
|
258
|
-
'$.xgafv'?:
|
|
283
|
+
'$.xgafv'?: '1' | '2';
|
|
259
284
|
/** OAuth access token. */
|
|
260
285
|
access_token?: string;
|
|
261
286
|
/** Data format for response. */
|
|
262
|
-
alt?:
|
|
287
|
+
alt?: 'json' | 'media' | 'proto';
|
|
263
288
|
/** JSONP */
|
|
264
289
|
callback?: string;
|
|
265
290
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -282,11 +307,11 @@ declare namespace gapi.client {
|
|
|
282
307
|
/** Gets the data policy specified by its resource name. */
|
|
283
308
|
get(request?: {
|
|
284
309
|
/** V1 error format. */
|
|
285
|
-
'$.xgafv'?:
|
|
310
|
+
'$.xgafv'?: '1' | '2';
|
|
286
311
|
/** OAuth access token. */
|
|
287
312
|
access_token?: string;
|
|
288
313
|
/** Data format for response. */
|
|
289
|
-
alt?:
|
|
314
|
+
alt?: 'json' | 'media' | 'proto';
|
|
290
315
|
/** JSONP */
|
|
291
316
|
callback?: string;
|
|
292
317
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -310,11 +335,11 @@ declare namespace gapi.client {
|
|
|
310
335
|
getIamPolicy(
|
|
311
336
|
request: {
|
|
312
337
|
/** V1 error format. */
|
|
313
|
-
'$.xgafv'?:
|
|
338
|
+
'$.xgafv'?: '1' | '2';
|
|
314
339
|
/** OAuth access token. */
|
|
315
340
|
access_token?: string;
|
|
316
341
|
/** Data format for response. */
|
|
317
|
-
alt?:
|
|
342
|
+
alt?: 'json' | 'media' | 'proto';
|
|
318
343
|
/** JSONP */
|
|
319
344
|
callback?: string;
|
|
320
345
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -339,11 +364,11 @@ declare namespace gapi.client {
|
|
|
339
364
|
/** List all of the data policies in the specified parent project. */
|
|
340
365
|
list(request?: {
|
|
341
366
|
/** V1 error format. */
|
|
342
|
-
'$.xgafv'?:
|
|
367
|
+
'$.xgafv'?: '1' | '2';
|
|
343
368
|
/** OAuth access token. */
|
|
344
369
|
access_token?: string;
|
|
345
370
|
/** Data format for response. */
|
|
346
|
-
alt?:
|
|
371
|
+
alt?: 'json' | 'media' | 'proto';
|
|
347
372
|
/** JSONP */
|
|
348
373
|
callback?: string;
|
|
349
374
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -372,13 +397,13 @@ declare namespace gapi.client {
|
|
|
372
397
|
/** Updates the metadata for an existing data policy. The target data policy can be specified by the resource name. */
|
|
373
398
|
patch(request: {
|
|
374
399
|
/** V1 error format. */
|
|
375
|
-
'$.xgafv'?:
|
|
400
|
+
'$.xgafv'?: '1' | '2';
|
|
376
401
|
/** OAuth access token. */
|
|
377
402
|
access_token?: string;
|
|
378
403
|
/** Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored. */
|
|
379
404
|
allowMissing?: boolean;
|
|
380
405
|
/** Data format for response. */
|
|
381
|
-
alt?:
|
|
406
|
+
alt?: 'json' | 'media' | 'proto';
|
|
382
407
|
/** JSONP */
|
|
383
408
|
callback?: string;
|
|
384
409
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -405,13 +430,13 @@ declare namespace gapi.client {
|
|
|
405
430
|
patch(
|
|
406
431
|
request: {
|
|
407
432
|
/** V1 error format. */
|
|
408
|
-
'$.xgafv'?:
|
|
433
|
+
'$.xgafv'?: '1' | '2';
|
|
409
434
|
/** OAuth access token. */
|
|
410
435
|
access_token?: string;
|
|
411
436
|
/** Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored. */
|
|
412
437
|
allowMissing?: boolean;
|
|
413
438
|
/** Data format for response. */
|
|
414
|
-
alt?:
|
|
439
|
+
alt?: 'json' | 'media' | 'proto';
|
|
415
440
|
/** JSONP */
|
|
416
441
|
callback?: string;
|
|
417
442
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -438,11 +463,11 @@ declare namespace gapi.client {
|
|
|
438
463
|
/** Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored. */
|
|
439
464
|
removeGrantees(request: {
|
|
440
465
|
/** V1 error format. */
|
|
441
|
-
'$.xgafv'?:
|
|
466
|
+
'$.xgafv'?: '1' | '2';
|
|
442
467
|
/** OAuth access token. */
|
|
443
468
|
access_token?: string;
|
|
444
469
|
/** Data format for response. */
|
|
445
|
-
alt?:
|
|
470
|
+
alt?: 'json' | 'media' | 'proto';
|
|
446
471
|
/** JSONP */
|
|
447
472
|
callback?: string;
|
|
448
473
|
/** Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. */
|
|
@@ -467,11 +492,11 @@ declare namespace gapi.client {
|
|
|
467
492
|
removeGrantees(
|
|
468
493
|
request: {
|
|
469
494
|
/** V1 error format. */
|
|
470
|
-
'$.xgafv'?:
|
|
495
|
+
'$.xgafv'?: '1' | '2';
|
|
471
496
|
/** OAuth access token. */
|
|
472
497
|
access_token?: string;
|
|
473
498
|
/** Data format for response. */
|
|
474
|
-
alt?:
|
|
499
|
+
alt?: 'json' | 'media' | 'proto';
|
|
475
500
|
/** JSONP */
|
|
476
501
|
callback?: string;
|
|
477
502
|
/** Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. */
|
|
@@ -497,11 +522,11 @@ declare namespace gapi.client {
|
|
|
497
522
|
setIamPolicy(
|
|
498
523
|
request: {
|
|
499
524
|
/** V1 error format. */
|
|
500
|
-
'$.xgafv'?:
|
|
525
|
+
'$.xgafv'?: '1' | '2';
|
|
501
526
|
/** OAuth access token. */
|
|
502
527
|
access_token?: string;
|
|
503
528
|
/** Data format for response. */
|
|
504
|
-
alt?:
|
|
529
|
+
alt?: 'json' | 'media' | 'proto';
|
|
505
530
|
/** JSONP */
|
|
506
531
|
callback?: string;
|
|
507
532
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -527,11 +552,11 @@ declare namespace gapi.client {
|
|
|
527
552
|
testIamPermissions(
|
|
528
553
|
request: {
|
|
529
554
|
/** V1 error format. */
|
|
530
|
-
'$.xgafv'?:
|
|
555
|
+
'$.xgafv'?: '1' | '2';
|
|
531
556
|
/** OAuth access token. */
|
|
532
557
|
access_token?: string;
|
|
533
558
|
/** Data format for response. */
|
|
534
|
-
alt?:
|
|
559
|
+
alt?: 'json' | 'media' | 'proto';
|
|
535
560
|
/** JSONP */
|
|
536
561
|
callback?: string;
|
|
537
562
|
/** Selector specifying which fields to include in a partial response. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for BigQuery Data Policy API:
|
|
|
11
11
|
npm install @types/gapi.client.bigquerydatapolicy-v2 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.bigquerydatapolicy-v2"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|