@maxim_mazurok/gapi.client.cloudkms-v1 0.0.20220729
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 +2722 -0
- package/package.json +20 -0
- package/readme.md +71 -0
- package/tests.ts +705 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,2722 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Cloud Key Management Service (KMS) API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/kms/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://cloudkms.googleapis.com/$discovery/rest?version=v1
|
|
13
|
+
// Revision: 20220729
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Cloud Key Management Service (KMS) API v1 */
|
|
19
|
+
function load(urlOrObject: "https://cloudkms.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "cloudkms", version: "v1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "cloudkms", version: "v1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace cloudkms {
|
|
26
|
+
interface AsymmetricDecryptRequest {
|
|
27
|
+
/** Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP. */
|
|
28
|
+
ciphertext?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received
|
|
31
|
+
* AsymmetricDecryptRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client
|
|
32
|
+
* should verify that CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent
|
|
33
|
+
* mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it
|
|
34
|
+
* is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
35
|
+
*/
|
|
36
|
+
ciphertextCrc32c?: string;
|
|
37
|
+
}
|
|
38
|
+
interface AsymmetricDecryptResponse {
|
|
39
|
+
/** The decrypted data originally encrypted with the matching public key. */
|
|
40
|
+
plaintext?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Integrity verification field. A CRC32C checksum of the returned AsymmetricDecryptResponse.plaintext. An integrity check of AsymmetricDecryptResponse.plaintext can be performed by
|
|
43
|
+
* computing the CRC32C checksum of AsymmetricDecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and
|
|
44
|
+
* perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
|
45
|
+
* compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support
|
|
46
|
+
* this type.
|
|
47
|
+
*/
|
|
48
|
+
plaintextCrc32c?: string;
|
|
49
|
+
/** The ProtectionLevel of the CryptoKeyVersion used in decryption. */
|
|
50
|
+
protectionLevel?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Integrity verification field. A flag indicating whether AsymmetricDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of
|
|
53
|
+
* the ciphertext. A false value of this field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If
|
|
54
|
+
* you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
55
|
+
*/
|
|
56
|
+
verifiedCiphertextCrc32c?: boolean;
|
|
57
|
+
}
|
|
58
|
+
interface AsymmetricSignRequest {
|
|
59
|
+
/** Optional. The data to sign. It can't be supplied if AsymmetricSignRequest.digest is supplied. */
|
|
60
|
+
data?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.data
|
|
63
|
+
* using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that
|
|
64
|
+
* CRC32C(AsymmetricSignRequest.data) is equal to AsymmetricSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your
|
|
65
|
+
* computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will
|
|
66
|
+
* never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
67
|
+
*/
|
|
68
|
+
dataCrc32c?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. This field may not be supplied if
|
|
71
|
+
* AsymmetricSignRequest.data is supplied.
|
|
72
|
+
*/
|
|
73
|
+
digest?: Digest;
|
|
74
|
+
/**
|
|
75
|
+
* Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest
|
|
76
|
+
* using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that
|
|
77
|
+
* CRC32C(AsymmetricSignRequest.digest) is equal to AsymmetricSignRequest.digest_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in
|
|
78
|
+
* your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which
|
|
79
|
+
* will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
80
|
+
*/
|
|
81
|
+
digestCrc32c?: string;
|
|
82
|
+
}
|
|
83
|
+
interface AsymmetricSignResponse {
|
|
84
|
+
/** The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing. */
|
|
85
|
+
name?: string;
|
|
86
|
+
/** The ProtectionLevel of the CryptoKeyVersion used for signing. */
|
|
87
|
+
protectionLevel?: string;
|
|
88
|
+
/** The created signature. */
|
|
89
|
+
signature?: string;
|
|
90
|
+
/**
|
|
91
|
+
* Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by
|
|
92
|
+
* computing the CRC32C checksum of AsymmetricSignResponse.signature and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform
|
|
93
|
+
* a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
|
94
|
+
* compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support
|
|
95
|
+
* this type.
|
|
96
|
+
*/
|
|
97
|
+
signatureCrc32c?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Integrity verification field. A flag indicating whether AsymmetricSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A
|
|
100
|
+
* false value of this field indicates either that AsymmetricSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
|
|
101
|
+
* AsymmetricSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
102
|
+
*/
|
|
103
|
+
verifiedDataCrc32c?: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the
|
|
106
|
+
* digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
|
|
107
|
+
* AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
108
|
+
*/
|
|
109
|
+
verifiedDigestCrc32c?: boolean;
|
|
110
|
+
}
|
|
111
|
+
interface AuditConfig {
|
|
112
|
+
/** The configuration for logging of each type of permission. */
|
|
113
|
+
auditLogConfigs?: AuditLogConfig[];
|
|
114
|
+
/**
|
|
115
|
+
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all
|
|
116
|
+
* services.
|
|
117
|
+
*/
|
|
118
|
+
service?: string;
|
|
119
|
+
}
|
|
120
|
+
interface AuditLogConfig {
|
|
121
|
+
/** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
|
|
122
|
+
exemptedMembers?: string[];
|
|
123
|
+
/** The log type that this config enables. */
|
|
124
|
+
logType?: string;
|
|
125
|
+
}
|
|
126
|
+
interface Binding {
|
|
127
|
+
/**
|
|
128
|
+
* 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`,
|
|
129
|
+
* 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
|
|
130
|
+
* resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
131
|
+
*/
|
|
132
|
+
condition?: Expr;
|
|
133
|
+
/**
|
|
134
|
+
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
|
|
135
|
+
* the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service
|
|
136
|
+
* account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
|
|
137
|
+
* represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example,
|
|
138
|
+
* `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
|
|
139
|
+
* `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. *
|
|
140
|
+
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
|
|
141
|
+
* `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
|
|
142
|
+
* account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently
|
|
143
|
+
* deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in
|
|
144
|
+
* the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
|
|
145
|
+
*/
|
|
146
|
+
members?: string[];
|
|
147
|
+
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
|
|
148
|
+
role?: string;
|
|
149
|
+
}
|
|
150
|
+
interface Certificate {
|
|
151
|
+
/** Output only. The issuer distinguished name in RFC 2253 format. Only present if parsed is true. */
|
|
152
|
+
issuer?: string;
|
|
153
|
+
/** Output only. The certificate is not valid after this time. Only present if parsed is true. */
|
|
154
|
+
notAfterTime?: string;
|
|
155
|
+
/** Output only. The certificate is not valid before this time. Only present if parsed is true. */
|
|
156
|
+
notBeforeTime?: string;
|
|
157
|
+
/** Output only. True if the certificate was parsed successfully. */
|
|
158
|
+
parsed?: boolean;
|
|
159
|
+
/** Required. The raw certificate bytes in DER format. */
|
|
160
|
+
rawDer?: string;
|
|
161
|
+
/** Output only. The certificate serial number as a hex string. Only present if parsed is true. */
|
|
162
|
+
serialNumber?: string;
|
|
163
|
+
/** Output only. The SHA-256 certificate fingerprint as a hex string. Only present if parsed is true. */
|
|
164
|
+
sha256Fingerprint?: string;
|
|
165
|
+
/** Output only. The subject distinguished name in RFC 2253 format. Only present if parsed is true. */
|
|
166
|
+
subject?: string;
|
|
167
|
+
/** Output only. The subject Alternative DNS names. Only present if parsed is true. */
|
|
168
|
+
subjectAlternativeDnsNames?: string[];
|
|
169
|
+
}
|
|
170
|
+
interface CertificateChains {
|
|
171
|
+
/** Cavium certificate chain corresponding to the attestation. */
|
|
172
|
+
caviumCerts?: string[];
|
|
173
|
+
/** Google card certificate chain corresponding to the attestation. */
|
|
174
|
+
googleCardCerts?: string[];
|
|
175
|
+
/** Google partition certificate chain corresponding to the attestation. */
|
|
176
|
+
googlePartitionCerts?: string[];
|
|
177
|
+
}
|
|
178
|
+
interface CryptoKey {
|
|
179
|
+
/** Output only. The time at which this CryptoKey was created. */
|
|
180
|
+
createTime?: string;
|
|
181
|
+
/**
|
|
182
|
+
* 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
|
|
183
|
+
* operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format
|
|
184
|
+
* `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.
|
|
185
|
+
*/
|
|
186
|
+
cryptoKeyBackend?: string;
|
|
187
|
+
/**
|
|
188
|
+
* 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
|
|
189
|
+
* duration is 24 hours.
|
|
190
|
+
*/
|
|
191
|
+
destroyScheduledDuration?: string;
|
|
192
|
+
/** Immutable. Whether this key may contain imported versions only. */
|
|
193
|
+
importOnly?: boolean;
|
|
194
|
+
/** Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). */
|
|
195
|
+
labels?: { [P in string]: string };
|
|
196
|
+
/** Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. */
|
|
197
|
+
name?: string;
|
|
198
|
+
/**
|
|
199
|
+
* 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
|
|
200
|
+
* via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this
|
|
201
|
+
* field must be omitted.
|
|
202
|
+
*/
|
|
203
|
+
nextRotationTime?: string;
|
|
204
|
+
/**
|
|
205
|
+
* 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
|
|
206
|
+
* updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
|
|
207
|
+
*/
|
|
208
|
+
primary?: CryptoKeyVersion;
|
|
209
|
+
/** Immutable. The immutable purpose of this CryptoKey. */
|
|
210
|
+
purpose?: string;
|
|
211
|
+
/**
|
|
212
|
+
* 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,
|
|
213
|
+
* next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
|
|
214
|
+
*/
|
|
215
|
+
rotationPeriod?: string;
|
|
216
|
+
/**
|
|
217
|
+
* A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are
|
|
218
|
+
* controlled by this template.
|
|
219
|
+
*/
|
|
220
|
+
versionTemplate?: CryptoKeyVersionTemplate;
|
|
221
|
+
}
|
|
222
|
+
interface CryptoKeyVersion {
|
|
223
|
+
/** Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. */
|
|
224
|
+
algorithm?: string;
|
|
225
|
+
/**
|
|
226
|
+
* 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
|
|
227
|
+
* Google. Only provided for key versions with protection_level HSM.
|
|
228
|
+
*/
|
|
229
|
+
attestation?: KeyOperationAttestation;
|
|
230
|
+
/** Output only. The time at which this CryptoKeyVersion was created. */
|
|
231
|
+
createTime?: string;
|
|
232
|
+
/** Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. */
|
|
233
|
+
destroyEventTime?: string;
|
|
234
|
+
/** Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. */
|
|
235
|
+
destroyTime?: string;
|
|
236
|
+
/**
|
|
237
|
+
* ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection
|
|
238
|
+
* levels.
|
|
239
|
+
*/
|
|
240
|
+
externalProtectionLevelOptions?: ExternalProtectionLevelOptions;
|
|
241
|
+
/** Output only. The time this CryptoKeyVersion's key material was generated. */
|
|
242
|
+
generateTime?: string;
|
|
243
|
+
/** Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. */
|
|
244
|
+
importFailureReason?: string;
|
|
245
|
+
/** 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. */
|
|
246
|
+
importJob?: string;
|
|
247
|
+
/** Output only. The time at which this CryptoKeyVersion's key material was most recently imported. */
|
|
248
|
+
importTime?: string;
|
|
249
|
+
/** Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. */
|
|
250
|
+
name?: string;
|
|
251
|
+
/** Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. */
|
|
252
|
+
protectionLevel?: string;
|
|
253
|
+
/** Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. */
|
|
254
|
+
reimportEligible?: boolean;
|
|
255
|
+
/** The current state of the CryptoKeyVersion. */
|
|
256
|
+
state?: string;
|
|
257
|
+
}
|
|
258
|
+
interface CryptoKeyVersionTemplate {
|
|
259
|
+
/**
|
|
260
|
+
* 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
|
|
261
|
+
* and CryptoKey.purpose is ENCRYPT_DECRYPT.
|
|
262
|
+
*/
|
|
263
|
+
algorithm?: string;
|
|
264
|
+
/** ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. */
|
|
265
|
+
protectionLevel?: string;
|
|
266
|
+
}
|
|
267
|
+
interface DecryptRequest {
|
|
268
|
+
/** Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. */
|
|
269
|
+
additionalAuthenticatedData?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received
|
|
272
|
+
* DecryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your
|
|
273
|
+
* client should verify that CRC32C(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.additional_authenticated_data_crc32c, and if so, perform a limited number
|
|
274
|
+
* of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across
|
|
275
|
+
* different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
276
|
+
*/
|
|
277
|
+
additionalAuthenticatedDataCrc32c?: string;
|
|
278
|
+
/** Required. The encrypted data originally returned in EncryptResponse.ciphertext. */
|
|
279
|
+
ciphertext?: string;
|
|
280
|
+
/**
|
|
281
|
+
* Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.ciphertext using
|
|
282
|
+
* this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that
|
|
283
|
+
* CRC32C(DecryptRequest.ciphertext) is equal to DecryptRequest.ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your
|
|
284
|
+
* computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will
|
|
285
|
+
* never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
286
|
+
*/
|
|
287
|
+
ciphertextCrc32c?: string;
|
|
288
|
+
}
|
|
289
|
+
interface DecryptResponse {
|
|
290
|
+
/** The decrypted data originally supplied in EncryptRequest.plaintext. */
|
|
291
|
+
plaintext?: string;
|
|
292
|
+
/**
|
|
293
|
+
* Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C
|
|
294
|
+
* checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of
|
|
295
|
+
* retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to
|
|
296
|
+
* successfully decrypt the ciphertext. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will
|
|
297
|
+
* never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
298
|
+
*/
|
|
299
|
+
plaintextCrc32c?: string;
|
|
300
|
+
/** The ProtectionLevel of the CryptoKeyVersion used in decryption. */
|
|
301
|
+
protectionLevel?: string;
|
|
302
|
+
/** Whether the Decryption was performed using the primary key version. */
|
|
303
|
+
usedPrimary?: boolean;
|
|
304
|
+
}
|
|
305
|
+
// tslint:disable-next-line:no-empty-interface
|
|
306
|
+
interface DestroyCryptoKeyVersionRequest {
|
|
307
|
+
}
|
|
308
|
+
interface Digest {
|
|
309
|
+
/** A message digest produced with the SHA-256 algorithm. */
|
|
310
|
+
sha256?: string;
|
|
311
|
+
/** A message digest produced with the SHA-384 algorithm. */
|
|
312
|
+
sha384?: string;
|
|
313
|
+
/** A message digest produced with the SHA-512 algorithm. */
|
|
314
|
+
sha512?: string;
|
|
315
|
+
}
|
|
316
|
+
interface EkmConnection {
|
|
317
|
+
/** Output only. The time at which the EkmConnection was created. */
|
|
318
|
+
createTime?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update requests to ensure the client has an up-to-date value before
|
|
321
|
+
* proceeding.
|
|
322
|
+
*/
|
|
323
|
+
etag?: string;
|
|
324
|
+
/** Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. */
|
|
325
|
+
name?: string;
|
|
326
|
+
/** A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. */
|
|
327
|
+
serviceResolvers?: ServiceResolver[];
|
|
328
|
+
}
|
|
329
|
+
interface EncryptRequest {
|
|
330
|
+
/**
|
|
331
|
+
* Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key
|
|
332
|
+
* version's protection_level. For SOFTWARE, EXTERNAL, and EXTERNAL_VPC keys the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and
|
|
333
|
+
* additional_authenticated_data fields must be no larger than 8KiB.
|
|
334
|
+
*/
|
|
335
|
+
additionalAuthenticatedData?: string;
|
|
336
|
+
/**
|
|
337
|
+
* Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received
|
|
338
|
+
* EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your
|
|
339
|
+
* client should verify that CRC32C(EncryptRequest.additional_authenticated_data) is equal to EncryptRequest.additional_authenticated_data_crc32c, and if so, perform a limited number
|
|
340
|
+
* of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across
|
|
341
|
+
* different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
342
|
+
*/
|
|
343
|
+
additionalAuthenticatedDataCrc32c?: string;
|
|
344
|
+
/**
|
|
345
|
+
* Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE, EXTERNAL, and EXTERNAL_VPC keys, the
|
|
346
|
+
* plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
|
|
347
|
+
*/
|
|
348
|
+
plaintext?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using
|
|
351
|
+
* this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that
|
|
352
|
+
* CRC32C(EncryptRequest.plaintext) is equal to EncryptRequest.plaintext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your
|
|
353
|
+
* computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will
|
|
354
|
+
* never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
355
|
+
*/
|
|
356
|
+
plaintextCrc32c?: string;
|
|
357
|
+
}
|
|
358
|
+
interface EncryptResponse {
|
|
359
|
+
/** The encrypted data. */
|
|
360
|
+
ciphertext?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C
|
|
363
|
+
* checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of
|
|
364
|
+
* retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different
|
|
365
|
+
* languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
366
|
+
*/
|
|
367
|
+
ciphertextCrc32c?: string;
|
|
368
|
+
/** The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption. */
|
|
369
|
+
name?: string;
|
|
370
|
+
/** The ProtectionLevel of the CryptoKeyVersion used in encryption. */
|
|
371
|
+
protectionLevel?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity
|
|
374
|
+
* verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to
|
|
375
|
+
* KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
376
|
+
*/
|
|
377
|
+
verifiedAdditionalAuthenticatedDataCrc32c?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the
|
|
380
|
+
* plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
|
|
381
|
+
* EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
382
|
+
*/
|
|
383
|
+
verifiedPlaintextCrc32c?: boolean;
|
|
384
|
+
}
|
|
385
|
+
interface Expr {
|
|
386
|
+
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
387
|
+
description?: string;
|
|
388
|
+
/** Textual representation of an expression in Common Expression Language syntax. */
|
|
389
|
+
expression?: string;
|
|
390
|
+
/** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
|
|
391
|
+
location?: string;
|
|
392
|
+
/** 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. */
|
|
393
|
+
title?: string;
|
|
394
|
+
}
|
|
395
|
+
interface ExternalProtectionLevelOptions {
|
|
396
|
+
/** 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. */
|
|
397
|
+
ekmConnectionKeyPath?: string;
|
|
398
|
+
/** The URI for an external resource that this CryptoKeyVersion represents. */
|
|
399
|
+
externalKeyUri?: string;
|
|
400
|
+
}
|
|
401
|
+
interface GenerateRandomBytesRequest {
|
|
402
|
+
/** The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes. */
|
|
403
|
+
lengthBytes?: number;
|
|
404
|
+
/** The ProtectionLevel to use when generating the random data. Currently, only HSM protection level is supported. */
|
|
405
|
+
protectionLevel?: string;
|
|
406
|
+
}
|
|
407
|
+
interface GenerateRandomBytesResponse {
|
|
408
|
+
/** The generated data. */
|
|
409
|
+
data?: string;
|
|
410
|
+
/**
|
|
411
|
+
* Integrity verification field. A CRC32C checksum of the returned GenerateRandomBytesResponse.data. An integrity check of GenerateRandomBytesResponse.data can be performed by
|
|
412
|
+
* computing the CRC32C checksum of GenerateRandomBytesResponse.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform
|
|
413
|
+
* a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of
|
|
414
|
+
* compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support
|
|
415
|
+
* this type.
|
|
416
|
+
*/
|
|
417
|
+
dataCrc32c?: string;
|
|
418
|
+
}
|
|
419
|
+
interface ImportCryptoKeyVersionRequest {
|
|
420
|
+
/** Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. */
|
|
421
|
+
algorithm?: string;
|
|
422
|
+
/**
|
|
423
|
+
* Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key
|
|
424
|
+
* material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the
|
|
425
|
+
* CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The
|
|
426
|
+
* key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.
|
|
427
|
+
*/
|
|
428
|
+
cryptoKeyVersion?: string;
|
|
429
|
+
/** Required. The name of the ImportJob that was used to wrap this key material. */
|
|
430
|
+
importJob?: string;
|
|
431
|
+
/** Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified. */
|
|
432
|
+
rsaAesWrappedKey?: string;
|
|
433
|
+
/**
|
|
434
|
+
* Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes.
|
|
435
|
+
* If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods
|
|
436
|
+
* (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An
|
|
437
|
+
* ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported,
|
|
438
|
+
* wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import
|
|
439
|
+
* methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1
|
|
440
|
+
* with SHA-256, and an empty label.
|
|
441
|
+
*/
|
|
442
|
+
wrappedKey?: string;
|
|
443
|
+
}
|
|
444
|
+
interface ImportJob {
|
|
445
|
+
/**
|
|
446
|
+
* Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on
|
|
447
|
+
* the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.
|
|
448
|
+
*/
|
|
449
|
+
attestation?: KeyOperationAttestation;
|
|
450
|
+
/** Output only. The time at which this ImportJob was created. */
|
|
451
|
+
createTime?: string;
|
|
452
|
+
/** Output only. The time this ImportJob expired. Only present if state is EXPIRED. */
|
|
453
|
+
expireEventTime?: string;
|
|
454
|
+
/** Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. */
|
|
455
|
+
expireTime?: string;
|
|
456
|
+
/** Output only. The time this ImportJob's key material was generated. */
|
|
457
|
+
generateTime?: string;
|
|
458
|
+
/** Required. Immutable. The wrapping method to be used for incoming key material. */
|
|
459
|
+
importMethod?: string;
|
|
460
|
+
/** Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. */
|
|
461
|
+
name?: string;
|
|
462
|
+
/** Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. */
|
|
463
|
+
protectionLevel?: string;
|
|
464
|
+
/** Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. */
|
|
465
|
+
publicKey?: WrappingPublicKey;
|
|
466
|
+
/** Output only. The current state of the ImportJob, indicating if it can be used. */
|
|
467
|
+
state?: string;
|
|
468
|
+
}
|
|
469
|
+
interface KeyOperationAttestation {
|
|
470
|
+
/** Output only. The certificate chains needed to validate the attestation */
|
|
471
|
+
certChains?: CertificateChains;
|
|
472
|
+
/** Output only. The attestation data provided by the HSM when the key operation was performed. */
|
|
473
|
+
content?: string;
|
|
474
|
+
/** Output only. The format of the attestation data. */
|
|
475
|
+
format?: string;
|
|
476
|
+
}
|
|
477
|
+
interface KeyRing {
|
|
478
|
+
/** Output only. The time at which this KeyRing was created. */
|
|
479
|
+
createTime?: string;
|
|
480
|
+
/** Output only. The resource name for the KeyRing in the format `projects/*/locations/*/keyRings/*`. */
|
|
481
|
+
name?: string;
|
|
482
|
+
}
|
|
483
|
+
interface ListCryptoKeysResponse {
|
|
484
|
+
/** The list of CryptoKeys. */
|
|
485
|
+
cryptoKeys?: CryptoKey[];
|
|
486
|
+
/** A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results. */
|
|
487
|
+
nextPageToken?: string;
|
|
488
|
+
/** The total number of CryptoKeys that matched the query. */
|
|
489
|
+
totalSize?: number;
|
|
490
|
+
}
|
|
491
|
+
interface ListCryptoKeyVersionsResponse {
|
|
492
|
+
/** The list of CryptoKeyVersions. */
|
|
493
|
+
cryptoKeyVersions?: CryptoKeyVersion[];
|
|
494
|
+
/** A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. */
|
|
495
|
+
nextPageToken?: string;
|
|
496
|
+
/** The total number of CryptoKeyVersions that matched the query. */
|
|
497
|
+
totalSize?: number;
|
|
498
|
+
}
|
|
499
|
+
interface ListEkmConnectionsResponse {
|
|
500
|
+
/** The list of EkmConnections. */
|
|
501
|
+
ekmConnections?: EkmConnection[];
|
|
502
|
+
/** A token to retrieve next page of results. Pass this value in ListEkmConnectionsRequest.page_token to retrieve the next page of results. */
|
|
503
|
+
nextPageToken?: string;
|
|
504
|
+
/** The total number of EkmConnections that matched the query. */
|
|
505
|
+
totalSize?: number;
|
|
506
|
+
}
|
|
507
|
+
interface ListImportJobsResponse {
|
|
508
|
+
/** The list of ImportJobs. */
|
|
509
|
+
importJobs?: ImportJob[];
|
|
510
|
+
/** A token to retrieve next page of results. Pass this value in ListImportJobsRequest.page_token to retrieve the next page of results. */
|
|
511
|
+
nextPageToken?: string;
|
|
512
|
+
/** The total number of ImportJobs that matched the query. */
|
|
513
|
+
totalSize?: number;
|
|
514
|
+
}
|
|
515
|
+
interface ListKeyRingsResponse {
|
|
516
|
+
/** The list of KeyRings. */
|
|
517
|
+
keyRings?: KeyRing[];
|
|
518
|
+
/** A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results. */
|
|
519
|
+
nextPageToken?: string;
|
|
520
|
+
/** The total number of KeyRings that matched the query. */
|
|
521
|
+
totalSize?: number;
|
|
522
|
+
}
|
|
523
|
+
interface ListLocationsResponse {
|
|
524
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
525
|
+
locations?: Location[];
|
|
526
|
+
/** The standard List next-page token. */
|
|
527
|
+
nextPageToken?: string;
|
|
528
|
+
}
|
|
529
|
+
interface Location {
|
|
530
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
531
|
+
displayName?: string;
|
|
532
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
533
|
+
labels?: { [P in string]: string };
|
|
534
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
535
|
+
locationId?: string;
|
|
536
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
537
|
+
metadata?: { [P in string]: any };
|
|
538
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
539
|
+
name?: string;
|
|
540
|
+
}
|
|
541
|
+
interface LocationMetadata {
|
|
542
|
+
/** Indicates whether CryptoKeys with protection_level EXTERNAL can be created in this location. */
|
|
543
|
+
ekmAvailable?: boolean;
|
|
544
|
+
/** Indicates whether CryptoKeys with protection_level HSM can be created in this location. */
|
|
545
|
+
hsmAvailable?: boolean;
|
|
546
|
+
}
|
|
547
|
+
interface MacSignRequest {
|
|
548
|
+
/** Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm. */
|
|
549
|
+
data?: string;
|
|
550
|
+
/**
|
|
551
|
+
* Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this
|
|
552
|
+
* checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data)
|
|
553
|
+
* is equal to MacSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note:
|
|
554
|
+
* This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely
|
|
555
|
+
* downconverted to uint32 in languages that support this type.
|
|
556
|
+
*/
|
|
557
|
+
dataCrc32c?: string;
|
|
558
|
+
}
|
|
559
|
+
interface MacSignResponse {
|
|
560
|
+
/** The created signature. */
|
|
561
|
+
mac?: string;
|
|
562
|
+
/**
|
|
563
|
+
* Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of
|
|
564
|
+
* MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent
|
|
565
|
+
* mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it
|
|
566
|
+
* is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
|
|
567
|
+
*/
|
|
568
|
+
macCrc32c?: string;
|
|
569
|
+
/** The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing. */
|
|
570
|
+
name?: string;
|
|
571
|
+
/** The ProtectionLevel of the CryptoKeyVersion used for signing. */
|
|
572
|
+
protectionLevel?: string;
|
|
573
|
+
/**
|
|
574
|
+
* Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false
|
|
575
|
+
* value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c
|
|
576
|
+
* but this field is still false, discard the response and perform a limited number of retries.
|
|
577
|
+
*/
|
|
578
|
+
verifiedDataCrc32c?: boolean;
|
|
579
|
+
}
|
|
580
|
+
interface MacVerifyRequest {
|
|
581
|
+
/** Required. The data used previously as a MacSignRequest.data to generate the MAC tag. */
|
|
582
|
+
data?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Optional. An optional CRC32C checksum of the MacVerifyRequest.data. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.data using this
|
|
585
|
+
* checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.data)
|
|
586
|
+
* is equal to MacVerifyRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum.
|
|
587
|
+
* Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be
|
|
588
|
+
* safely downconverted to uint32 in languages that support this type.
|
|
589
|
+
*/
|
|
590
|
+
dataCrc32c?: string;
|
|
591
|
+
/** Required. The signature to verify. */
|
|
592
|
+
mac?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Optional. An optional CRC32C checksum of the MacVerifyRequest.mac. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.mac using this
|
|
595
|
+
* checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.tag)
|
|
596
|
+
* is equal to MacVerifyRequest.mac_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum.
|
|
597
|
+
* Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be
|
|
598
|
+
* safely downconverted to uint32 in languages that support this type.
|
|
599
|
+
*/
|
|
600
|
+
macCrc32c?: string;
|
|
601
|
+
}
|
|
602
|
+
interface MacVerifyResponse {
|
|
603
|
+
/** The resource name of the CryptoKeyVersion used for verification. Check this field to verify that the intended resource was used for verification. */
|
|
604
|
+
name?: string;
|
|
605
|
+
/** The ProtectionLevel of the CryptoKeyVersion used for verification. */
|
|
606
|
+
protectionLevel?: string;
|
|
607
|
+
/** This field indicates whether or not the verification operation for MacVerifyRequest.mac over MacVerifyRequest.data was successful. */
|
|
608
|
+
success?: boolean;
|
|
609
|
+
/**
|
|
610
|
+
* Integrity verification field. A flag indicating whether MacVerifyRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A
|
|
611
|
+
* false value of this field indicates either that MacVerifyRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set
|
|
612
|
+
* MacVerifyRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.
|
|
613
|
+
*/
|
|
614
|
+
verifiedDataCrc32c?: boolean;
|
|
615
|
+
/**
|
|
616
|
+
* Integrity verification field. A flag indicating whether MacVerifyRequest.mac_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false
|
|
617
|
+
* value of this field indicates either that MacVerifyRequest.mac_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacVerifyRequest.mac_crc32c
|
|
618
|
+
* but this field is still false, discard the response and perform a limited number of retries.
|
|
619
|
+
*/
|
|
620
|
+
verifiedMacCrc32c?: boolean;
|
|
621
|
+
/**
|
|
622
|
+
* Integrity verification field. This value is used for the integrity verification of [MacVerifyResponse.success]. If the value of this field contradicts the value of
|
|
623
|
+
* [MacVerifyResponse.success], discard the response and perform a limited number of retries.
|
|
624
|
+
*/
|
|
625
|
+
verifiedSuccessIntegrity?: boolean;
|
|
626
|
+
}
|
|
627
|
+
interface Policy {
|
|
628
|
+
/** Specifies cloud audit logging configuration for this policy. */
|
|
629
|
+
auditConfigs?: AuditConfig[];
|
|
630
|
+
/**
|
|
631
|
+
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
|
|
632
|
+
* must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
|
|
633
|
+
* principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
|
|
634
|
+
* 1,450 principals to the `bindings` in the `Policy`.
|
|
635
|
+
*/
|
|
636
|
+
bindings?: Binding[];
|
|
637
|
+
/**
|
|
638
|
+
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make
|
|
639
|
+
* use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems
|
|
640
|
+
* are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM
|
|
641
|
+
* Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
642
|
+
* policy, and all of the conditions in the version `3` policy are lost.
|
|
643
|
+
*/
|
|
644
|
+
etag?: string;
|
|
645
|
+
/**
|
|
646
|
+
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
|
|
647
|
+
* must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
|
|
648
|
+
* policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
|
|
649
|
+
* IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
650
|
+
* policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
|
|
651
|
+
* the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
652
|
+
*/
|
|
653
|
+
version?: number;
|
|
654
|
+
}
|
|
655
|
+
interface PublicKey {
|
|
656
|
+
/** The Algorithm associated with this key. */
|
|
657
|
+
algorithm?: string;
|
|
658
|
+
/** The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. */
|
|
659
|
+
name?: string;
|
|
660
|
+
/**
|
|
661
|
+
* The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General
|
|
662
|
+
* Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).
|
|
663
|
+
*/
|
|
664
|
+
pem?: string;
|
|
665
|
+
/**
|
|
666
|
+
* Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem
|
|
667
|
+
* and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate
|
|
668
|
+
* an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative
|
|
669
|
+
* integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.
|
|
670
|
+
*/
|
|
671
|
+
pemCrc32c?: string;
|
|
672
|
+
/** The ProtectionLevel of the CryptoKeyVersion public key. */
|
|
673
|
+
protectionLevel?: string;
|
|
674
|
+
}
|
|
675
|
+
// tslint:disable-next-line:no-empty-interface
|
|
676
|
+
interface RestoreCryptoKeyVersionRequest {
|
|
677
|
+
}
|
|
678
|
+
interface ServiceResolver {
|
|
679
|
+
/**
|
|
680
|
+
* 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
|
|
681
|
+
* filtered list for each request. For endpoint filter syntax and examples, see
|
|
682
|
+
* https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.
|
|
683
|
+
*/
|
|
684
|
+
endpointFilter?: string;
|
|
685
|
+
/** Required. The hostname of the EKM replica used at TLS and HTTP layers. */
|
|
686
|
+
hostname?: string;
|
|
687
|
+
/** Required. A list of leaf server certificates used to authenticate HTTPS connections to the EKM replica. Currently, a maximum of 10 Certificate is supported. */
|
|
688
|
+
serverCertificates?: Certificate[];
|
|
689
|
+
/** Required. The resource name of the Service Directory service pointing to an EKM replica, in the format `projects/*/locations/*/namespaces/*/services/*`. */
|
|
690
|
+
serviceDirectoryService?: string;
|
|
691
|
+
}
|
|
692
|
+
interface SetIamPolicyRequest {
|
|
693
|
+
/**
|
|
694
|
+
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
|
|
695
|
+
* services (such as Projects) might reject them.
|
|
696
|
+
*/
|
|
697
|
+
policy?: Policy;
|
|
698
|
+
/**
|
|
699
|
+
* 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:
|
|
700
|
+
* `paths: "bindings, etag"`
|
|
701
|
+
*/
|
|
702
|
+
updateMask?: string;
|
|
703
|
+
}
|
|
704
|
+
interface TestIamPermissionsRequest {
|
|
705
|
+
/**
|
|
706
|
+
* The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
|
|
707
|
+
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
|
708
|
+
*/
|
|
709
|
+
permissions?: string[];
|
|
710
|
+
}
|
|
711
|
+
interface TestIamPermissionsResponse {
|
|
712
|
+
/** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
|
|
713
|
+
permissions?: string[];
|
|
714
|
+
}
|
|
715
|
+
interface UpdateCryptoKeyPrimaryVersionRequest {
|
|
716
|
+
/** Required. The id of the child CryptoKeyVersion to use as primary. */
|
|
717
|
+
cryptoKeyVersionId?: string;
|
|
718
|
+
}
|
|
719
|
+
interface WrappingPublicKey {
|
|
720
|
+
/**
|
|
721
|
+
* The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General
|
|
722
|
+
* Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).
|
|
723
|
+
*/
|
|
724
|
+
pem?: string;
|
|
725
|
+
}
|
|
726
|
+
interface EkmConnectionsResource {
|
|
727
|
+
/** Creates a new EkmConnection in a given Project and Location. */
|
|
728
|
+
create(request: {
|
|
729
|
+
/** V1 error format. */
|
|
730
|
+
"$.xgafv"?: string;
|
|
731
|
+
/** OAuth access token. */
|
|
732
|
+
access_token?: string;
|
|
733
|
+
/** Data format for response. */
|
|
734
|
+
alt?: string;
|
|
735
|
+
/** JSONP */
|
|
736
|
+
callback?: string;
|
|
737
|
+
/** Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. */
|
|
738
|
+
ekmConnectionId?: string;
|
|
739
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
740
|
+
fields?: string;
|
|
741
|
+
/** 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. */
|
|
742
|
+
key?: string;
|
|
743
|
+
/** OAuth 2.0 token for the current user. */
|
|
744
|
+
oauth_token?: string;
|
|
745
|
+
/** Required. The resource name of the location associated with the EkmConnection, in the format `projects/*/locations/*`. */
|
|
746
|
+
parent: string;
|
|
747
|
+
/** Returns response with indentations and line breaks. */
|
|
748
|
+
prettyPrint?: boolean;
|
|
749
|
+
/** 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. */
|
|
750
|
+
quotaUser?: string;
|
|
751
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
752
|
+
upload_protocol?: string;
|
|
753
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
754
|
+
uploadType?: string;
|
|
755
|
+
/** Request body */
|
|
756
|
+
resource: EkmConnection;
|
|
757
|
+
}): Request<EkmConnection>;
|
|
758
|
+
create(request: {
|
|
759
|
+
/** V1 error format. */
|
|
760
|
+
"$.xgafv"?: string;
|
|
761
|
+
/** OAuth access token. */
|
|
762
|
+
access_token?: string;
|
|
763
|
+
/** Data format for response. */
|
|
764
|
+
alt?: string;
|
|
765
|
+
/** JSONP */
|
|
766
|
+
callback?: string;
|
|
767
|
+
/** Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. */
|
|
768
|
+
ekmConnectionId?: string;
|
|
769
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
770
|
+
fields?: string;
|
|
771
|
+
/** 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. */
|
|
772
|
+
key?: string;
|
|
773
|
+
/** OAuth 2.0 token for the current user. */
|
|
774
|
+
oauth_token?: string;
|
|
775
|
+
/** Required. The resource name of the location associated with the EkmConnection, in the format `projects/*/locations/*`. */
|
|
776
|
+
parent: string;
|
|
777
|
+
/** Returns response with indentations and line breaks. */
|
|
778
|
+
prettyPrint?: boolean;
|
|
779
|
+
/** 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. */
|
|
780
|
+
quotaUser?: string;
|
|
781
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
782
|
+
upload_protocol?: string;
|
|
783
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
784
|
+
uploadType?: string;
|
|
785
|
+
},
|
|
786
|
+
body: EkmConnection): Request<EkmConnection>;
|
|
787
|
+
/** Returns metadata for a given EkmConnection. */
|
|
788
|
+
get(request?: {
|
|
789
|
+
/** V1 error format. */
|
|
790
|
+
"$.xgafv"?: string;
|
|
791
|
+
/** OAuth access token. */
|
|
792
|
+
access_token?: string;
|
|
793
|
+
/** Data format for response. */
|
|
794
|
+
alt?: string;
|
|
795
|
+
/** JSONP */
|
|
796
|
+
callback?: string;
|
|
797
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
798
|
+
fields?: string;
|
|
799
|
+
/** 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. */
|
|
800
|
+
key?: string;
|
|
801
|
+
/** Required. The name of the EkmConnection to get. */
|
|
802
|
+
name: string;
|
|
803
|
+
/** OAuth 2.0 token for the current user. */
|
|
804
|
+
oauth_token?: string;
|
|
805
|
+
/** Returns response with indentations and line breaks. */
|
|
806
|
+
prettyPrint?: boolean;
|
|
807
|
+
/** 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. */
|
|
808
|
+
quotaUser?: string;
|
|
809
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
810
|
+
upload_protocol?: string;
|
|
811
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
812
|
+
uploadType?: string;
|
|
813
|
+
}): Request<EkmConnection>;
|
|
814
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
815
|
+
getIamPolicy(request?: {
|
|
816
|
+
/** V1 error format. */
|
|
817
|
+
"$.xgafv"?: string;
|
|
818
|
+
/** OAuth access token. */
|
|
819
|
+
access_token?: string;
|
|
820
|
+
/** Data format for response. */
|
|
821
|
+
alt?: string;
|
|
822
|
+
/** JSONP */
|
|
823
|
+
callback?: string;
|
|
824
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
825
|
+
fields?: string;
|
|
826
|
+
/** 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. */
|
|
827
|
+
key?: string;
|
|
828
|
+
/** OAuth 2.0 token for the current user. */
|
|
829
|
+
oauth_token?: string;
|
|
830
|
+
/**
|
|
831
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
832
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
|
|
833
|
+
* in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
|
|
834
|
+
* role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
835
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
836
|
+
*/
|
|
837
|
+
"options.requestedPolicyVersion"?: number;
|
|
838
|
+
/** Returns response with indentations and line breaks. */
|
|
839
|
+
prettyPrint?: boolean;
|
|
840
|
+
/** 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. */
|
|
841
|
+
quotaUser?: string;
|
|
842
|
+
/**
|
|
843
|
+
* 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
|
|
844
|
+
* field.
|
|
845
|
+
*/
|
|
846
|
+
resource: string;
|
|
847
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
848
|
+
upload_protocol?: string;
|
|
849
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
850
|
+
uploadType?: string;
|
|
851
|
+
}): Request<Policy>;
|
|
852
|
+
/** Lists EkmConnections. */
|
|
853
|
+
list(request?: {
|
|
854
|
+
/** V1 error format. */
|
|
855
|
+
"$.xgafv"?: string;
|
|
856
|
+
/** OAuth access token. */
|
|
857
|
+
access_token?: string;
|
|
858
|
+
/** Data format for response. */
|
|
859
|
+
alt?: string;
|
|
860
|
+
/** JSONP */
|
|
861
|
+
callback?: string;
|
|
862
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
863
|
+
fields?: string;
|
|
864
|
+
/**
|
|
865
|
+
* Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
|
|
866
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
867
|
+
*/
|
|
868
|
+
filter?: string;
|
|
869
|
+
/** 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. */
|
|
870
|
+
key?: string;
|
|
871
|
+
/** OAuth 2.0 token for the current user. */
|
|
872
|
+
oauth_token?: string;
|
|
873
|
+
/**
|
|
874
|
+
* Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
|
|
875
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
876
|
+
*/
|
|
877
|
+
orderBy?: string;
|
|
878
|
+
/**
|
|
879
|
+
* Optional. Optional limit on the number of EkmConnections to include in the response. Further EkmConnections can subsequently be obtained by including the
|
|
880
|
+
* ListEkmConnectionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
|
881
|
+
*/
|
|
882
|
+
pageSize?: number;
|
|
883
|
+
/** Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token. */
|
|
884
|
+
pageToken?: string;
|
|
885
|
+
/** Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/*/locations/*`. */
|
|
886
|
+
parent: string;
|
|
887
|
+
/** Returns response with indentations and line breaks. */
|
|
888
|
+
prettyPrint?: boolean;
|
|
889
|
+
/** 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. */
|
|
890
|
+
quotaUser?: string;
|
|
891
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
892
|
+
upload_protocol?: string;
|
|
893
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
894
|
+
uploadType?: string;
|
|
895
|
+
}): Request<ListEkmConnectionsResponse>;
|
|
896
|
+
/** Updates an EkmConnection's metadata. */
|
|
897
|
+
patch(request: {
|
|
898
|
+
/** V1 error format. */
|
|
899
|
+
"$.xgafv"?: string;
|
|
900
|
+
/** OAuth access token. */
|
|
901
|
+
access_token?: string;
|
|
902
|
+
/** Data format for response. */
|
|
903
|
+
alt?: string;
|
|
904
|
+
/** JSONP */
|
|
905
|
+
callback?: string;
|
|
906
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
907
|
+
fields?: string;
|
|
908
|
+
/** 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. */
|
|
909
|
+
key?: string;
|
|
910
|
+
/** Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. */
|
|
911
|
+
name: string;
|
|
912
|
+
/** OAuth 2.0 token for the current user. */
|
|
913
|
+
oauth_token?: string;
|
|
914
|
+
/** Returns response with indentations and line breaks. */
|
|
915
|
+
prettyPrint?: boolean;
|
|
916
|
+
/** 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. */
|
|
917
|
+
quotaUser?: string;
|
|
918
|
+
/** Required. List of fields to be updated in this request. */
|
|
919
|
+
updateMask?: string;
|
|
920
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
921
|
+
upload_protocol?: string;
|
|
922
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
923
|
+
uploadType?: string;
|
|
924
|
+
/** Request body */
|
|
925
|
+
resource: EkmConnection;
|
|
926
|
+
}): Request<EkmConnection>;
|
|
927
|
+
patch(request: {
|
|
928
|
+
/** V1 error format. */
|
|
929
|
+
"$.xgafv"?: string;
|
|
930
|
+
/** OAuth access token. */
|
|
931
|
+
access_token?: string;
|
|
932
|
+
/** Data format for response. */
|
|
933
|
+
alt?: string;
|
|
934
|
+
/** JSONP */
|
|
935
|
+
callback?: string;
|
|
936
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
937
|
+
fields?: string;
|
|
938
|
+
/** 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. */
|
|
939
|
+
key?: string;
|
|
940
|
+
/** Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. */
|
|
941
|
+
name: string;
|
|
942
|
+
/** OAuth 2.0 token for the current user. */
|
|
943
|
+
oauth_token?: string;
|
|
944
|
+
/** Returns response with indentations and line breaks. */
|
|
945
|
+
prettyPrint?: boolean;
|
|
946
|
+
/** 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. */
|
|
947
|
+
quotaUser?: string;
|
|
948
|
+
/** Required. List of fields to be updated in this request. */
|
|
949
|
+
updateMask?: string;
|
|
950
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
951
|
+
upload_protocol?: string;
|
|
952
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
953
|
+
uploadType?: string;
|
|
954
|
+
},
|
|
955
|
+
body: EkmConnection): Request<EkmConnection>;
|
|
956
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
957
|
+
setIamPolicy(request: {
|
|
958
|
+
/** V1 error format. */
|
|
959
|
+
"$.xgafv"?: string;
|
|
960
|
+
/** OAuth access token. */
|
|
961
|
+
access_token?: string;
|
|
962
|
+
/** Data format for response. */
|
|
963
|
+
alt?: string;
|
|
964
|
+
/** JSONP */
|
|
965
|
+
callback?: string;
|
|
966
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
967
|
+
fields?: string;
|
|
968
|
+
/** 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. */
|
|
969
|
+
key?: string;
|
|
970
|
+
/** OAuth 2.0 token for the current user. */
|
|
971
|
+
oauth_token?: string;
|
|
972
|
+
/** Returns response with indentations and line breaks. */
|
|
973
|
+
prettyPrint?: boolean;
|
|
974
|
+
/** 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. */
|
|
975
|
+
quotaUser?: string;
|
|
976
|
+
/**
|
|
977
|
+
* 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
|
|
978
|
+
* field.
|
|
979
|
+
*/
|
|
980
|
+
resource: string;
|
|
981
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
982
|
+
upload_protocol?: string;
|
|
983
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
984
|
+
uploadType?: string;
|
|
985
|
+
},
|
|
986
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
987
|
+
/**
|
|
988
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
989
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
990
|
+
*/
|
|
991
|
+
testIamPermissions(request: {
|
|
992
|
+
/** V1 error format. */
|
|
993
|
+
"$.xgafv"?: string;
|
|
994
|
+
/** OAuth access token. */
|
|
995
|
+
access_token?: string;
|
|
996
|
+
/** Data format for response. */
|
|
997
|
+
alt?: string;
|
|
998
|
+
/** JSONP */
|
|
999
|
+
callback?: string;
|
|
1000
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1001
|
+
fields?: string;
|
|
1002
|
+
/** 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. */
|
|
1003
|
+
key?: string;
|
|
1004
|
+
/** OAuth 2.0 token for the current user. */
|
|
1005
|
+
oauth_token?: string;
|
|
1006
|
+
/** Returns response with indentations and line breaks. */
|
|
1007
|
+
prettyPrint?: boolean;
|
|
1008
|
+
/** 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. */
|
|
1009
|
+
quotaUser?: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
1012
|
+
* this field.
|
|
1013
|
+
*/
|
|
1014
|
+
resource: string;
|
|
1015
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1016
|
+
upload_protocol?: string;
|
|
1017
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1018
|
+
uploadType?: string;
|
|
1019
|
+
},
|
|
1020
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
1021
|
+
}
|
|
1022
|
+
interface CryptoKeyVersionsResource {
|
|
1023
|
+
/** Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT. */
|
|
1024
|
+
asymmetricDecrypt(request: {
|
|
1025
|
+
/** V1 error format. */
|
|
1026
|
+
"$.xgafv"?: string;
|
|
1027
|
+
/** OAuth access token. */
|
|
1028
|
+
access_token?: string;
|
|
1029
|
+
/** Data format for response. */
|
|
1030
|
+
alt?: string;
|
|
1031
|
+
/** JSONP */
|
|
1032
|
+
callback?: string;
|
|
1033
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1034
|
+
fields?: string;
|
|
1035
|
+
/** 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. */
|
|
1036
|
+
key?: string;
|
|
1037
|
+
/** Required. The resource name of the CryptoKeyVersion to use for decryption. */
|
|
1038
|
+
name: string;
|
|
1039
|
+
/** OAuth 2.0 token for the current user. */
|
|
1040
|
+
oauth_token?: string;
|
|
1041
|
+
/** Returns response with indentations and line breaks. */
|
|
1042
|
+
prettyPrint?: boolean;
|
|
1043
|
+
/** 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. */
|
|
1044
|
+
quotaUser?: string;
|
|
1045
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1046
|
+
upload_protocol?: string;
|
|
1047
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1048
|
+
uploadType?: string;
|
|
1049
|
+
/** Request body */
|
|
1050
|
+
resource: AsymmetricDecryptRequest;
|
|
1051
|
+
}): Request<AsymmetricDecryptResponse>;
|
|
1052
|
+
asymmetricDecrypt(request: {
|
|
1053
|
+
/** V1 error format. */
|
|
1054
|
+
"$.xgafv"?: string;
|
|
1055
|
+
/** OAuth access token. */
|
|
1056
|
+
access_token?: string;
|
|
1057
|
+
/** Data format for response. */
|
|
1058
|
+
alt?: string;
|
|
1059
|
+
/** JSONP */
|
|
1060
|
+
callback?: string;
|
|
1061
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1062
|
+
fields?: string;
|
|
1063
|
+
/** 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. */
|
|
1064
|
+
key?: string;
|
|
1065
|
+
/** Required. The resource name of the CryptoKeyVersion to use for decryption. */
|
|
1066
|
+
name: string;
|
|
1067
|
+
/** OAuth 2.0 token for the current user. */
|
|
1068
|
+
oauth_token?: string;
|
|
1069
|
+
/** Returns response with indentations and line breaks. */
|
|
1070
|
+
prettyPrint?: boolean;
|
|
1071
|
+
/** 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. */
|
|
1072
|
+
quotaUser?: string;
|
|
1073
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1074
|
+
upload_protocol?: string;
|
|
1075
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1076
|
+
uploadType?: string;
|
|
1077
|
+
},
|
|
1078
|
+
body: AsymmetricDecryptRequest): Request<AsymmetricDecryptResponse>;
|
|
1079
|
+
/** Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey. */
|
|
1080
|
+
asymmetricSign(request: {
|
|
1081
|
+
/** V1 error format. */
|
|
1082
|
+
"$.xgafv"?: string;
|
|
1083
|
+
/** OAuth access token. */
|
|
1084
|
+
access_token?: string;
|
|
1085
|
+
/** Data format for response. */
|
|
1086
|
+
alt?: string;
|
|
1087
|
+
/** JSONP */
|
|
1088
|
+
callback?: string;
|
|
1089
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1090
|
+
fields?: string;
|
|
1091
|
+
/** 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. */
|
|
1092
|
+
key?: string;
|
|
1093
|
+
/** Required. The resource name of the CryptoKeyVersion to use for signing. */
|
|
1094
|
+
name: string;
|
|
1095
|
+
/** OAuth 2.0 token for the current user. */
|
|
1096
|
+
oauth_token?: string;
|
|
1097
|
+
/** Returns response with indentations and line breaks. */
|
|
1098
|
+
prettyPrint?: boolean;
|
|
1099
|
+
/** 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. */
|
|
1100
|
+
quotaUser?: string;
|
|
1101
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1102
|
+
upload_protocol?: string;
|
|
1103
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1104
|
+
uploadType?: string;
|
|
1105
|
+
/** Request body */
|
|
1106
|
+
resource: AsymmetricSignRequest;
|
|
1107
|
+
}): Request<AsymmetricSignResponse>;
|
|
1108
|
+
asymmetricSign(request: {
|
|
1109
|
+
/** V1 error format. */
|
|
1110
|
+
"$.xgafv"?: string;
|
|
1111
|
+
/** OAuth access token. */
|
|
1112
|
+
access_token?: string;
|
|
1113
|
+
/** Data format for response. */
|
|
1114
|
+
alt?: string;
|
|
1115
|
+
/** JSONP */
|
|
1116
|
+
callback?: string;
|
|
1117
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1118
|
+
fields?: string;
|
|
1119
|
+
/** 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. */
|
|
1120
|
+
key?: string;
|
|
1121
|
+
/** Required. The resource name of the CryptoKeyVersion to use for signing. */
|
|
1122
|
+
name: string;
|
|
1123
|
+
/** OAuth 2.0 token for the current user. */
|
|
1124
|
+
oauth_token?: string;
|
|
1125
|
+
/** Returns response with indentations and line breaks. */
|
|
1126
|
+
prettyPrint?: boolean;
|
|
1127
|
+
/** 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. */
|
|
1128
|
+
quotaUser?: string;
|
|
1129
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1130
|
+
upload_protocol?: string;
|
|
1131
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1132
|
+
uploadType?: string;
|
|
1133
|
+
},
|
|
1134
|
+
body: AsymmetricSignRequest): Request<AsymmetricSignResponse>;
|
|
1135
|
+
/** Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. */
|
|
1136
|
+
create(request: {
|
|
1137
|
+
/** V1 error format. */
|
|
1138
|
+
"$.xgafv"?: string;
|
|
1139
|
+
/** OAuth access token. */
|
|
1140
|
+
access_token?: string;
|
|
1141
|
+
/** Data format for response. */
|
|
1142
|
+
alt?: string;
|
|
1143
|
+
/** JSONP */
|
|
1144
|
+
callback?: string;
|
|
1145
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1146
|
+
fields?: string;
|
|
1147
|
+
/** 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. */
|
|
1148
|
+
key?: string;
|
|
1149
|
+
/** OAuth 2.0 token for the current user. */
|
|
1150
|
+
oauth_token?: string;
|
|
1151
|
+
/** Required. The name of the CryptoKey associated with the CryptoKeyVersions. */
|
|
1152
|
+
parent: string;
|
|
1153
|
+
/** Returns response with indentations and line breaks. */
|
|
1154
|
+
prettyPrint?: boolean;
|
|
1155
|
+
/** 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. */
|
|
1156
|
+
quotaUser?: string;
|
|
1157
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1158
|
+
upload_protocol?: string;
|
|
1159
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1160
|
+
uploadType?: string;
|
|
1161
|
+
/** Request body */
|
|
1162
|
+
resource: CryptoKeyVersion;
|
|
1163
|
+
}): Request<CryptoKeyVersion>;
|
|
1164
|
+
create(request: {
|
|
1165
|
+
/** V1 error format. */
|
|
1166
|
+
"$.xgafv"?: string;
|
|
1167
|
+
/** OAuth access token. */
|
|
1168
|
+
access_token?: string;
|
|
1169
|
+
/** Data format for response. */
|
|
1170
|
+
alt?: string;
|
|
1171
|
+
/** JSONP */
|
|
1172
|
+
callback?: string;
|
|
1173
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1174
|
+
fields?: string;
|
|
1175
|
+
/** 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. */
|
|
1176
|
+
key?: string;
|
|
1177
|
+
/** OAuth 2.0 token for the current user. */
|
|
1178
|
+
oauth_token?: string;
|
|
1179
|
+
/** Required. The name of the CryptoKey associated with the CryptoKeyVersions. */
|
|
1180
|
+
parent: string;
|
|
1181
|
+
/** Returns response with indentations and line breaks. */
|
|
1182
|
+
prettyPrint?: boolean;
|
|
1183
|
+
/** 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. */
|
|
1184
|
+
quotaUser?: string;
|
|
1185
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1186
|
+
upload_protocol?: string;
|
|
1187
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1188
|
+
uploadType?: string;
|
|
1189
|
+
},
|
|
1190
|
+
body: CryptoKeyVersion): Request<CryptoKeyVersion>;
|
|
1191
|
+
/**
|
|
1192
|
+
* 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
|
|
1193
|
+
* 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
|
|
1194
|
+
* is reached, RestoreCryptoKeyVersion may be called to reverse the process.
|
|
1195
|
+
*/
|
|
1196
|
+
destroy(request: {
|
|
1197
|
+
/** V1 error format. */
|
|
1198
|
+
"$.xgafv"?: string;
|
|
1199
|
+
/** OAuth access token. */
|
|
1200
|
+
access_token?: string;
|
|
1201
|
+
/** Data format for response. */
|
|
1202
|
+
alt?: string;
|
|
1203
|
+
/** JSONP */
|
|
1204
|
+
callback?: string;
|
|
1205
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1206
|
+
fields?: string;
|
|
1207
|
+
/** 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. */
|
|
1208
|
+
key?: string;
|
|
1209
|
+
/** Required. The resource name of the CryptoKeyVersion to destroy. */
|
|
1210
|
+
name: string;
|
|
1211
|
+
/** OAuth 2.0 token for the current user. */
|
|
1212
|
+
oauth_token?: string;
|
|
1213
|
+
/** Returns response with indentations and line breaks. */
|
|
1214
|
+
prettyPrint?: boolean;
|
|
1215
|
+
/** 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. */
|
|
1216
|
+
quotaUser?: string;
|
|
1217
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1218
|
+
upload_protocol?: string;
|
|
1219
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1220
|
+
uploadType?: string;
|
|
1221
|
+
/** Request body */
|
|
1222
|
+
resource: DestroyCryptoKeyVersionRequest;
|
|
1223
|
+
}): Request<CryptoKeyVersion>;
|
|
1224
|
+
destroy(request: {
|
|
1225
|
+
/** V1 error format. */
|
|
1226
|
+
"$.xgafv"?: string;
|
|
1227
|
+
/** OAuth access token. */
|
|
1228
|
+
access_token?: string;
|
|
1229
|
+
/** Data format for response. */
|
|
1230
|
+
alt?: string;
|
|
1231
|
+
/** JSONP */
|
|
1232
|
+
callback?: string;
|
|
1233
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1234
|
+
fields?: string;
|
|
1235
|
+
/** 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. */
|
|
1236
|
+
key?: string;
|
|
1237
|
+
/** Required. The resource name of the CryptoKeyVersion to destroy. */
|
|
1238
|
+
name: string;
|
|
1239
|
+
/** OAuth 2.0 token for the current user. */
|
|
1240
|
+
oauth_token?: string;
|
|
1241
|
+
/** Returns response with indentations and line breaks. */
|
|
1242
|
+
prettyPrint?: boolean;
|
|
1243
|
+
/** 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. */
|
|
1244
|
+
quotaUser?: string;
|
|
1245
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1246
|
+
upload_protocol?: string;
|
|
1247
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1248
|
+
uploadType?: string;
|
|
1249
|
+
},
|
|
1250
|
+
body: DestroyCryptoKeyVersionRequest): Request<CryptoKeyVersion>;
|
|
1251
|
+
/** Returns metadata for a given CryptoKeyVersion. */
|
|
1252
|
+
get(request?: {
|
|
1253
|
+
/** V1 error format. */
|
|
1254
|
+
"$.xgafv"?: string;
|
|
1255
|
+
/** OAuth access token. */
|
|
1256
|
+
access_token?: string;
|
|
1257
|
+
/** Data format for response. */
|
|
1258
|
+
alt?: string;
|
|
1259
|
+
/** JSONP */
|
|
1260
|
+
callback?: string;
|
|
1261
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1262
|
+
fields?: string;
|
|
1263
|
+
/** 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. */
|
|
1264
|
+
key?: string;
|
|
1265
|
+
/** Required. The name of the CryptoKeyVersion to get. */
|
|
1266
|
+
name: string;
|
|
1267
|
+
/** OAuth 2.0 token for the current user. */
|
|
1268
|
+
oauth_token?: string;
|
|
1269
|
+
/** Returns response with indentations and line breaks. */
|
|
1270
|
+
prettyPrint?: boolean;
|
|
1271
|
+
/** 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. */
|
|
1272
|
+
quotaUser?: string;
|
|
1273
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1274
|
+
upload_protocol?: string;
|
|
1275
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1276
|
+
uploadType?: string;
|
|
1277
|
+
}): Request<CryptoKeyVersion>;
|
|
1278
|
+
/** Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT. */
|
|
1279
|
+
getPublicKey(request?: {
|
|
1280
|
+
/** V1 error format. */
|
|
1281
|
+
"$.xgafv"?: string;
|
|
1282
|
+
/** OAuth access token. */
|
|
1283
|
+
access_token?: string;
|
|
1284
|
+
/** Data format for response. */
|
|
1285
|
+
alt?: string;
|
|
1286
|
+
/** JSONP */
|
|
1287
|
+
callback?: string;
|
|
1288
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1289
|
+
fields?: string;
|
|
1290
|
+
/** 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. */
|
|
1291
|
+
key?: string;
|
|
1292
|
+
/** Required. The name of the CryptoKeyVersion public key to get. */
|
|
1293
|
+
name: string;
|
|
1294
|
+
/** OAuth 2.0 token for the current user. */
|
|
1295
|
+
oauth_token?: string;
|
|
1296
|
+
/** Returns response with indentations and line breaks. */
|
|
1297
|
+
prettyPrint?: boolean;
|
|
1298
|
+
/** 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. */
|
|
1299
|
+
quotaUser?: string;
|
|
1300
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1301
|
+
upload_protocol?: string;
|
|
1302
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1303
|
+
uploadType?: string;
|
|
1304
|
+
}): Request<PublicKey>;
|
|
1305
|
+
/**
|
|
1306
|
+
* Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be
|
|
1307
|
+
* reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.
|
|
1308
|
+
*/
|
|
1309
|
+
import(request: {
|
|
1310
|
+
/** V1 error format. */
|
|
1311
|
+
"$.xgafv"?: string;
|
|
1312
|
+
/** OAuth access token. */
|
|
1313
|
+
access_token?: string;
|
|
1314
|
+
/** Data format for response. */
|
|
1315
|
+
alt?: string;
|
|
1316
|
+
/** JSONP */
|
|
1317
|
+
callback?: string;
|
|
1318
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1319
|
+
fields?: string;
|
|
1320
|
+
/** 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. */
|
|
1321
|
+
key?: string;
|
|
1322
|
+
/** OAuth 2.0 token for the current user. */
|
|
1323
|
+
oauth_token?: string;
|
|
1324
|
+
/** Required. The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion. */
|
|
1325
|
+
parent: string;
|
|
1326
|
+
/** Returns response with indentations and line breaks. */
|
|
1327
|
+
prettyPrint?: boolean;
|
|
1328
|
+
/** 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. */
|
|
1329
|
+
quotaUser?: string;
|
|
1330
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1331
|
+
upload_protocol?: string;
|
|
1332
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1333
|
+
uploadType?: string;
|
|
1334
|
+
/** Request body */
|
|
1335
|
+
resource: ImportCryptoKeyVersionRequest;
|
|
1336
|
+
}): Request<CryptoKeyVersion>;
|
|
1337
|
+
import(request: {
|
|
1338
|
+
/** V1 error format. */
|
|
1339
|
+
"$.xgafv"?: string;
|
|
1340
|
+
/** OAuth access token. */
|
|
1341
|
+
access_token?: string;
|
|
1342
|
+
/** Data format for response. */
|
|
1343
|
+
alt?: string;
|
|
1344
|
+
/** JSONP */
|
|
1345
|
+
callback?: string;
|
|
1346
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1347
|
+
fields?: string;
|
|
1348
|
+
/** 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. */
|
|
1349
|
+
key?: string;
|
|
1350
|
+
/** OAuth 2.0 token for the current user. */
|
|
1351
|
+
oauth_token?: string;
|
|
1352
|
+
/** Required. The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion. */
|
|
1353
|
+
parent: string;
|
|
1354
|
+
/** Returns response with indentations and line breaks. */
|
|
1355
|
+
prettyPrint?: boolean;
|
|
1356
|
+
/** 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. */
|
|
1357
|
+
quotaUser?: string;
|
|
1358
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1359
|
+
upload_protocol?: string;
|
|
1360
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1361
|
+
uploadType?: string;
|
|
1362
|
+
},
|
|
1363
|
+
body: ImportCryptoKeyVersionRequest): Request<CryptoKeyVersion>;
|
|
1364
|
+
/** Lists CryptoKeyVersions. */
|
|
1365
|
+
list(request?: {
|
|
1366
|
+
/** V1 error format. */
|
|
1367
|
+
"$.xgafv"?: string;
|
|
1368
|
+
/** OAuth access token. */
|
|
1369
|
+
access_token?: string;
|
|
1370
|
+
/** Data format for response. */
|
|
1371
|
+
alt?: string;
|
|
1372
|
+
/** JSONP */
|
|
1373
|
+
callback?: string;
|
|
1374
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1375
|
+
fields?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
|
|
1378
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
1379
|
+
*/
|
|
1380
|
+
filter?: string;
|
|
1381
|
+
/** 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. */
|
|
1382
|
+
key?: string;
|
|
1383
|
+
/** OAuth 2.0 token for the current user. */
|
|
1384
|
+
oauth_token?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
|
|
1387
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
1388
|
+
*/
|
|
1389
|
+
orderBy?: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the
|
|
1392
|
+
* ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
|
1393
|
+
*/
|
|
1394
|
+
pageSize?: number;
|
|
1395
|
+
/** Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. */
|
|
1396
|
+
pageToken?: string;
|
|
1397
|
+
/** Required. The resource name of the CryptoKey to list, in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. */
|
|
1398
|
+
parent: string;
|
|
1399
|
+
/** Returns response with indentations and line breaks. */
|
|
1400
|
+
prettyPrint?: boolean;
|
|
1401
|
+
/** 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. */
|
|
1402
|
+
quotaUser?: string;
|
|
1403
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1404
|
+
upload_protocol?: string;
|
|
1405
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1406
|
+
uploadType?: string;
|
|
1407
|
+
/** The fields to include in the response. */
|
|
1408
|
+
view?: string;
|
|
1409
|
+
}): Request<ListCryptoKeyVersionsResponse>;
|
|
1410
|
+
/** Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key. */
|
|
1411
|
+
macSign(request: {
|
|
1412
|
+
/** V1 error format. */
|
|
1413
|
+
"$.xgafv"?: string;
|
|
1414
|
+
/** OAuth access token. */
|
|
1415
|
+
access_token?: string;
|
|
1416
|
+
/** Data format for response. */
|
|
1417
|
+
alt?: string;
|
|
1418
|
+
/** JSONP */
|
|
1419
|
+
callback?: string;
|
|
1420
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1421
|
+
fields?: string;
|
|
1422
|
+
/** 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. */
|
|
1423
|
+
key?: string;
|
|
1424
|
+
/** Required. The resource name of the CryptoKeyVersion to use for signing. */
|
|
1425
|
+
name: string;
|
|
1426
|
+
/** OAuth 2.0 token for the current user. */
|
|
1427
|
+
oauth_token?: string;
|
|
1428
|
+
/** Returns response with indentations and line breaks. */
|
|
1429
|
+
prettyPrint?: boolean;
|
|
1430
|
+
/** 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. */
|
|
1431
|
+
quotaUser?: string;
|
|
1432
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1433
|
+
upload_protocol?: string;
|
|
1434
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1435
|
+
uploadType?: string;
|
|
1436
|
+
/** Request body */
|
|
1437
|
+
resource: MacSignRequest;
|
|
1438
|
+
}): Request<MacSignResponse>;
|
|
1439
|
+
macSign(request: {
|
|
1440
|
+
/** V1 error format. */
|
|
1441
|
+
"$.xgafv"?: string;
|
|
1442
|
+
/** OAuth access token. */
|
|
1443
|
+
access_token?: string;
|
|
1444
|
+
/** Data format for response. */
|
|
1445
|
+
alt?: string;
|
|
1446
|
+
/** JSONP */
|
|
1447
|
+
callback?: string;
|
|
1448
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1449
|
+
fields?: string;
|
|
1450
|
+
/** 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. */
|
|
1451
|
+
key?: string;
|
|
1452
|
+
/** Required. The resource name of the CryptoKeyVersion to use for signing. */
|
|
1453
|
+
name: string;
|
|
1454
|
+
/** OAuth 2.0 token for the current user. */
|
|
1455
|
+
oauth_token?: string;
|
|
1456
|
+
/** Returns response with indentations and line breaks. */
|
|
1457
|
+
prettyPrint?: boolean;
|
|
1458
|
+
/** 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. */
|
|
1459
|
+
quotaUser?: string;
|
|
1460
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1461
|
+
upload_protocol?: string;
|
|
1462
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1463
|
+
uploadType?: string;
|
|
1464
|
+
},
|
|
1465
|
+
body: MacSignRequest): Request<MacSignResponse>;
|
|
1466
|
+
/** Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful. */
|
|
1467
|
+
macVerify(request: {
|
|
1468
|
+
/** V1 error format. */
|
|
1469
|
+
"$.xgafv"?: string;
|
|
1470
|
+
/** OAuth access token. */
|
|
1471
|
+
access_token?: string;
|
|
1472
|
+
/** Data format for response. */
|
|
1473
|
+
alt?: string;
|
|
1474
|
+
/** JSONP */
|
|
1475
|
+
callback?: string;
|
|
1476
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1477
|
+
fields?: string;
|
|
1478
|
+
/** 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. */
|
|
1479
|
+
key?: string;
|
|
1480
|
+
/** Required. The resource name of the CryptoKeyVersion to use for verification. */
|
|
1481
|
+
name: string;
|
|
1482
|
+
/** OAuth 2.0 token for the current user. */
|
|
1483
|
+
oauth_token?: string;
|
|
1484
|
+
/** Returns response with indentations and line breaks. */
|
|
1485
|
+
prettyPrint?: boolean;
|
|
1486
|
+
/** 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. */
|
|
1487
|
+
quotaUser?: string;
|
|
1488
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1489
|
+
upload_protocol?: string;
|
|
1490
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1491
|
+
uploadType?: string;
|
|
1492
|
+
/** Request body */
|
|
1493
|
+
resource: MacVerifyRequest;
|
|
1494
|
+
}): Request<MacVerifyResponse>;
|
|
1495
|
+
macVerify(request: {
|
|
1496
|
+
/** V1 error format. */
|
|
1497
|
+
"$.xgafv"?: string;
|
|
1498
|
+
/** OAuth access token. */
|
|
1499
|
+
access_token?: string;
|
|
1500
|
+
/** Data format for response. */
|
|
1501
|
+
alt?: string;
|
|
1502
|
+
/** JSONP */
|
|
1503
|
+
callback?: string;
|
|
1504
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1505
|
+
fields?: string;
|
|
1506
|
+
/** 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. */
|
|
1507
|
+
key?: string;
|
|
1508
|
+
/** Required. The resource name of the CryptoKeyVersion to use for verification. */
|
|
1509
|
+
name: string;
|
|
1510
|
+
/** OAuth 2.0 token for the current user. */
|
|
1511
|
+
oauth_token?: string;
|
|
1512
|
+
/** Returns response with indentations and line breaks. */
|
|
1513
|
+
prettyPrint?: boolean;
|
|
1514
|
+
/** 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. */
|
|
1515
|
+
quotaUser?: string;
|
|
1516
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1517
|
+
upload_protocol?: string;
|
|
1518
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1519
|
+
uploadType?: string;
|
|
1520
|
+
},
|
|
1521
|
+
body: MacVerifyRequest): Request<MacVerifyResponse>;
|
|
1522
|
+
/**
|
|
1523
|
+
* Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between
|
|
1524
|
+
* other states.
|
|
1525
|
+
*/
|
|
1526
|
+
patch(request: {
|
|
1527
|
+
/** V1 error format. */
|
|
1528
|
+
"$.xgafv"?: string;
|
|
1529
|
+
/** OAuth access token. */
|
|
1530
|
+
access_token?: string;
|
|
1531
|
+
/** Data format for response. */
|
|
1532
|
+
alt?: string;
|
|
1533
|
+
/** JSONP */
|
|
1534
|
+
callback?: string;
|
|
1535
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1536
|
+
fields?: string;
|
|
1537
|
+
/** 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. */
|
|
1538
|
+
key?: string;
|
|
1539
|
+
/** Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. */
|
|
1540
|
+
name: string;
|
|
1541
|
+
/** OAuth 2.0 token for the current user. */
|
|
1542
|
+
oauth_token?: string;
|
|
1543
|
+
/** Returns response with indentations and line breaks. */
|
|
1544
|
+
prettyPrint?: boolean;
|
|
1545
|
+
/** 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. */
|
|
1546
|
+
quotaUser?: string;
|
|
1547
|
+
/** Required. List of fields to be updated in this request. */
|
|
1548
|
+
updateMask?: string;
|
|
1549
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1550
|
+
upload_protocol?: string;
|
|
1551
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1552
|
+
uploadType?: string;
|
|
1553
|
+
/** Request body */
|
|
1554
|
+
resource: CryptoKeyVersion;
|
|
1555
|
+
}): Request<CryptoKeyVersion>;
|
|
1556
|
+
patch(request: {
|
|
1557
|
+
/** V1 error format. */
|
|
1558
|
+
"$.xgafv"?: string;
|
|
1559
|
+
/** OAuth access token. */
|
|
1560
|
+
access_token?: string;
|
|
1561
|
+
/** Data format for response. */
|
|
1562
|
+
alt?: string;
|
|
1563
|
+
/** JSONP */
|
|
1564
|
+
callback?: string;
|
|
1565
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1566
|
+
fields?: string;
|
|
1567
|
+
/** 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. */
|
|
1568
|
+
key?: string;
|
|
1569
|
+
/** Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. */
|
|
1570
|
+
name: string;
|
|
1571
|
+
/** OAuth 2.0 token for the current user. */
|
|
1572
|
+
oauth_token?: string;
|
|
1573
|
+
/** Returns response with indentations and line breaks. */
|
|
1574
|
+
prettyPrint?: boolean;
|
|
1575
|
+
/** 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. */
|
|
1576
|
+
quotaUser?: string;
|
|
1577
|
+
/** Required. List of fields to be updated in this request. */
|
|
1578
|
+
updateMask?: string;
|
|
1579
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1580
|
+
upload_protocol?: string;
|
|
1581
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1582
|
+
uploadType?: string;
|
|
1583
|
+
},
|
|
1584
|
+
body: CryptoKeyVersion): Request<CryptoKeyVersion>;
|
|
1585
|
+
/** Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared. */
|
|
1586
|
+
restore(request: {
|
|
1587
|
+
/** V1 error format. */
|
|
1588
|
+
"$.xgafv"?: string;
|
|
1589
|
+
/** OAuth access token. */
|
|
1590
|
+
access_token?: string;
|
|
1591
|
+
/** Data format for response. */
|
|
1592
|
+
alt?: string;
|
|
1593
|
+
/** JSONP */
|
|
1594
|
+
callback?: string;
|
|
1595
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1596
|
+
fields?: string;
|
|
1597
|
+
/** 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. */
|
|
1598
|
+
key?: string;
|
|
1599
|
+
/** Required. The resource name of the CryptoKeyVersion to restore. */
|
|
1600
|
+
name: string;
|
|
1601
|
+
/** OAuth 2.0 token for the current user. */
|
|
1602
|
+
oauth_token?: string;
|
|
1603
|
+
/** Returns response with indentations and line breaks. */
|
|
1604
|
+
prettyPrint?: boolean;
|
|
1605
|
+
/** 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. */
|
|
1606
|
+
quotaUser?: string;
|
|
1607
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1608
|
+
upload_protocol?: string;
|
|
1609
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1610
|
+
uploadType?: string;
|
|
1611
|
+
/** Request body */
|
|
1612
|
+
resource: RestoreCryptoKeyVersionRequest;
|
|
1613
|
+
}): Request<CryptoKeyVersion>;
|
|
1614
|
+
restore(request: {
|
|
1615
|
+
/** V1 error format. */
|
|
1616
|
+
"$.xgafv"?: string;
|
|
1617
|
+
/** OAuth access token. */
|
|
1618
|
+
access_token?: string;
|
|
1619
|
+
/** Data format for response. */
|
|
1620
|
+
alt?: string;
|
|
1621
|
+
/** JSONP */
|
|
1622
|
+
callback?: string;
|
|
1623
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1624
|
+
fields?: string;
|
|
1625
|
+
/** 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. */
|
|
1626
|
+
key?: string;
|
|
1627
|
+
/** Required. The resource name of the CryptoKeyVersion to restore. */
|
|
1628
|
+
name: string;
|
|
1629
|
+
/** OAuth 2.0 token for the current user. */
|
|
1630
|
+
oauth_token?: string;
|
|
1631
|
+
/** Returns response with indentations and line breaks. */
|
|
1632
|
+
prettyPrint?: boolean;
|
|
1633
|
+
/** 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. */
|
|
1634
|
+
quotaUser?: string;
|
|
1635
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1636
|
+
upload_protocol?: string;
|
|
1637
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1638
|
+
uploadType?: string;
|
|
1639
|
+
},
|
|
1640
|
+
body: RestoreCryptoKeyVersionRequest): Request<CryptoKeyVersion>;
|
|
1641
|
+
}
|
|
1642
|
+
interface CryptoKeysResource {
|
|
1643
|
+
/** Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. */
|
|
1644
|
+
create(request: {
|
|
1645
|
+
/** V1 error format. */
|
|
1646
|
+
"$.xgafv"?: string;
|
|
1647
|
+
/** OAuth access token. */
|
|
1648
|
+
access_token?: string;
|
|
1649
|
+
/** Data format for response. */
|
|
1650
|
+
alt?: string;
|
|
1651
|
+
/** JSONP */
|
|
1652
|
+
callback?: string;
|
|
1653
|
+
/** Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
1654
|
+
cryptoKeyId?: string;
|
|
1655
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1656
|
+
fields?: string;
|
|
1657
|
+
/** 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. */
|
|
1658
|
+
key?: string;
|
|
1659
|
+
/** OAuth 2.0 token for the current user. */
|
|
1660
|
+
oauth_token?: string;
|
|
1661
|
+
/** Required. The name of the KeyRing associated with the CryptoKeys. */
|
|
1662
|
+
parent: string;
|
|
1663
|
+
/** Returns response with indentations and line breaks. */
|
|
1664
|
+
prettyPrint?: boolean;
|
|
1665
|
+
/** 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. */
|
|
1666
|
+
quotaUser?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use
|
|
1669
|
+
* this CryptoKey.
|
|
1670
|
+
*/
|
|
1671
|
+
skipInitialVersionCreation?: boolean;
|
|
1672
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1673
|
+
upload_protocol?: string;
|
|
1674
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1675
|
+
uploadType?: string;
|
|
1676
|
+
/** Request body */
|
|
1677
|
+
resource: CryptoKey;
|
|
1678
|
+
}): Request<CryptoKey>;
|
|
1679
|
+
create(request: {
|
|
1680
|
+
/** V1 error format. */
|
|
1681
|
+
"$.xgafv"?: string;
|
|
1682
|
+
/** OAuth access token. */
|
|
1683
|
+
access_token?: string;
|
|
1684
|
+
/** Data format for response. */
|
|
1685
|
+
alt?: string;
|
|
1686
|
+
/** JSONP */
|
|
1687
|
+
callback?: string;
|
|
1688
|
+
/** Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
1689
|
+
cryptoKeyId?: string;
|
|
1690
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1691
|
+
fields?: string;
|
|
1692
|
+
/** 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. */
|
|
1693
|
+
key?: string;
|
|
1694
|
+
/** OAuth 2.0 token for the current user. */
|
|
1695
|
+
oauth_token?: string;
|
|
1696
|
+
/** Required. The name of the KeyRing associated with the CryptoKeys. */
|
|
1697
|
+
parent: string;
|
|
1698
|
+
/** Returns response with indentations and line breaks. */
|
|
1699
|
+
prettyPrint?: boolean;
|
|
1700
|
+
/** 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. */
|
|
1701
|
+
quotaUser?: string;
|
|
1702
|
+
/**
|
|
1703
|
+
* If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use
|
|
1704
|
+
* this CryptoKey.
|
|
1705
|
+
*/
|
|
1706
|
+
skipInitialVersionCreation?: boolean;
|
|
1707
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1708
|
+
upload_protocol?: string;
|
|
1709
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1710
|
+
uploadType?: string;
|
|
1711
|
+
},
|
|
1712
|
+
body: CryptoKey): Request<CryptoKey>;
|
|
1713
|
+
/** Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. */
|
|
1714
|
+
decrypt(request: {
|
|
1715
|
+
/** V1 error format. */
|
|
1716
|
+
"$.xgafv"?: string;
|
|
1717
|
+
/** OAuth access token. */
|
|
1718
|
+
access_token?: string;
|
|
1719
|
+
/** Data format for response. */
|
|
1720
|
+
alt?: string;
|
|
1721
|
+
/** JSONP */
|
|
1722
|
+
callback?: string;
|
|
1723
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1724
|
+
fields?: string;
|
|
1725
|
+
/** 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. */
|
|
1726
|
+
key?: string;
|
|
1727
|
+
/** Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. */
|
|
1728
|
+
name: string;
|
|
1729
|
+
/** OAuth 2.0 token for the current user. */
|
|
1730
|
+
oauth_token?: string;
|
|
1731
|
+
/** Returns response with indentations and line breaks. */
|
|
1732
|
+
prettyPrint?: boolean;
|
|
1733
|
+
/** 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. */
|
|
1734
|
+
quotaUser?: string;
|
|
1735
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1736
|
+
upload_protocol?: string;
|
|
1737
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1738
|
+
uploadType?: string;
|
|
1739
|
+
/** Request body */
|
|
1740
|
+
resource: DecryptRequest;
|
|
1741
|
+
}): Request<DecryptResponse>;
|
|
1742
|
+
decrypt(request: {
|
|
1743
|
+
/** V1 error format. */
|
|
1744
|
+
"$.xgafv"?: string;
|
|
1745
|
+
/** OAuth access token. */
|
|
1746
|
+
access_token?: string;
|
|
1747
|
+
/** Data format for response. */
|
|
1748
|
+
alt?: string;
|
|
1749
|
+
/** JSONP */
|
|
1750
|
+
callback?: string;
|
|
1751
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1752
|
+
fields?: string;
|
|
1753
|
+
/** 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. */
|
|
1754
|
+
key?: string;
|
|
1755
|
+
/** Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. */
|
|
1756
|
+
name: string;
|
|
1757
|
+
/** OAuth 2.0 token for the current user. */
|
|
1758
|
+
oauth_token?: string;
|
|
1759
|
+
/** Returns response with indentations and line breaks. */
|
|
1760
|
+
prettyPrint?: boolean;
|
|
1761
|
+
/** 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. */
|
|
1762
|
+
quotaUser?: string;
|
|
1763
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1764
|
+
upload_protocol?: string;
|
|
1765
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1766
|
+
uploadType?: string;
|
|
1767
|
+
},
|
|
1768
|
+
body: DecryptRequest): Request<DecryptResponse>;
|
|
1769
|
+
/** Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. */
|
|
1770
|
+
encrypt(request: {
|
|
1771
|
+
/** V1 error format. */
|
|
1772
|
+
"$.xgafv"?: string;
|
|
1773
|
+
/** OAuth access token. */
|
|
1774
|
+
access_token?: string;
|
|
1775
|
+
/** Data format for response. */
|
|
1776
|
+
alt?: string;
|
|
1777
|
+
/** JSONP */
|
|
1778
|
+
callback?: string;
|
|
1779
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1780
|
+
fields?: string;
|
|
1781
|
+
/** 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. */
|
|
1782
|
+
key?: string;
|
|
1783
|
+
/** Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version. */
|
|
1784
|
+
name: string;
|
|
1785
|
+
/** OAuth 2.0 token for the current user. */
|
|
1786
|
+
oauth_token?: string;
|
|
1787
|
+
/** Returns response with indentations and line breaks. */
|
|
1788
|
+
prettyPrint?: boolean;
|
|
1789
|
+
/** 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. */
|
|
1790
|
+
quotaUser?: string;
|
|
1791
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1792
|
+
upload_protocol?: string;
|
|
1793
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1794
|
+
uploadType?: string;
|
|
1795
|
+
/** Request body */
|
|
1796
|
+
resource: EncryptRequest;
|
|
1797
|
+
}): Request<EncryptResponse>;
|
|
1798
|
+
encrypt(request: {
|
|
1799
|
+
/** V1 error format. */
|
|
1800
|
+
"$.xgafv"?: string;
|
|
1801
|
+
/** OAuth access token. */
|
|
1802
|
+
access_token?: string;
|
|
1803
|
+
/** Data format for response. */
|
|
1804
|
+
alt?: string;
|
|
1805
|
+
/** JSONP */
|
|
1806
|
+
callback?: string;
|
|
1807
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1808
|
+
fields?: string;
|
|
1809
|
+
/** 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. */
|
|
1810
|
+
key?: string;
|
|
1811
|
+
/** Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version. */
|
|
1812
|
+
name: string;
|
|
1813
|
+
/** OAuth 2.0 token for the current user. */
|
|
1814
|
+
oauth_token?: string;
|
|
1815
|
+
/** Returns response with indentations and line breaks. */
|
|
1816
|
+
prettyPrint?: boolean;
|
|
1817
|
+
/** 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. */
|
|
1818
|
+
quotaUser?: string;
|
|
1819
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1820
|
+
upload_protocol?: string;
|
|
1821
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1822
|
+
uploadType?: string;
|
|
1823
|
+
},
|
|
1824
|
+
body: EncryptRequest): Request<EncryptResponse>;
|
|
1825
|
+
/** Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. */
|
|
1826
|
+
get(request?: {
|
|
1827
|
+
/** V1 error format. */
|
|
1828
|
+
"$.xgafv"?: string;
|
|
1829
|
+
/** OAuth access token. */
|
|
1830
|
+
access_token?: string;
|
|
1831
|
+
/** Data format for response. */
|
|
1832
|
+
alt?: string;
|
|
1833
|
+
/** JSONP */
|
|
1834
|
+
callback?: string;
|
|
1835
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1836
|
+
fields?: string;
|
|
1837
|
+
/** 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. */
|
|
1838
|
+
key?: string;
|
|
1839
|
+
/** Required. The name of the CryptoKey to get. */
|
|
1840
|
+
name: string;
|
|
1841
|
+
/** OAuth 2.0 token for the current user. */
|
|
1842
|
+
oauth_token?: string;
|
|
1843
|
+
/** Returns response with indentations and line breaks. */
|
|
1844
|
+
prettyPrint?: boolean;
|
|
1845
|
+
/** 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. */
|
|
1846
|
+
quotaUser?: string;
|
|
1847
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1848
|
+
upload_protocol?: string;
|
|
1849
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1850
|
+
uploadType?: string;
|
|
1851
|
+
}): Request<CryptoKey>;
|
|
1852
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
1853
|
+
getIamPolicy(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
|
+
/** OAuth 2.0 token for the current user. */
|
|
1867
|
+
oauth_token?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
1870
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
|
|
1871
|
+
* in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
|
|
1872
|
+
* role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
1873
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
1874
|
+
*/
|
|
1875
|
+
"options.requestedPolicyVersion"?: number;
|
|
1876
|
+
/** Returns response with indentations and line breaks. */
|
|
1877
|
+
prettyPrint?: boolean;
|
|
1878
|
+
/** 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. */
|
|
1879
|
+
quotaUser?: string;
|
|
1880
|
+
/**
|
|
1881
|
+
* 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
|
|
1882
|
+
* field.
|
|
1883
|
+
*/
|
|
1884
|
+
resource: string;
|
|
1885
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1886
|
+
upload_protocol?: string;
|
|
1887
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1888
|
+
uploadType?: string;
|
|
1889
|
+
}): Request<Policy>;
|
|
1890
|
+
/** Lists CryptoKeys. */
|
|
1891
|
+
list(request?: {
|
|
1892
|
+
/** V1 error format. */
|
|
1893
|
+
"$.xgafv"?: string;
|
|
1894
|
+
/** OAuth access token. */
|
|
1895
|
+
access_token?: string;
|
|
1896
|
+
/** Data format for response. */
|
|
1897
|
+
alt?: string;
|
|
1898
|
+
/** JSONP */
|
|
1899
|
+
callback?: string;
|
|
1900
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1901
|
+
fields?: string;
|
|
1902
|
+
/**
|
|
1903
|
+
* Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
|
|
1904
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
1905
|
+
*/
|
|
1906
|
+
filter?: string;
|
|
1907
|
+
/** 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. */
|
|
1908
|
+
key?: string;
|
|
1909
|
+
/** OAuth 2.0 token for the current user. */
|
|
1910
|
+
oauth_token?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
|
|
1913
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
1914
|
+
*/
|
|
1915
|
+
orderBy?: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the
|
|
1918
|
+
* ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
|
1919
|
+
*/
|
|
1920
|
+
pageSize?: number;
|
|
1921
|
+
/** Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. */
|
|
1922
|
+
pageToken?: string;
|
|
1923
|
+
/** Required. The resource name of the KeyRing to list, in the format `projects/*/locations/*/keyRings/*`. */
|
|
1924
|
+
parent: string;
|
|
1925
|
+
/** Returns response with indentations and line breaks. */
|
|
1926
|
+
prettyPrint?: boolean;
|
|
1927
|
+
/** 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. */
|
|
1928
|
+
quotaUser?: string;
|
|
1929
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1930
|
+
upload_protocol?: string;
|
|
1931
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1932
|
+
uploadType?: string;
|
|
1933
|
+
/** The fields of the primary version to include in the response. */
|
|
1934
|
+
versionView?: string;
|
|
1935
|
+
}): Request<ListCryptoKeysResponse>;
|
|
1936
|
+
/** Update a CryptoKey. */
|
|
1937
|
+
patch(request: {
|
|
1938
|
+
/** V1 error format. */
|
|
1939
|
+
"$.xgafv"?: string;
|
|
1940
|
+
/** OAuth access token. */
|
|
1941
|
+
access_token?: string;
|
|
1942
|
+
/** Data format for response. */
|
|
1943
|
+
alt?: string;
|
|
1944
|
+
/** JSONP */
|
|
1945
|
+
callback?: string;
|
|
1946
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1947
|
+
fields?: string;
|
|
1948
|
+
/** 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. */
|
|
1949
|
+
key?: string;
|
|
1950
|
+
/** Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. */
|
|
1951
|
+
name: string;
|
|
1952
|
+
/** OAuth 2.0 token for the current user. */
|
|
1953
|
+
oauth_token?: string;
|
|
1954
|
+
/** Returns response with indentations and line breaks. */
|
|
1955
|
+
prettyPrint?: boolean;
|
|
1956
|
+
/** 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. */
|
|
1957
|
+
quotaUser?: string;
|
|
1958
|
+
/** Required. List of fields to be updated in this request. */
|
|
1959
|
+
updateMask?: string;
|
|
1960
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1961
|
+
upload_protocol?: string;
|
|
1962
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1963
|
+
uploadType?: string;
|
|
1964
|
+
/** Request body */
|
|
1965
|
+
resource: CryptoKey;
|
|
1966
|
+
}): Request<CryptoKey>;
|
|
1967
|
+
patch(request: {
|
|
1968
|
+
/** V1 error format. */
|
|
1969
|
+
"$.xgafv"?: string;
|
|
1970
|
+
/** OAuth access token. */
|
|
1971
|
+
access_token?: string;
|
|
1972
|
+
/** Data format for response. */
|
|
1973
|
+
alt?: string;
|
|
1974
|
+
/** JSONP */
|
|
1975
|
+
callback?: string;
|
|
1976
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1977
|
+
fields?: string;
|
|
1978
|
+
/** 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. */
|
|
1979
|
+
key?: string;
|
|
1980
|
+
/** Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. */
|
|
1981
|
+
name: string;
|
|
1982
|
+
/** OAuth 2.0 token for the current user. */
|
|
1983
|
+
oauth_token?: string;
|
|
1984
|
+
/** Returns response with indentations and line breaks. */
|
|
1985
|
+
prettyPrint?: boolean;
|
|
1986
|
+
/** 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. */
|
|
1987
|
+
quotaUser?: string;
|
|
1988
|
+
/** Required. List of fields to be updated in this request. */
|
|
1989
|
+
updateMask?: string;
|
|
1990
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1991
|
+
upload_protocol?: string;
|
|
1992
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1993
|
+
uploadType?: string;
|
|
1994
|
+
},
|
|
1995
|
+
body: CryptoKey): Request<CryptoKey>;
|
|
1996
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
1997
|
+
setIamPolicy(request: {
|
|
1998
|
+
/** V1 error format. */
|
|
1999
|
+
"$.xgafv"?: string;
|
|
2000
|
+
/** OAuth access token. */
|
|
2001
|
+
access_token?: string;
|
|
2002
|
+
/** Data format for response. */
|
|
2003
|
+
alt?: string;
|
|
2004
|
+
/** JSONP */
|
|
2005
|
+
callback?: string;
|
|
2006
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2007
|
+
fields?: string;
|
|
2008
|
+
/** 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. */
|
|
2009
|
+
key?: string;
|
|
2010
|
+
/** OAuth 2.0 token for the current user. */
|
|
2011
|
+
oauth_token?: string;
|
|
2012
|
+
/** Returns response with indentations and line breaks. */
|
|
2013
|
+
prettyPrint?: boolean;
|
|
2014
|
+
/** 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. */
|
|
2015
|
+
quotaUser?: string;
|
|
2016
|
+
/**
|
|
2017
|
+
* 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
|
|
2018
|
+
* field.
|
|
2019
|
+
*/
|
|
2020
|
+
resource: string;
|
|
2021
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2022
|
+
upload_protocol?: string;
|
|
2023
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2024
|
+
uploadType?: string;
|
|
2025
|
+
},
|
|
2026
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
2027
|
+
/**
|
|
2028
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
2029
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
2030
|
+
*/
|
|
2031
|
+
testIamPermissions(request: {
|
|
2032
|
+
/** V1 error format. */
|
|
2033
|
+
"$.xgafv"?: string;
|
|
2034
|
+
/** OAuth access token. */
|
|
2035
|
+
access_token?: string;
|
|
2036
|
+
/** Data format for response. */
|
|
2037
|
+
alt?: string;
|
|
2038
|
+
/** JSONP */
|
|
2039
|
+
callback?: string;
|
|
2040
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2041
|
+
fields?: string;
|
|
2042
|
+
/** 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. */
|
|
2043
|
+
key?: string;
|
|
2044
|
+
/** OAuth 2.0 token for the current user. */
|
|
2045
|
+
oauth_token?: string;
|
|
2046
|
+
/** Returns response with indentations and line breaks. */
|
|
2047
|
+
prettyPrint?: boolean;
|
|
2048
|
+
/** 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. */
|
|
2049
|
+
quotaUser?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
2052
|
+
* this field.
|
|
2053
|
+
*/
|
|
2054
|
+
resource: string;
|
|
2055
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2056
|
+
upload_protocol?: string;
|
|
2057
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2058
|
+
uploadType?: string;
|
|
2059
|
+
},
|
|
2060
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
2061
|
+
/** Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT. */
|
|
2062
|
+
updatePrimaryVersion(request: {
|
|
2063
|
+
/** V1 error format. */
|
|
2064
|
+
"$.xgafv"?: string;
|
|
2065
|
+
/** OAuth access token. */
|
|
2066
|
+
access_token?: string;
|
|
2067
|
+
/** Data format for response. */
|
|
2068
|
+
alt?: string;
|
|
2069
|
+
/** JSONP */
|
|
2070
|
+
callback?: string;
|
|
2071
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2072
|
+
fields?: string;
|
|
2073
|
+
/** 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. */
|
|
2074
|
+
key?: string;
|
|
2075
|
+
/** Required. The resource name of the CryptoKey to update. */
|
|
2076
|
+
name: string;
|
|
2077
|
+
/** OAuth 2.0 token for the current user. */
|
|
2078
|
+
oauth_token?: string;
|
|
2079
|
+
/** Returns response with indentations and line breaks. */
|
|
2080
|
+
prettyPrint?: boolean;
|
|
2081
|
+
/** 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. */
|
|
2082
|
+
quotaUser?: string;
|
|
2083
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2084
|
+
upload_protocol?: string;
|
|
2085
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2086
|
+
uploadType?: string;
|
|
2087
|
+
/** Request body */
|
|
2088
|
+
resource: UpdateCryptoKeyPrimaryVersionRequest;
|
|
2089
|
+
}): Request<CryptoKey>;
|
|
2090
|
+
updatePrimaryVersion(request: {
|
|
2091
|
+
/** V1 error format. */
|
|
2092
|
+
"$.xgafv"?: string;
|
|
2093
|
+
/** OAuth access token. */
|
|
2094
|
+
access_token?: string;
|
|
2095
|
+
/** Data format for response. */
|
|
2096
|
+
alt?: string;
|
|
2097
|
+
/** JSONP */
|
|
2098
|
+
callback?: string;
|
|
2099
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2100
|
+
fields?: string;
|
|
2101
|
+
/** 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. */
|
|
2102
|
+
key?: string;
|
|
2103
|
+
/** Required. The resource name of the CryptoKey to update. */
|
|
2104
|
+
name: string;
|
|
2105
|
+
/** OAuth 2.0 token for the current user. */
|
|
2106
|
+
oauth_token?: string;
|
|
2107
|
+
/** Returns response with indentations and line breaks. */
|
|
2108
|
+
prettyPrint?: boolean;
|
|
2109
|
+
/** 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. */
|
|
2110
|
+
quotaUser?: string;
|
|
2111
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2112
|
+
upload_protocol?: string;
|
|
2113
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2114
|
+
uploadType?: string;
|
|
2115
|
+
},
|
|
2116
|
+
body: UpdateCryptoKeyPrimaryVersionRequest): Request<CryptoKey>;
|
|
2117
|
+
cryptoKeyVersions: CryptoKeyVersionsResource;
|
|
2118
|
+
}
|
|
2119
|
+
interface ImportJobsResource {
|
|
2120
|
+
/** Create a new ImportJob within a KeyRing. ImportJob.import_method is required. */
|
|
2121
|
+
create(request: {
|
|
2122
|
+
/** V1 error format. */
|
|
2123
|
+
"$.xgafv"?: string;
|
|
2124
|
+
/** OAuth access token. */
|
|
2125
|
+
access_token?: string;
|
|
2126
|
+
/** Data format for response. */
|
|
2127
|
+
alt?: string;
|
|
2128
|
+
/** JSONP */
|
|
2129
|
+
callback?: string;
|
|
2130
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2131
|
+
fields?: string;
|
|
2132
|
+
/** Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
2133
|
+
importJobId?: string;
|
|
2134
|
+
/** 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. */
|
|
2135
|
+
key?: string;
|
|
2136
|
+
/** OAuth 2.0 token for the current user. */
|
|
2137
|
+
oauth_token?: string;
|
|
2138
|
+
/** Required. The name of the KeyRing associated with the ImportJobs. */
|
|
2139
|
+
parent: string;
|
|
2140
|
+
/** Returns response with indentations and line breaks. */
|
|
2141
|
+
prettyPrint?: boolean;
|
|
2142
|
+
/** 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. */
|
|
2143
|
+
quotaUser?: string;
|
|
2144
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2145
|
+
upload_protocol?: string;
|
|
2146
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2147
|
+
uploadType?: string;
|
|
2148
|
+
/** Request body */
|
|
2149
|
+
resource: ImportJob;
|
|
2150
|
+
}): Request<ImportJob>;
|
|
2151
|
+
create(request: {
|
|
2152
|
+
/** V1 error format. */
|
|
2153
|
+
"$.xgafv"?: string;
|
|
2154
|
+
/** OAuth access token. */
|
|
2155
|
+
access_token?: string;
|
|
2156
|
+
/** Data format for response. */
|
|
2157
|
+
alt?: string;
|
|
2158
|
+
/** JSONP */
|
|
2159
|
+
callback?: string;
|
|
2160
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2161
|
+
fields?: string;
|
|
2162
|
+
/** Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
2163
|
+
importJobId?: string;
|
|
2164
|
+
/** 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. */
|
|
2165
|
+
key?: string;
|
|
2166
|
+
/** OAuth 2.0 token for the current user. */
|
|
2167
|
+
oauth_token?: string;
|
|
2168
|
+
/** Required. The name of the KeyRing associated with the ImportJobs. */
|
|
2169
|
+
parent: string;
|
|
2170
|
+
/** Returns response with indentations and line breaks. */
|
|
2171
|
+
prettyPrint?: boolean;
|
|
2172
|
+
/** 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. */
|
|
2173
|
+
quotaUser?: string;
|
|
2174
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2175
|
+
upload_protocol?: string;
|
|
2176
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2177
|
+
uploadType?: string;
|
|
2178
|
+
},
|
|
2179
|
+
body: ImportJob): Request<ImportJob>;
|
|
2180
|
+
/** Returns metadata for a given ImportJob. */
|
|
2181
|
+
get(request?: {
|
|
2182
|
+
/** V1 error format. */
|
|
2183
|
+
"$.xgafv"?: string;
|
|
2184
|
+
/** OAuth access token. */
|
|
2185
|
+
access_token?: string;
|
|
2186
|
+
/** Data format for response. */
|
|
2187
|
+
alt?: string;
|
|
2188
|
+
/** JSONP */
|
|
2189
|
+
callback?: string;
|
|
2190
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2191
|
+
fields?: string;
|
|
2192
|
+
/** 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. */
|
|
2193
|
+
key?: string;
|
|
2194
|
+
/** Required. The name of the ImportJob to get. */
|
|
2195
|
+
name: string;
|
|
2196
|
+
/** OAuth 2.0 token for the current user. */
|
|
2197
|
+
oauth_token?: string;
|
|
2198
|
+
/** Returns response with indentations and line breaks. */
|
|
2199
|
+
prettyPrint?: boolean;
|
|
2200
|
+
/** 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. */
|
|
2201
|
+
quotaUser?: string;
|
|
2202
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2203
|
+
upload_protocol?: string;
|
|
2204
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2205
|
+
uploadType?: string;
|
|
2206
|
+
}): Request<ImportJob>;
|
|
2207
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
2208
|
+
getIamPolicy(request?: {
|
|
2209
|
+
/** V1 error format. */
|
|
2210
|
+
"$.xgafv"?: string;
|
|
2211
|
+
/** OAuth access token. */
|
|
2212
|
+
access_token?: string;
|
|
2213
|
+
/** Data format for response. */
|
|
2214
|
+
alt?: string;
|
|
2215
|
+
/** JSONP */
|
|
2216
|
+
callback?: string;
|
|
2217
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2218
|
+
fields?: string;
|
|
2219
|
+
/** 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. */
|
|
2220
|
+
key?: string;
|
|
2221
|
+
/** OAuth 2.0 token for the current user. */
|
|
2222
|
+
oauth_token?: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
2225
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
|
|
2226
|
+
* in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
|
|
2227
|
+
* role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
2228
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
2229
|
+
*/
|
|
2230
|
+
"options.requestedPolicyVersion"?: number;
|
|
2231
|
+
/** Returns response with indentations and line breaks. */
|
|
2232
|
+
prettyPrint?: boolean;
|
|
2233
|
+
/** 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. */
|
|
2234
|
+
quotaUser?: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* 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
|
|
2237
|
+
* field.
|
|
2238
|
+
*/
|
|
2239
|
+
resource: string;
|
|
2240
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2241
|
+
upload_protocol?: string;
|
|
2242
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2243
|
+
uploadType?: string;
|
|
2244
|
+
}): Request<Policy>;
|
|
2245
|
+
/** Lists ImportJobs. */
|
|
2246
|
+
list(request?: {
|
|
2247
|
+
/** V1 error format. */
|
|
2248
|
+
"$.xgafv"?: string;
|
|
2249
|
+
/** OAuth access token. */
|
|
2250
|
+
access_token?: string;
|
|
2251
|
+
/** Data format for response. */
|
|
2252
|
+
alt?: string;
|
|
2253
|
+
/** JSONP */
|
|
2254
|
+
callback?: string;
|
|
2255
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2256
|
+
fields?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
* Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
|
|
2259
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
2260
|
+
*/
|
|
2261
|
+
filter?: string;
|
|
2262
|
+
/** 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. */
|
|
2263
|
+
key?: string;
|
|
2264
|
+
/** OAuth 2.0 token for the current user. */
|
|
2265
|
+
oauth_token?: string;
|
|
2266
|
+
/**
|
|
2267
|
+
* Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
|
|
2268
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
2269
|
+
*/
|
|
2270
|
+
orderBy?: string;
|
|
2271
|
+
/**
|
|
2272
|
+
* Optional. Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the
|
|
2273
|
+
* ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
|
2274
|
+
*/
|
|
2275
|
+
pageSize?: number;
|
|
2276
|
+
/** Optional. Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. */
|
|
2277
|
+
pageToken?: string;
|
|
2278
|
+
/** Required. The resource name of the KeyRing to list, in the format `projects/*/locations/*/keyRings/*`. */
|
|
2279
|
+
parent: string;
|
|
2280
|
+
/** Returns response with indentations and line breaks. */
|
|
2281
|
+
prettyPrint?: boolean;
|
|
2282
|
+
/** 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. */
|
|
2283
|
+
quotaUser?: string;
|
|
2284
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2285
|
+
upload_protocol?: string;
|
|
2286
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2287
|
+
uploadType?: string;
|
|
2288
|
+
}): Request<ListImportJobsResponse>;
|
|
2289
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
2290
|
+
setIamPolicy(request: {
|
|
2291
|
+
/** V1 error format. */
|
|
2292
|
+
"$.xgafv"?: string;
|
|
2293
|
+
/** OAuth access token. */
|
|
2294
|
+
access_token?: string;
|
|
2295
|
+
/** Data format for response. */
|
|
2296
|
+
alt?: string;
|
|
2297
|
+
/** JSONP */
|
|
2298
|
+
callback?: string;
|
|
2299
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2300
|
+
fields?: string;
|
|
2301
|
+
/** 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. */
|
|
2302
|
+
key?: string;
|
|
2303
|
+
/** OAuth 2.0 token for the current user. */
|
|
2304
|
+
oauth_token?: string;
|
|
2305
|
+
/** Returns response with indentations and line breaks. */
|
|
2306
|
+
prettyPrint?: boolean;
|
|
2307
|
+
/** 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. */
|
|
2308
|
+
quotaUser?: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* 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
|
|
2311
|
+
* field.
|
|
2312
|
+
*/
|
|
2313
|
+
resource: string;
|
|
2314
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2315
|
+
upload_protocol?: string;
|
|
2316
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2317
|
+
uploadType?: string;
|
|
2318
|
+
},
|
|
2319
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
2320
|
+
/**
|
|
2321
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
2322
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
2323
|
+
*/
|
|
2324
|
+
testIamPermissions(request: {
|
|
2325
|
+
/** V1 error format. */
|
|
2326
|
+
"$.xgafv"?: string;
|
|
2327
|
+
/** OAuth access token. */
|
|
2328
|
+
access_token?: string;
|
|
2329
|
+
/** Data format for response. */
|
|
2330
|
+
alt?: string;
|
|
2331
|
+
/** JSONP */
|
|
2332
|
+
callback?: string;
|
|
2333
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2334
|
+
fields?: string;
|
|
2335
|
+
/** 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. */
|
|
2336
|
+
key?: string;
|
|
2337
|
+
/** OAuth 2.0 token for the current user. */
|
|
2338
|
+
oauth_token?: string;
|
|
2339
|
+
/** Returns response with indentations and line breaks. */
|
|
2340
|
+
prettyPrint?: boolean;
|
|
2341
|
+
/** 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. */
|
|
2342
|
+
quotaUser?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
2345
|
+
* this field.
|
|
2346
|
+
*/
|
|
2347
|
+
resource: string;
|
|
2348
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2349
|
+
upload_protocol?: string;
|
|
2350
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2351
|
+
uploadType?: string;
|
|
2352
|
+
},
|
|
2353
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
2354
|
+
}
|
|
2355
|
+
interface KeyRingsResource {
|
|
2356
|
+
/** Create a new KeyRing in a given Project and Location. */
|
|
2357
|
+
create(request: {
|
|
2358
|
+
/** V1 error format. */
|
|
2359
|
+
"$.xgafv"?: string;
|
|
2360
|
+
/** OAuth access token. */
|
|
2361
|
+
access_token?: string;
|
|
2362
|
+
/** Data format for response. */
|
|
2363
|
+
alt?: string;
|
|
2364
|
+
/** JSONP */
|
|
2365
|
+
callback?: string;
|
|
2366
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2367
|
+
fields?: string;
|
|
2368
|
+
/** 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. */
|
|
2369
|
+
key?: string;
|
|
2370
|
+
/** Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
2371
|
+
keyRingId?: string;
|
|
2372
|
+
/** OAuth 2.0 token for the current user. */
|
|
2373
|
+
oauth_token?: string;
|
|
2374
|
+
/** Required. The resource name of the location associated with the KeyRings, in the format `projects/*/locations/*`. */
|
|
2375
|
+
parent: string;
|
|
2376
|
+
/** Returns response with indentations and line breaks. */
|
|
2377
|
+
prettyPrint?: boolean;
|
|
2378
|
+
/** 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. */
|
|
2379
|
+
quotaUser?: string;
|
|
2380
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2381
|
+
upload_protocol?: string;
|
|
2382
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2383
|
+
uploadType?: string;
|
|
2384
|
+
/** Request body */
|
|
2385
|
+
resource: KeyRing;
|
|
2386
|
+
}): Request<KeyRing>;
|
|
2387
|
+
create(request: {
|
|
2388
|
+
/** V1 error format. */
|
|
2389
|
+
"$.xgafv"?: string;
|
|
2390
|
+
/** OAuth access token. */
|
|
2391
|
+
access_token?: string;
|
|
2392
|
+
/** Data format for response. */
|
|
2393
|
+
alt?: string;
|
|
2394
|
+
/** JSONP */
|
|
2395
|
+
callback?: string;
|
|
2396
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2397
|
+
fields?: string;
|
|
2398
|
+
/** 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. */
|
|
2399
|
+
key?: string;
|
|
2400
|
+
/** Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` */
|
|
2401
|
+
keyRingId?: string;
|
|
2402
|
+
/** OAuth 2.0 token for the current user. */
|
|
2403
|
+
oauth_token?: string;
|
|
2404
|
+
/** Required. The resource name of the location associated with the KeyRings, in the format `projects/*/locations/*`. */
|
|
2405
|
+
parent: string;
|
|
2406
|
+
/** Returns response with indentations and line breaks. */
|
|
2407
|
+
prettyPrint?: boolean;
|
|
2408
|
+
/** 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. */
|
|
2409
|
+
quotaUser?: string;
|
|
2410
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2411
|
+
upload_protocol?: string;
|
|
2412
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2413
|
+
uploadType?: string;
|
|
2414
|
+
},
|
|
2415
|
+
body: KeyRing): Request<KeyRing>;
|
|
2416
|
+
/** Returns metadata for a given KeyRing. */
|
|
2417
|
+
get(request?: {
|
|
2418
|
+
/** V1 error format. */
|
|
2419
|
+
"$.xgafv"?: string;
|
|
2420
|
+
/** OAuth access token. */
|
|
2421
|
+
access_token?: string;
|
|
2422
|
+
/** Data format for response. */
|
|
2423
|
+
alt?: string;
|
|
2424
|
+
/** JSONP */
|
|
2425
|
+
callback?: string;
|
|
2426
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2427
|
+
fields?: string;
|
|
2428
|
+
/** 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. */
|
|
2429
|
+
key?: string;
|
|
2430
|
+
/** Required. The name of the KeyRing to get. */
|
|
2431
|
+
name: string;
|
|
2432
|
+
/** OAuth 2.0 token for the current user. */
|
|
2433
|
+
oauth_token?: string;
|
|
2434
|
+
/** Returns response with indentations and line breaks. */
|
|
2435
|
+
prettyPrint?: boolean;
|
|
2436
|
+
/** 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. */
|
|
2437
|
+
quotaUser?: string;
|
|
2438
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2439
|
+
upload_protocol?: string;
|
|
2440
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2441
|
+
uploadType?: string;
|
|
2442
|
+
}): Request<KeyRing>;
|
|
2443
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
2444
|
+
getIamPolicy(request?: {
|
|
2445
|
+
/** V1 error format. */
|
|
2446
|
+
"$.xgafv"?: string;
|
|
2447
|
+
/** OAuth access token. */
|
|
2448
|
+
access_token?: string;
|
|
2449
|
+
/** Data format for response. */
|
|
2450
|
+
alt?: string;
|
|
2451
|
+
/** JSONP */
|
|
2452
|
+
callback?: string;
|
|
2453
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2454
|
+
fields?: string;
|
|
2455
|
+
/** 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. */
|
|
2456
|
+
key?: string;
|
|
2457
|
+
/** OAuth 2.0 token for the current user. */
|
|
2458
|
+
oauth_token?: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
2461
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
|
|
2462
|
+
* in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
|
|
2463
|
+
* role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
2464
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
2465
|
+
*/
|
|
2466
|
+
"options.requestedPolicyVersion"?: number;
|
|
2467
|
+
/** Returns response with indentations and line breaks. */
|
|
2468
|
+
prettyPrint?: boolean;
|
|
2469
|
+
/** 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. */
|
|
2470
|
+
quotaUser?: string;
|
|
2471
|
+
/**
|
|
2472
|
+
* 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
|
|
2473
|
+
* field.
|
|
2474
|
+
*/
|
|
2475
|
+
resource: string;
|
|
2476
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2477
|
+
upload_protocol?: string;
|
|
2478
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2479
|
+
uploadType?: string;
|
|
2480
|
+
}): Request<Policy>;
|
|
2481
|
+
/** Lists KeyRings. */
|
|
2482
|
+
list(request?: {
|
|
2483
|
+
/** V1 error format. */
|
|
2484
|
+
"$.xgafv"?: string;
|
|
2485
|
+
/** OAuth access token. */
|
|
2486
|
+
access_token?: string;
|
|
2487
|
+
/** Data format for response. */
|
|
2488
|
+
alt?: string;
|
|
2489
|
+
/** JSONP */
|
|
2490
|
+
callback?: string;
|
|
2491
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2492
|
+
fields?: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list
|
|
2495
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
2496
|
+
*/
|
|
2497
|
+
filter?: string;
|
|
2498
|
+
/** 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. */
|
|
2499
|
+
key?: string;
|
|
2500
|
+
/** OAuth 2.0 token for the current user. */
|
|
2501
|
+
oauth_token?: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list
|
|
2504
|
+
* results](https://cloud.google.com/kms/docs/sorting-and-filtering).
|
|
2505
|
+
*/
|
|
2506
|
+
orderBy?: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the
|
|
2509
|
+
* ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
|
2510
|
+
*/
|
|
2511
|
+
pageSize?: number;
|
|
2512
|
+
/** Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. */
|
|
2513
|
+
pageToken?: string;
|
|
2514
|
+
/** Required. The resource name of the location associated with the KeyRings, in the format `projects/*/locations/*`. */
|
|
2515
|
+
parent: string;
|
|
2516
|
+
/** Returns response with indentations and line breaks. */
|
|
2517
|
+
prettyPrint?: boolean;
|
|
2518
|
+
/** 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. */
|
|
2519
|
+
quotaUser?: string;
|
|
2520
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2521
|
+
upload_protocol?: string;
|
|
2522
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2523
|
+
uploadType?: string;
|
|
2524
|
+
}): Request<ListKeyRingsResponse>;
|
|
2525
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
2526
|
+
setIamPolicy(request: {
|
|
2527
|
+
/** V1 error format. */
|
|
2528
|
+
"$.xgafv"?: string;
|
|
2529
|
+
/** OAuth access token. */
|
|
2530
|
+
access_token?: string;
|
|
2531
|
+
/** Data format for response. */
|
|
2532
|
+
alt?: string;
|
|
2533
|
+
/** JSONP */
|
|
2534
|
+
callback?: string;
|
|
2535
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2536
|
+
fields?: string;
|
|
2537
|
+
/** 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. */
|
|
2538
|
+
key?: string;
|
|
2539
|
+
/** OAuth 2.0 token for the current user. */
|
|
2540
|
+
oauth_token?: string;
|
|
2541
|
+
/** Returns response with indentations and line breaks. */
|
|
2542
|
+
prettyPrint?: boolean;
|
|
2543
|
+
/** 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. */
|
|
2544
|
+
quotaUser?: string;
|
|
2545
|
+
/**
|
|
2546
|
+
* 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
|
|
2547
|
+
* field.
|
|
2548
|
+
*/
|
|
2549
|
+
resource: string;
|
|
2550
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2551
|
+
upload_protocol?: string;
|
|
2552
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2553
|
+
uploadType?: string;
|
|
2554
|
+
},
|
|
2555
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
2556
|
+
/**
|
|
2557
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
2558
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
2559
|
+
*/
|
|
2560
|
+
testIamPermissions(request: {
|
|
2561
|
+
/** V1 error format. */
|
|
2562
|
+
"$.xgafv"?: string;
|
|
2563
|
+
/** OAuth access token. */
|
|
2564
|
+
access_token?: string;
|
|
2565
|
+
/** Data format for response. */
|
|
2566
|
+
alt?: string;
|
|
2567
|
+
/** JSONP */
|
|
2568
|
+
callback?: string;
|
|
2569
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2570
|
+
fields?: string;
|
|
2571
|
+
/** 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. */
|
|
2572
|
+
key?: string;
|
|
2573
|
+
/** OAuth 2.0 token for the current user. */
|
|
2574
|
+
oauth_token?: string;
|
|
2575
|
+
/** Returns response with indentations and line breaks. */
|
|
2576
|
+
prettyPrint?: boolean;
|
|
2577
|
+
/** 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. */
|
|
2578
|
+
quotaUser?: string;
|
|
2579
|
+
/**
|
|
2580
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
2581
|
+
* this field.
|
|
2582
|
+
*/
|
|
2583
|
+
resource: string;
|
|
2584
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2585
|
+
upload_protocol?: string;
|
|
2586
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2587
|
+
uploadType?: string;
|
|
2588
|
+
},
|
|
2589
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
2590
|
+
cryptoKeys: CryptoKeysResource;
|
|
2591
|
+
importJobs: ImportJobsResource;
|
|
2592
|
+
}
|
|
2593
|
+
interface LocationsResource {
|
|
2594
|
+
/** Generate random bytes using the Cloud KMS randomness source in the provided location. */
|
|
2595
|
+
generateRandomBytes(request: {
|
|
2596
|
+
/** V1 error format. */
|
|
2597
|
+
"$.xgafv"?: string;
|
|
2598
|
+
/** OAuth access token. */
|
|
2599
|
+
access_token?: string;
|
|
2600
|
+
/** Data format for response. */
|
|
2601
|
+
alt?: string;
|
|
2602
|
+
/** JSONP */
|
|
2603
|
+
callback?: string;
|
|
2604
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2605
|
+
fields?: string;
|
|
2606
|
+
/** 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. */
|
|
2607
|
+
key?: string;
|
|
2608
|
+
/** The project-specific location in which to generate random bytes. For example, "projects/my-project/locations/us-central1". */
|
|
2609
|
+
location: string;
|
|
2610
|
+
/** OAuth 2.0 token for the current user. */
|
|
2611
|
+
oauth_token?: string;
|
|
2612
|
+
/** Returns response with indentations and line breaks. */
|
|
2613
|
+
prettyPrint?: boolean;
|
|
2614
|
+
/** 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. */
|
|
2615
|
+
quotaUser?: string;
|
|
2616
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2617
|
+
upload_protocol?: string;
|
|
2618
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2619
|
+
uploadType?: string;
|
|
2620
|
+
/** Request body */
|
|
2621
|
+
resource: GenerateRandomBytesRequest;
|
|
2622
|
+
}): Request<GenerateRandomBytesResponse>;
|
|
2623
|
+
generateRandomBytes(request: {
|
|
2624
|
+
/** V1 error format. */
|
|
2625
|
+
"$.xgafv"?: string;
|
|
2626
|
+
/** OAuth access token. */
|
|
2627
|
+
access_token?: string;
|
|
2628
|
+
/** Data format for response. */
|
|
2629
|
+
alt?: string;
|
|
2630
|
+
/** JSONP */
|
|
2631
|
+
callback?: string;
|
|
2632
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2633
|
+
fields?: string;
|
|
2634
|
+
/** 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. */
|
|
2635
|
+
key?: string;
|
|
2636
|
+
/** The project-specific location in which to generate random bytes. For example, "projects/my-project/locations/us-central1". */
|
|
2637
|
+
location: string;
|
|
2638
|
+
/** OAuth 2.0 token for the current user. */
|
|
2639
|
+
oauth_token?: string;
|
|
2640
|
+
/** Returns response with indentations and line breaks. */
|
|
2641
|
+
prettyPrint?: boolean;
|
|
2642
|
+
/** 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. */
|
|
2643
|
+
quotaUser?: string;
|
|
2644
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2645
|
+
upload_protocol?: string;
|
|
2646
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2647
|
+
uploadType?: string;
|
|
2648
|
+
},
|
|
2649
|
+
body: GenerateRandomBytesRequest): Request<GenerateRandomBytesResponse>;
|
|
2650
|
+
/** Gets information about a location. */
|
|
2651
|
+
get(request?: {
|
|
2652
|
+
/** V1 error format. */
|
|
2653
|
+
"$.xgafv"?: string;
|
|
2654
|
+
/** OAuth access token. */
|
|
2655
|
+
access_token?: string;
|
|
2656
|
+
/** Data format for response. */
|
|
2657
|
+
alt?: string;
|
|
2658
|
+
/** JSONP */
|
|
2659
|
+
callback?: string;
|
|
2660
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2661
|
+
fields?: string;
|
|
2662
|
+
/** 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. */
|
|
2663
|
+
key?: string;
|
|
2664
|
+
/** Resource name for the location. */
|
|
2665
|
+
name: string;
|
|
2666
|
+
/** OAuth 2.0 token for the current user. */
|
|
2667
|
+
oauth_token?: string;
|
|
2668
|
+
/** Returns response with indentations and line breaks. */
|
|
2669
|
+
prettyPrint?: boolean;
|
|
2670
|
+
/** 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. */
|
|
2671
|
+
quotaUser?: string;
|
|
2672
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2673
|
+
upload_protocol?: string;
|
|
2674
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2675
|
+
uploadType?: string;
|
|
2676
|
+
}): Request<Location>;
|
|
2677
|
+
/** Lists information about the supported locations for this service. */
|
|
2678
|
+
list(request?: {
|
|
2679
|
+
/** V1 error format. */
|
|
2680
|
+
"$.xgafv"?: string;
|
|
2681
|
+
/** OAuth access token. */
|
|
2682
|
+
access_token?: string;
|
|
2683
|
+
/** Data format for response. */
|
|
2684
|
+
alt?: string;
|
|
2685
|
+
/** JSONP */
|
|
2686
|
+
callback?: string;
|
|
2687
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2688
|
+
fields?: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
|
|
2691
|
+
* [AIP-160](https://google.aip.dev/160).
|
|
2692
|
+
*/
|
|
2693
|
+
filter?: string;
|
|
2694
|
+
/** 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. */
|
|
2695
|
+
key?: string;
|
|
2696
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
2697
|
+
name: string;
|
|
2698
|
+
/** OAuth 2.0 token for the current user. */
|
|
2699
|
+
oauth_token?: string;
|
|
2700
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
2701
|
+
pageSize?: number;
|
|
2702
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
2703
|
+
pageToken?: string;
|
|
2704
|
+
/** Returns response with indentations and line breaks. */
|
|
2705
|
+
prettyPrint?: boolean;
|
|
2706
|
+
/** 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. */
|
|
2707
|
+
quotaUser?: string;
|
|
2708
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2709
|
+
upload_protocol?: string;
|
|
2710
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2711
|
+
uploadType?: string;
|
|
2712
|
+
}): Request<ListLocationsResponse>;
|
|
2713
|
+
ekmConnections: EkmConnectionsResource;
|
|
2714
|
+
keyRings: KeyRingsResource;
|
|
2715
|
+
}
|
|
2716
|
+
interface ProjectsResource {
|
|
2717
|
+
locations: LocationsResource;
|
|
2718
|
+
}
|
|
2719
|
+
|
|
2720
|
+
const projects: ProjectsResource;
|
|
2721
|
+
}
|
|
2722
|
+
}
|