@maxim_mazurok/gapi.client.cloudkms-v1 0.1.20260116 → 0.1.20260206
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 +143 -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://cloudkms.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260206
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -92,7 +92,9 @@ declare namespace gapi.client {
|
|
|
92
92
|
etag?: string;
|
|
93
93
|
/** Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. */
|
|
94
94
|
keyProject?: string;
|
|
95
|
-
/**
|
|
95
|
+
/** Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. */
|
|
96
|
+
keyProjectResolutionMode?: string;
|
|
97
|
+
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. */
|
|
96
98
|
name?: string;
|
|
97
99
|
/** Output only. The state for the AutokeyConfig. */
|
|
98
100
|
state?: string;
|
|
@@ -358,7 +360,7 @@ declare namespace gapi.client {
|
|
|
358
360
|
attestation?: KeyOperationAttestation;
|
|
359
361
|
/** Output only. The time at which this ImportJob was created. */
|
|
360
362
|
createTime?: string;
|
|
361
|
-
/** Immutable. The resource name of the backend environment where the key material for the wrapping key resides and where all related cryptographic operations are performed. Currently, this field is only populated for keys stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. */
|
|
363
|
+
/** Immutable. The resource name of the backend environment where the key material for the wrapping key resides and where all related cryptographic operations are performed. Currently, this field is only populated for keys stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. Supported resources: * `"projects/*/locations/*/singleTenantHsmInstances/*"` */
|
|
362
364
|
cryptoKeyBackend?: string;
|
|
363
365
|
/** Output only. The time this ImportJob expired. Only present if state is EXPIRED. */
|
|
364
366
|
expireEventTime?: string;
|
|
@@ -467,6 +469,14 @@ declare namespace gapi.client {
|
|
|
467
469
|
/** The standard List next-page token. */
|
|
468
470
|
nextPageToken?: string;
|
|
469
471
|
}
|
|
472
|
+
interface ListRetiredResourcesResponse {
|
|
473
|
+
/** A token to retrieve the next page of results. Pass this value in ListRetiredResourcesRequest.page_token to retrieve the next page of results. */
|
|
474
|
+
nextPageToken?: string;
|
|
475
|
+
/** The list of RetiredResources. */
|
|
476
|
+
retiredResources?: RetiredResource[];
|
|
477
|
+
/** The total number of RetiredResources that matched the query. */
|
|
478
|
+
totalSize?: string;
|
|
479
|
+
}
|
|
470
480
|
interface ListSingleTenantHsmInstanceProposalsResponse {
|
|
471
481
|
/** A token to retrieve next page of results. Pass this value in ListSingleTenantHsmInstanceProposalsRequest.page_token to retrieve the next page of results. */
|
|
472
482
|
nextPageToken?: string;
|
|
@@ -697,6 +707,16 @@ declare namespace gapi.client {
|
|
|
697
707
|
requiredChallengeReplies?: ChallengeReply[];
|
|
698
708
|
}
|
|
699
709
|
interface RestoreCryptoKeyVersionRequest {}
|
|
710
|
+
interface RetiredResource {
|
|
711
|
+
/** Output only. The time at which the original resource was deleted and this RetiredResource record was created. */
|
|
712
|
+
deleteTime?: string;
|
|
713
|
+
/** Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`. */
|
|
714
|
+
name?: string;
|
|
715
|
+
/** Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. */
|
|
716
|
+
originalResource?: string;
|
|
717
|
+
/** Output only. The resource type of the original deleted resource. */
|
|
718
|
+
resourceType?: string;
|
|
719
|
+
}
|
|
700
720
|
interface ServiceResolver {
|
|
701
721
|
/** Optional. The filter applied to the endpoints of the resolved service. If no filter is specified, all endpoints will be considered. An endpoint will be chosen arbitrarily from the filtered list for each request. For endpoint filter syntax and examples, see https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest. */
|
|
702
722
|
endpointFilter?: string;
|
|
@@ -875,7 +895,7 @@ declare namespace gapi.client {
|
|
|
875
895
|
fields?: string;
|
|
876
896
|
/** 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. */
|
|
877
897
|
key?: string;
|
|
878
|
-
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` */
|
|
898
|
+
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. */
|
|
879
899
|
name: string;
|
|
880
900
|
/** OAuth 2.0 token for the current user. */
|
|
881
901
|
oauth_token?: string;
|
|
@@ -906,7 +926,7 @@ declare namespace gapi.client {
|
|
|
906
926
|
fields?: string;
|
|
907
927
|
/** 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. */
|
|
908
928
|
key?: string;
|
|
909
|
-
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` */
|
|
929
|
+
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. */
|
|
910
930
|
name: string;
|
|
911
931
|
/** OAuth 2.0 token for the current user. */
|
|
912
932
|
oauth_token?: string;
|
|
@@ -1829,6 +1849,33 @@ declare namespace gapi.client {
|
|
|
1829
1849
|
},
|
|
1830
1850
|
body: DecapsulateRequest,
|
|
1831
1851
|
): Request<DecapsulateResponse>;
|
|
1852
|
+
/** Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone. */
|
|
1853
|
+
delete(request?: {
|
|
1854
|
+
/** V1 error format. */
|
|
1855
|
+
'$.xgafv'?: string;
|
|
1856
|
+
/** OAuth access token. */
|
|
1857
|
+
access_token?: string;
|
|
1858
|
+
/** Data format for response. */
|
|
1859
|
+
alt?: string;
|
|
1860
|
+
/** JSONP */
|
|
1861
|
+
callback?: string;
|
|
1862
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1863
|
+
fields?: string;
|
|
1864
|
+
/** 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. */
|
|
1865
|
+
key?: string;
|
|
1866
|
+
/** Required. The name of the CryptoKeyVersion to delete. */
|
|
1867
|
+
name: string;
|
|
1868
|
+
/** OAuth 2.0 token for the current user. */
|
|
1869
|
+
oauth_token?: string;
|
|
1870
|
+
/** Returns response with indentations and line breaks. */
|
|
1871
|
+
prettyPrint?: boolean;
|
|
1872
|
+
/** 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. */
|
|
1873
|
+
quotaUser?: string;
|
|
1874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1875
|
+
upload_protocol?: string;
|
|
1876
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1877
|
+
uploadType?: string;
|
|
1878
|
+
}): Request<Operation>;
|
|
1832
1879
|
/** Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process. */
|
|
1833
1880
|
destroy(request: {
|
|
1834
1881
|
/** V1 error format. */
|
|
@@ -2516,6 +2563,33 @@ declare namespace gapi.client {
|
|
|
2516
2563
|
},
|
|
2517
2564
|
body: DecryptRequest,
|
|
2518
2565
|
): Request<DecryptResponse>;
|
|
2566
|
+
/** Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone. */
|
|
2567
|
+
delete(request?: {
|
|
2568
|
+
/** V1 error format. */
|
|
2569
|
+
'$.xgafv'?: string;
|
|
2570
|
+
/** OAuth access token. */
|
|
2571
|
+
access_token?: string;
|
|
2572
|
+
/** Data format for response. */
|
|
2573
|
+
alt?: string;
|
|
2574
|
+
/** JSONP */
|
|
2575
|
+
callback?: string;
|
|
2576
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2577
|
+
fields?: string;
|
|
2578
|
+
/** 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. */
|
|
2579
|
+
key?: string;
|
|
2580
|
+
/** Required. The name of the CryptoKey to delete. */
|
|
2581
|
+
name: string;
|
|
2582
|
+
/** OAuth 2.0 token for the current user. */
|
|
2583
|
+
oauth_token?: string;
|
|
2584
|
+
/** Returns response with indentations and line breaks. */
|
|
2585
|
+
prettyPrint?: boolean;
|
|
2586
|
+
/** 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. */
|
|
2587
|
+
quotaUser?: string;
|
|
2588
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2589
|
+
upload_protocol?: string;
|
|
2590
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2591
|
+
uploadType?: string;
|
|
2592
|
+
}): Request<Operation>;
|
|
2519
2593
|
/** Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. */
|
|
2520
2594
|
encrypt(request: {
|
|
2521
2595
|
/** V1 error format. */
|
|
@@ -3310,6 +3384,66 @@ declare namespace gapi.client {
|
|
|
3310
3384
|
uploadType?: string;
|
|
3311
3385
|
}): Request<Operation>;
|
|
3312
3386
|
}
|
|
3387
|
+
interface RetiredResourcesResource {
|
|
3388
|
+
/** Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey. */
|
|
3389
|
+
get(request?: {
|
|
3390
|
+
/** V1 error format. */
|
|
3391
|
+
'$.xgafv'?: string;
|
|
3392
|
+
/** OAuth access token. */
|
|
3393
|
+
access_token?: string;
|
|
3394
|
+
/** Data format for response. */
|
|
3395
|
+
alt?: string;
|
|
3396
|
+
/** JSONP */
|
|
3397
|
+
callback?: string;
|
|
3398
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3399
|
+
fields?: string;
|
|
3400
|
+
/** 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. */
|
|
3401
|
+
key?: string;
|
|
3402
|
+
/** Required. The name of the RetiredResource to get. */
|
|
3403
|
+
name: string;
|
|
3404
|
+
/** OAuth 2.0 token for the current user. */
|
|
3405
|
+
oauth_token?: string;
|
|
3406
|
+
/** Returns response with indentations and line breaks. */
|
|
3407
|
+
prettyPrint?: boolean;
|
|
3408
|
+
/** 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. */
|
|
3409
|
+
quotaUser?: string;
|
|
3410
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3411
|
+
upload_protocol?: string;
|
|
3412
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3413
|
+
uploadType?: string;
|
|
3414
|
+
}): Request<RetiredResource>;
|
|
3415
|
+
/** Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion. */
|
|
3416
|
+
list(request?: {
|
|
3417
|
+
/** V1 error format. */
|
|
3418
|
+
'$.xgafv'?: string;
|
|
3419
|
+
/** OAuth access token. */
|
|
3420
|
+
access_token?: string;
|
|
3421
|
+
/** Data format for response. */
|
|
3422
|
+
alt?: string;
|
|
3423
|
+
/** JSONP */
|
|
3424
|
+
callback?: string;
|
|
3425
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3426
|
+
fields?: string;
|
|
3427
|
+
/** 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. */
|
|
3428
|
+
key?: string;
|
|
3429
|
+
/** OAuth 2.0 token for the current user. */
|
|
3430
|
+
oauth_token?: string;
|
|
3431
|
+
/** Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */
|
|
3432
|
+
pageSize?: number;
|
|
3433
|
+
/** Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token. */
|
|
3434
|
+
pageToken?: string;
|
|
3435
|
+
/** Required. The project-specific location holding the RetiredResources, in the format `projects/*/locations/*`. */
|
|
3436
|
+
parent: string;
|
|
3437
|
+
/** Returns response with indentations and line breaks. */
|
|
3438
|
+
prettyPrint?: boolean;
|
|
3439
|
+
/** 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. */
|
|
3440
|
+
quotaUser?: string;
|
|
3441
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3442
|
+
upload_protocol?: string;
|
|
3443
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3444
|
+
uploadType?: string;
|
|
3445
|
+
}): Request<ListRetiredResourcesResponse>;
|
|
3446
|
+
}
|
|
3313
3447
|
interface ProposalsResource {
|
|
3314
3448
|
/** Approves a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the PENDING state. */
|
|
3315
3449
|
approve(request: {
|
|
@@ -3823,7 +3957,7 @@ declare namespace gapi.client {
|
|
|
3823
3957
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3824
3958
|
uploadType?: string;
|
|
3825
3959
|
}): Request<EkmConfig>;
|
|
3826
|
-
/** Lists information about the supported locations for this service. */
|
|
3960
|
+
/** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
|
|
3827
3961
|
list(request?: {
|
|
3828
3962
|
/** V1 error format. */
|
|
3829
3963
|
'$.xgafv'?: string;
|
|
@@ -3925,6 +4059,7 @@ declare namespace gapi.client {
|
|
|
3925
4059
|
keyHandles: KeyHandlesResource;
|
|
3926
4060
|
keyRings: KeyRingsResource;
|
|
3927
4061
|
operations: OperationsResource;
|
|
4062
|
+
retiredResources: RetiredResourcesResource;
|
|
3928
4063
|
singleTenantHsmInstances: SingleTenantHsmInstancesResource;
|
|
3929
4064
|
}
|
|
3930
4065
|
interface ProjectsResource {
|
|
@@ -4077,7 +4212,7 @@ declare namespace gapi.client {
|
|
|
4077
4212
|
fields?: string;
|
|
4078
4213
|
/** 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. */
|
|
4079
4214
|
key?: string;
|
|
4080
|
-
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` */
|
|
4215
|
+
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. */
|
|
4081
4216
|
name: string;
|
|
4082
4217
|
/** OAuth 2.0 token for the current user. */
|
|
4083
4218
|
oauth_token?: string;
|
|
@@ -4108,7 +4243,7 @@ declare namespace gapi.client {
|
|
|
4108
4243
|
fields?: string;
|
|
4109
4244
|
/** 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. */
|
|
4110
4245
|
key?: string;
|
|
4111
|
-
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` */
|
|
4246
|
+
/** Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. */
|
|
4112
4247
|
name: string;
|
|
4113
4248
|
/** OAuth 2.0 token for the current user. */
|
|
4114
4249
|
oauth_token?: string;
|