@maxim_mazurok/gapi.client.kmsinventory-v1 0.0.20230415 → 0.0.20230429

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.
Files changed (3) hide show
  1. package/index.d.ts +207 -104
  2. package/package.json +1 -1
  3. package/tests.ts +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://kmsinventory.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230415
12
+ // Revision: 20230429
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,218 +24,291 @@ declare namespace gapi.client {
24
24
  namespace kmsinventory {
25
25
  interface GoogleCloudKmsInventoryV1ListCryptoKeysResponse {
26
26
  /** The list of CryptoKeys. */
27
- cryptoKeys?: GoogleCloudKmsV1CryptoKey[];
27
+ cryptoKeys?:
28
+ GoogleCloudKmsV1CryptoKey[];
28
29
  /** The page token returned from the previous response if the next page is desired. */
29
- nextPageToken?: string;
30
+ nextPageToken?:
31
+ string;
30
32
  }
31
33
  interface GoogleCloudKmsInventoryV1ProtectedResource {
32
34
  /** The Cloud product that owns the resource. Example: `compute` */
33
- cloudProduct?: string;
35
+ cloudProduct?:
36
+ string;
34
37
  /** Output only. The time at which this resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. */
35
- createTime?: string;
38
+ createTime?:
39
+ string;
36
40
  /**
37
41
  * The name of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect this
38
42
  * resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key version data to Asset Inventory. If there are multiple key versions
39
43
  * protecting the resource, then this is same value as the first element of crypto_key_versions.
40
44
  */
41
- cryptoKeyVersion?: string;
45
+ cryptoKeyVersion?:
46
+ string;
42
47
  /**
43
48
  * The names of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect
44
49
  * this resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key versions data to Asset Inventory. The first element of this field is
45
50
  * stored in crypto_key_version.
46
51
  */
47
- cryptoKeyVersions?: string[];
52
+ cryptoKeyVersions?:
53
+ string[];
48
54
  /** A key-value pair of the resource's labels (v1) to their values. */
49
- labels?: { [P in string]: string };
55
+ labels?:
56
+ { [P in string]: string };
50
57
  /** Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. */
51
- location?: string;
58
+ location?:
59
+ string;
52
60
  /** The full resource name of the resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. */
53
- name?: string;
61
+ name?:
62
+ string;
54
63
  /** Format: `projects/{PROJECT_NUMBER}`. */
55
- project?: string;
64
+ project?:
65
+ string;
56
66
  /** The ID of the project that owns the resource. */
57
- projectId?: string;
67
+ projectId?:
68
+ string;
58
69
  /** Example: `compute.googleapis.com/Disk` */
59
- resourceType?: string;
70
+ resourceType?:
71
+ string;
60
72
  }
61
73
  interface GoogleCloudKmsInventoryV1ProtectedResourcesSummary {
62
74
  /** The number of resources protected by the key grouped by Cloud product. */
63
- cloudProducts?: { [P in string]: string };
75
+ cloudProducts?:
76
+ { [P in string]: string };
64
77
  /** The number of resources protected by the key grouped by region. */
65
- locations?: { [P in string]: string };
78
+ locations?:
79
+ { [P in string]: string };
66
80
  /** The full name of the ProtectedResourcesSummary resource. Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary */
67
- name?: string;
81
+ name?:
82
+ string;
68
83
  /** The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key. */
69
- projectCount?: number;
84
+ projectCount?:
85
+ number;
70
86
  /** The total number of protected resources in the same Cloud organization as the key. */
71
- resourceCount?: string;
87
+ resourceCount?:
88
+ string;
72
89
  /** The number of resources protected by the key grouped by resource type. */
73
- resourceTypes?: { [P in string]: string };
90
+ resourceTypes?:
91
+ { [P in string]: string };
74
92
  }
75
93
  interface GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse {
76
94
  /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
77
- nextPageToken?: string;
95
+ nextPageToken?:
96
+ string;
78
97
  /** Protected resources for this page. */
79
- protectedResources?: GoogleCloudKmsInventoryV1ProtectedResource[];
98
+ protectedResources?:
99
+ GoogleCloudKmsInventoryV1ProtectedResource[];
80
100
  }
81
101
  interface GoogleCloudKmsV1CryptoKey {
82
102
  /** Output only. The time at which this CryptoKey was created. */
83
- createTime?: string;
103
+ createTime?:
104
+ string;
84
105
  /**
85
106
  * Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic
86
107
  * operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format
87
108
  * `projects/*‍/locations/*‍/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.
88
109
  */
89
- cryptoKeyBackend?: string;
110
+ cryptoKeyBackend?:
111
+ string;
90
112
  /**
91
113
  * Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default
92
114
  * duration is 24 hours.
93
115
  */
94
- destroyScheduledDuration?: string;
116
+ destroyScheduledDuration?:
117
+ string;
95
118
  /** Immutable. Whether this key may contain imported versions only. */
96
- importOnly?: boolean;
119
+ importOnly?:
120
+ boolean;
97
121
  /** Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). */
98
- labels?: { [P in string]: string };
122
+ labels?:
123
+ { [P in string]: string };
99
124
  /** Output only. The resource name for this CryptoKey in the format `projects/*‍/locations/*‍/keyRings/*‍/cryptoKeys/*`. */
100
- name?: string;
125
+ name?:
126
+ string;
101
127
  /**
102
128
  * At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually
103
129
  * via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this
104
130
  * field must be omitted.
105
131
  */
106
- nextRotationTime?: string;
132
+ nextRotationTime?:
133
+ string;
107
134
  /**
108
135
  * Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be
109
136
  * updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
110
137
  */
111
- primary?: GoogleCloudKmsV1CryptoKeyVersion;
138
+ primary?:
139
+ GoogleCloudKmsV1CryptoKeyVersion;
112
140
  /** Immutable. The immutable purpose of this CryptoKey. */
113
- purpose?: string;
141
+ purpose?:
142
+ string;
114
143
  /**
115
144
  * next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set,
116
145
  * next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
117
146
  */
118
- rotationPeriod?: string;
147
+ rotationPeriod?:
148
+ string;
119
149
  /**
120
150
  * A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are
121
151
  * controlled by this template.
122
152
  */
123
- versionTemplate?: GoogleCloudKmsV1CryptoKeyVersionTemplate;
153
+ versionTemplate?:
154
+ GoogleCloudKmsV1CryptoKeyVersionTemplate;
124
155
  }
125
156
  interface GoogleCloudKmsV1CryptoKeyVersion {
126
157
  /** Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. */
127
- algorithm?: string;
158
+ algorithm?:
159
+ string;
128
160
  /**
129
161
  * Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of
130
162
  * Google. Only provided for key versions with protection_level HSM.
131
163
  */
132
- attestation?: GoogleCloudKmsV1KeyOperationAttestation;
164
+ attestation?:
165
+ GoogleCloudKmsV1KeyOperationAttestation;
133
166
  /** Output only. The time at which this CryptoKeyVersion was created. */
134
- createTime?: string;
167
+ createTime?:
168
+ string;
135
169
  /** Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. */
136
- destroyEventTime?: string;
170
+ destroyEventTime?:
171
+ string;
137
172
  /** Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. */
138
- destroyTime?: string;
173
+ destroyTime?:
174
+ string;
139
175
  /** Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. */
140
- externalDestructionFailureReason?: string;
176
+ externalDestructionFailureReason?:
177
+ string;
141
178
  /**
142
179
  * ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection
143
180
  * levels.
144
181
  */
145
- externalProtectionLevelOptions?: GoogleCloudKmsV1ExternalProtectionLevelOptions;
182
+ externalProtectionLevelOptions?:
183
+ GoogleCloudKmsV1ExternalProtectionLevelOptions;
146
184
  /** Output only. The time this CryptoKeyVersion's key material was generated. */
147
- generateTime?: string;
185
+ generateTime?:
186
+ string;
148
187
  /** Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. */
149
- generationFailureReason?: string;
188
+ generationFailureReason?:
189
+ string;
150
190
  /** Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. */
151
- importFailureReason?: string;
191
+ importFailureReason?:
192
+ string;
152
193
  /** Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. */
153
- importJob?: string;
194
+ importJob?:
195
+ string;
154
196
  /** Output only. The time at which this CryptoKeyVersion's key material was most recently imported. */
155
- importTime?: string;
197
+ importTime?:
198
+ string;
156
199
  /** Output only. The resource name for this CryptoKeyVersion in the format `projects/*‍/locations/*‍/keyRings/*‍/cryptoKeys/*‍/cryptoKeyVersions/*`. */
157
- name?: string;
200
+ name?:
201
+ string;
158
202
  /** Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. */
159
- protectionLevel?: string;
203
+ protectionLevel?:
204
+ string;
160
205
  /** Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. */
161
- reimportEligible?: boolean;
206
+ reimportEligible?:
207
+ boolean;
162
208
  /** The current state of the CryptoKeyVersion. */
163
- state?: string;
209
+ state?:
210
+ string;
164
211
  }
165
212
  interface GoogleCloudKmsV1CryptoKeyVersionTemplate {
166
213
  /**
167
214
  * Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted
168
215
  * and CryptoKey.purpose is ENCRYPT_DECRYPT.
169
216
  */
170
- algorithm?: string;
217
+ algorithm?:
218
+ string;
171
219
  /** ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. */
172
- protectionLevel?: string;
220
+ protectionLevel?:
221
+ string;
173
222
  }
174
223
  interface GoogleCloudKmsV1ExternalProtectionLevelOptions {
175
224
  /** The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. */
176
- ekmConnectionKeyPath?: string;
225
+ ekmConnectionKeyPath?:
226
+ string;
177
227
  /** The URI for an external resource that this CryptoKeyVersion represents. */
178
- externalKeyUri?: string;
228
+ externalKeyUri?:
229
+ string;
179
230
  }
180
231
  interface GoogleCloudKmsV1KeyOperationAttestation {
181
232
  /** Output only. The certificate chains needed to validate the attestation */
182
- certChains?: GoogleCloudKmsV1KeyOperationAttestationCertificateChains;
233
+ certChains?:
234
+ GoogleCloudKmsV1KeyOperationAttestationCertificateChains;
183
235
  /** Output only. The attestation data provided by the HSM when the key operation was performed. */
184
- content?: string;
236
+ content?:
237
+ string;
185
238
  /** Output only. The format of the attestation data. */
186
- format?: string;
239
+ format?:
240
+ string;
187
241
  }
188
242
  interface GoogleCloudKmsV1KeyOperationAttestationCertificateChains {
189
243
  /** Cavium certificate chain corresponding to the attestation. */
190
- caviumCerts?: string[];
244
+ caviumCerts?:
245
+ string[];
191
246
  /** Google card certificate chain corresponding to the attestation. */
192
- googleCardCerts?: string[];
247
+ googleCardCerts?:
248
+ string[];
193
249
  /** Google partition certificate chain corresponding to the attestation. */
194
- googlePartitionCerts?: string[];
250
+ googlePartitionCerts?:
251
+ string[];
195
252
  }
196
253
  interface ProtectedResourcesResource {
197
254
  /** Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization. */
198
255
  search(request?: {
199
256
  /** V1 error format. */
200
- "$.xgafv"?: string;
257
+ "$.xgafv"?:
258
+ string;
201
259
  /** OAuth access token. */
202
- access_token?: string;
260
+ access_token?:
261
+ string;
203
262
  /** Data format for response. */
204
- alt?: string;
263
+ alt?:
264
+ string;
205
265
  /** JSONP */
206
- callback?: string;
266
+ callback?:
267
+ string;
207
268
  /** Required. The resource name of the CryptoKey. */
208
- cryptoKey?: string;
269
+ cryptoKey?:
270
+ string;
209
271
  /** Selector specifying which fields to include in a partial response. */
210
- fields?: string;
272
+ fields?:
273
+ string;
211
274
  /** 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. */
212
- key?: string;
275
+ key?:
276
+ string;
213
277
  /** OAuth 2.0 token for the current user. */
214
- oauth_token?: string;
278
+ oauth_token?:
279
+ string;
215
280
  /**
216
281
  * The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values
217
282
  * above 500 will be coerced to 500.
218
283
  */
219
- pageSize?: number;
284
+ pageSize?:
285
+ number;
220
286
  /**
221
287
  * A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters
222
288
  * provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
223
289
  */
224
- pageToken?: string;
290
+ pageToken?:
291
+ string;
225
292
  /** Returns response with indentations and line breaks. */
226
- prettyPrint?: boolean;
293
+ prettyPrint?:
294
+ boolean;
227
295
  /** 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. */
228
- quotaUser?: string;
296
+ quotaUser?:
297
+ string;
229
298
  /** Required. Resource name of the organization. Example: organizations/123 */
230
- scope: string;
299
+ scope:
300
+ string;
231
301
  /** Upload protocol for media (e.g. "raw", "multipart"). */
232
- upload_protocol?: string;
302
+ upload_protocol?:
303
+ string;
233
304
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
234
- uploadType?: string;
305
+ uploadType?:
306
+ string;
235
307
  }): Request<GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse>;
236
308
  }
237
309
  interface OrganizationsResource {
238
- protectedResources: ProtectedResourcesResource;
310
+ protectedResources:
311
+ ProtectedResourcesResource;
239
312
  }
240
313
  interface CryptoKeysResource {
241
314
  /**
@@ -244,36 +317,50 @@ declare namespace gapi.client {
244
317
  */
245
318
  list(request?: {
246
319
  /** V1 error format. */
247
- "$.xgafv"?: string;
320
+ "$.xgafv"?:
321
+ string;
248
322
  /** OAuth access token. */
249
- access_token?: string;
323
+ access_token?:
324
+ string;
250
325
  /** Data format for response. */
251
- alt?: string;
326
+ alt?:
327
+ string;
252
328
  /** JSONP */
253
- callback?: string;
329
+ callback?:
330
+ string;
254
331
  /** Selector specifying which fields to include in a partial response. */
255
- fields?: string;
332
+ fields?:
333
+ string;
256
334
  /** 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. */
257
- key?: string;
335
+ key?:
336
+ string;
258
337
  /** OAuth 2.0 token for the current user. */
259
- oauth_token?: string;
338
+ oauth_token?:
339
+ string;
260
340
  /**
261
341
  * Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned. The maximum value is 1000;
262
342
  * values above 1000 will be coerced to 1000.
263
343
  */
264
- pageSize?: number;
344
+ pageSize?:
345
+ number;
265
346
  /** Optional. Pass this into a subsequent request in order to receive the next page of results. */
266
- pageToken?: string;
347
+ pageToken?:
348
+ string;
267
349
  /** Required. The Google Cloud project for which to retrieve key metadata, in the format `projects/*` */
268
- parent: string;
350
+ parent:
351
+ string;
269
352
  /** Returns response with indentations and line breaks. */
270
- prettyPrint?: boolean;
353
+ prettyPrint?:
354
+ boolean;
271
355
  /** 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. */
272
- quotaUser?: string;
356
+ quotaUser?:
357
+ string;
273
358
  /** Upload protocol for media (e.g. "raw", "multipart"). */
274
- upload_protocol?: string;
359
+ upload_protocol?:
360
+ string;
275
361
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
276
- uploadType?: string;
362
+ uploadType?:
363
+ string;
277
364
  }): Request<GoogleCloudKmsInventoryV1ListCryptoKeysResponse>;
278
365
  }
279
366
  interface CryptoKeysResource {
@@ -283,40 +370,56 @@ declare namespace gapi.client {
283
370
  */
284
371
  getProtectedResourcesSummary(request?: {
285
372
  /** V1 error format. */
286
- "$.xgafv"?: string;
373
+ "$.xgafv"?:
374
+ string;
287
375
  /** OAuth access token. */
288
- access_token?: string;
376
+ access_token?:
377
+ string;
289
378
  /** Data format for response. */
290
- alt?: string;
379
+ alt?:
380
+ string;
291
381
  /** JSONP */
292
- callback?: string;
382
+ callback?:
383
+ string;
293
384
  /** Selector specifying which fields to include in a partial response. */
294
- fields?: string;
385
+ fields?:
386
+ string;
295
387
  /** 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. */
296
- key?: string;
388
+ key?:
389
+ string;
297
390
  /** Required. The resource name of the CryptoKey. */
298
- name: string;
391
+ name:
392
+ string;
299
393
  /** OAuth 2.0 token for the current user. */
300
- oauth_token?: string;
394
+ oauth_token?:
395
+ string;
301
396
  /** Returns response with indentations and line breaks. */
302
- prettyPrint?: boolean;
397
+ prettyPrint?:
398
+ boolean;
303
399
  /** 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. */
304
- quotaUser?: string;
400
+ quotaUser?:
401
+ string;
305
402
  /** Upload protocol for media (e.g. "raw", "multipart"). */
306
- upload_protocol?: string;
403
+ upload_protocol?:
404
+ string;
307
405
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
308
- uploadType?: string;
406
+ uploadType?:
407
+ string;
309
408
  }): Request<GoogleCloudKmsInventoryV1ProtectedResourcesSummary>;
310
409
  }
311
410
  interface KeyRingsResource {
312
- cryptoKeys: CryptoKeysResource;
411
+ cryptoKeys:
412
+ CryptoKeysResource;
313
413
  }
314
414
  interface LocationsResource {
315
- keyRings: KeyRingsResource;
415
+ keyRings:
416
+ KeyRingsResource;
316
417
  }
317
418
  interface ProjectsResource {
318
- cryptoKeys: CryptoKeysResource;
319
- locations: LocationsResource;
419
+ cryptoKeys:
420
+ CryptoKeysResource;
421
+ locations:
422
+ LocationsResource;
320
423
  }
321
424
 
322
425
  const organizations: OrganizationsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.kmsinventory-v1",
3
- "version": "0.0.20230415",
3
+ "version": "0.0.20230429",
4
4
  "description": "TypeScript typings for KMS Inventory API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230415
6
+ // Revision: 20230429
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */