Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit a2867a0

Browse files
committedMar 14, 2023
feat(cloudkms): update the api
#### cloudkms:v1 The following keys were added: - resources.projects.resources.locations.methods.getEkmConfig (Total Keys: 11) - resources.projects.resources.locations.methods.updateEkmConfig (Total Keys: 15) - schemas.CryptoKeyVersion.properties.externalDestructionFailureReason (Total Keys: 2) - schemas.CryptoKeyVersion.properties.generationFailureReason (Total Keys: 2) - schemas.EkmConfig (Total Keys: 5) - schemas.EkmConnection.properties.cryptoSpacePath.type (Total Keys: 1) - schemas.EkmConnection.properties.keyManagementMode.type (Total Keys: 1)
1 parent 88714e9 commit a2867a0

5 files changed

+213
-3
lines changed
 

‎docs/dyn/cloudkms_v1.projects.locations.ekmConnections.html

+12
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ <h3>Method Details</h3>
118118

119119
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
120120
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
121+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
121122
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
123+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
122124
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
123125
&quot;serviceResolvers&quot;: [ # 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.
124126
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -155,7 +157,9 @@ <h3>Method Details</h3>
155157

156158
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
157159
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
160+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
158161
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
162+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
159163
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
160164
&quot;serviceResolvers&quot;: [ # 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.
161165
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -198,7 +202,9 @@ <h3>Method Details</h3>
198202

199203
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
200204
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
205+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
201206
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
207+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
202208
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
203209
&quot;serviceResolvers&quot;: [ # 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.
204210
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -295,7 +301,9 @@ <h3>Method Details</h3>
295301
&quot;ekmConnections&quot;: [ # The list of EkmConnections.
296302
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
297303
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
304+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
298305
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
306+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
299307
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
300308
&quot;serviceResolvers&quot;: [ # 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.
301309
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -351,7 +359,9 @@ <h3>Method Details</h3>
351359

352360
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
353361
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
362+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
354363
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
364+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
355365
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
356366
&quot;serviceResolvers&quot;: [ # 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.
357367
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
@@ -388,7 +398,9 @@ <h3>Method Details</h3>
388398

389399
{ # An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.
390400
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the EkmConnection was created.
401+
&quot;cryptoSpacePath&quot;: &quot;A String&quot;, # Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
391402
&quot;etag&quot;: &quot;A String&quot;, # Optional. Etag of the currently stored EkmConnection.
403+
&quot;keyManagementMode&quot;: &quot;A String&quot;, # Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
392404
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
393405
&quot;serviceResolvers&quot;: [ # 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.
394406
{ # A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.

‎docs/dyn/cloudkms_v1.projects.locations.html

+55
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,18 @@ <h2>Instance Methods</h2>
9898
<p class="toc_element">
9999
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
100100
<p class="firstline">Gets information about a location.</p>
101+
<p class="toc_element">
102+
<code><a href="#getEkmConfig">getEkmConfig(name, x__xgafv=None)</a></code></p>
103+
<p class="firstline">Returns the EkmConfig singleton resource for a given project and location.</p>
101104
<p class="toc_element">
102105
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
103106
<p class="firstline">Lists information about the supported locations for this service.</p>
104107
<p class="toc_element">
105108
<code><a href="#list_next">list_next()</a></code></p>
106109
<p class="firstline">Retrieves the next page of results.</p>
110+
<p class="toc_element">
111+
<code><a href="#updateEkmConfig">updateEkmConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
112+
<p class="firstline">Updates the EkmConfig singleton resource for a given project and location.</p>
107113
<h3>Method Details</h3>
108114
<div class="method">
109115
<code class="details" id="close">close()</code>
@@ -165,6 +171,26 @@ <h3>Method Details</h3>
165171
}</pre>
166172
</div>
167173

174+
<div class="method">
175+
<code class="details" id="getEkmConfig">getEkmConfig(name, x__xgafv=None)</code>
176+
<pre>Returns the EkmConfig singleton resource for a given project and location.
177+
178+
Args:
179+
name: string, Required. The name of the EkmConfig to get. (required)
180+
x__xgafv: string, V1 error format.
181+
Allowed values
182+
1 - v1 error format
183+
2 - v2 error format
184+
185+
Returns:
186+
An object of the form:
187+
188+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
189+
&quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
190+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
191+
}</pre>
192+
</div>
193+
168194
<div class="method">
169195
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
170196
<pre>Lists information about the supported locations for this service.
@@ -214,4 +240,33 @@ <h3>Method Details</h3>
214240
</pre>
215241
</div>
216242

243+
<div class="method">
244+
<code class="details" id="updateEkmConfig">updateEkmConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
245+
<pre>Updates the EkmConfig singleton resource for a given project and location.
246+
247+
Args:
248+
name: string, Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`. (required)
249+
body: object, The request body.
250+
The object takes the form of:
251+
252+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
253+
&quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
254+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
255+
}
256+
257+
updateMask: string, Required. List of fields to be updated in this request.
258+
x__xgafv: string, V1 error format.
259+
Allowed values
260+
1 - v1 error format
261+
2 - v2 error format
262+
263+
Returns:
264+
An object of the form:
265+
266+
{ # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
267+
&quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
268+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
269+
}</pre>
270+
</div>
271+
217272
</body></html>

‎docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html

+18
Original file line numberDiff line numberDiff line change
@@ -219,11 +219,13 @@ <h3>Method Details</h3>
219219
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
220220
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
221221
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
222+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
222223
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
223224
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
224225
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
225226
},
226227
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
228+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
227229
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
228230
&quot;importJob&quot;: &quot;A String&quot;, # 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.
229231
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -261,11 +263,13 @@ <h3>Method Details</h3>
261263
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
262264
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
263265
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
266+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
264267
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
265268
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
266269
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
267270
},
268271
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
272+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
269273
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
270274
&quot;importJob&quot;: &quot;A String&quot;, # 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.
271275
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -316,11 +320,13 @@ <h3>Method Details</h3>
316320
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
317321
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
318322
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
323+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
319324
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
320325
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
321326
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
322327
},
323328
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
329+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
324330
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
325331
&quot;importJob&quot;: &quot;A String&quot;, # 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.
326332
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -365,11 +371,13 @@ <h3>Method Details</h3>
365371
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
366372
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
367373
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
374+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
368375
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
369376
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
370377
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
371378
},
372379
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
380+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
373381
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
374382
&quot;importJob&quot;: &quot;A String&quot;, # 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.
375383
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -448,11 +456,13 @@ <h3>Method Details</h3>
448456
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
449457
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
450458
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
459+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
451460
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
452461
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
453462
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
454463
},
455464
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
465+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
456466
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
457467
&quot;importJob&quot;: &quot;A String&quot;, # 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.
458468
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -507,11 +517,13 @@ <h3>Method Details</h3>
507517
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
508518
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
509519
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
520+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
510521
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
511522
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
512523
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
513524
},
514525
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
526+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
515527
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
516528
&quot;importJob&quot;: &quot;A String&quot;, # 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.
517529
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -634,11 +646,13 @@ <h3>Method Details</h3>
634646
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
635647
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
636648
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
649+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
637650
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
638651
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
639652
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
640653
},
641654
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
655+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
642656
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
643657
&quot;importJob&quot;: &quot;A String&quot;, # 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.
644658
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -677,11 +691,13 @@ <h3>Method Details</h3>
677691
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
678692
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
679693
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
694+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
680695
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
681696
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
682697
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
683698
},
684699
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
700+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
685701
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
686702
&quot;importJob&quot;: &quot;A String&quot;, # 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.
687703
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -732,11 +748,13 @@ <h3>Method Details</h3>
732748
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
733749
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
734750
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
751+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
735752
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
736753
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
737754
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
738755
},
739756
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
757+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
740758
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
741759
&quot;importJob&quot;: &quot;A String&quot;, # 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.
742760
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.

‎docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html

+14
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,13 @@ <h3>Method Details</h3>
160160
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
161161
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
162162
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
163+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
163164
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
164165
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
165166
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
166167
},
167168
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
169+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
168170
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
169171
&quot;importJob&quot;: &quot;A String&quot;, # 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.
170172
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -221,11 +223,13 @@ <h3>Method Details</h3>
221223
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
222224
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
223225
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
226+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
224227
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
225228
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
226229
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
227230
},
228231
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
232+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
229233
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
230234
&quot;importJob&quot;: &quot;A String&quot;, # 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.
231235
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -353,11 +357,13 @@ <h3>Method Details</h3>
353357
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
354358
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
355359
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
360+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
356361
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
357362
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
358363
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
359364
},
360365
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
366+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
361367
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
362368
&quot;importJob&quot;: &quot;A String&quot;, # 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.
363369
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -477,11 +483,13 @@ <h3>Method Details</h3>
477483
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
478484
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
479485
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
486+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
480487
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
481488
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
482489
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
483490
},
484491
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
492+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
485493
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
486494
&quot;importJob&quot;: &quot;A String&quot;, # 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.
487495
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -556,11 +564,13 @@ <h3>Method Details</h3>
556564
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
557565
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
558566
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
567+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
559568
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
560569
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
561570
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
562571
},
563572
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
573+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
564574
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
565575
&quot;importJob&quot;: &quot;A String&quot;, # 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.
566576
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -616,11 +626,13 @@ <h3>Method Details</h3>
616626
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
617627
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
618628
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
629+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
619630
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
620631
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
621632
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
622633
},
623634
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
635+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
624636
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
625637
&quot;importJob&quot;: &quot;A String&quot;, # 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.
626638
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.
@@ -804,11 +816,13 @@ <h3>Method Details</h3>
804816
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion was created.
805817
&quot;destroyEventTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was destroyed. Only present if state is DESTROYED.
806818
&quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
819+
&quot;externalDestructionFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
807820
&quot;externalProtectionLevelOptions&quot;: { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
808821
&quot;ekmConnectionKeyPath&quot;: &quot;A String&quot;, # The path to the external key material on the EKM when using EkmConnection e.g., &quot;v0/my/key&quot;. Set this field instead of external_key_uri when using an EkmConnection.
809822
&quot;externalKeyUri&quot;: &quot;A String&quot;, # The URI for an external resource that this CryptoKeyVersion represents.
810823
},
811824
&quot;generateTime&quot;: &quot;A String&quot;, # Output only. The time this CryptoKeyVersion&#x27;s key material was generated.
825+
&quot;generationFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
812826
&quot;importFailureReason&quot;: &quot;A String&quot;, # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
813827
&quot;importJob&quot;: &quot;A String&quot;, # 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.
814828
&quot;importTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKeyVersion&#x27;s key material was most recently imported.

‎googleapiclient/discovery_cache/documents/cloudkms.v1.json

+114-3
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,32 @@
167167
"https://www.googleapis.com/auth/cloudkms"
168168
]
169169
},
170+
"getEkmConfig": {
171+
"description": "Returns the EkmConfig singleton resource for a given project and location.",
172+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ekmConfig",
173+
"httpMethod": "GET",
174+
"id": "cloudkms.projects.locations.getEkmConfig",
175+
"parameterOrder": [
176+
"name"
177+
],
178+
"parameters": {
179+
"name": {
180+
"description": "Required. The name of the EkmConfig to get.",
181+
"location": "path",
182+
"pattern": "^projects/[^/]+/locations/[^/]+/ekmConfig$",
183+
"required": true,
184+
"type": "string"
185+
}
186+
},
187+
"path": "v1/{+name}",
188+
"response": {
189+
"$ref": "EkmConfig"
190+
},
191+
"scopes": [
192+
"https://www.googleapis.com/auth/cloud-platform",
193+
"https://www.googleapis.com/auth/cloudkms"
194+
]
195+
},
170196
"list": {
171197
"description": "Lists information about the supported locations for this service.",
172198
"flatPath": "v1/projects/{projectsId}/locations",
@@ -208,6 +234,41 @@
208234
"https://www.googleapis.com/auth/cloud-platform",
209235
"https://www.googleapis.com/auth/cloudkms"
210236
]
237+
},
238+
"updateEkmConfig": {
239+
"description": "Updates the EkmConfig singleton resource for a given project and location.",
240+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ekmConfig",
241+
"httpMethod": "PATCH",
242+
"id": "cloudkms.projects.locations.updateEkmConfig",
243+
"parameterOrder": [
244+
"name"
245+
],
246+
"parameters": {
247+
"name": {
248+
"description": "Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.",
249+
"location": "path",
250+
"pattern": "^projects/[^/]+/locations/[^/]+/ekmConfig$",
251+
"required": true,
252+
"type": "string"
253+
},
254+
"updateMask": {
255+
"description": "Required. List of fields to be updated in this request.",
256+
"format": "google-fieldmask",
257+
"location": "query",
258+
"type": "string"
259+
}
260+
},
261+
"path": "v1/{+name}",
262+
"request": {
263+
"$ref": "EkmConfig"
264+
},
265+
"response": {
266+
"$ref": "EkmConfig"
267+
},
268+
"scopes": [
269+
"https://www.googleapis.com/auth/cloud-platform",
270+
"https://www.googleapis.com/auth/cloudkms"
271+
]
211272
}
212273
},
213274
"resources": {
@@ -1676,7 +1737,7 @@
16761737
}
16771738
}
16781739
},
1679-
"revision": "20230224",
1740+
"revision": "20230307",
16801741
"rootUrl": "https://cloudkms.googleapis.com/",
16811742
"schemas": {
16821743
"AsymmetricDecryptRequest": {
@@ -2132,6 +2193,11 @@
21322193
"readOnly": true,
21332194
"type": "string"
21342195
},
2196+
"externalDestructionFailureReason": {
2197+
"description": "Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.",
2198+
"readOnly": true,
2199+
"type": "string"
2200+
},
21352201
"externalProtectionLevelOptions": {
21362202
"$ref": "ExternalProtectionLevelOptions",
21372203
"description": "ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels."
@@ -2142,6 +2208,11 @@
21422208
"readOnly": true,
21432209
"type": "string"
21442210
},
2211+
"generationFailureReason": {
2212+
"description": "Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.",
2213+
"readOnly": true,
2214+
"type": "string"
2215+
},
21452216
"importFailureReason": {
21462217
"description": "Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.",
21472218
"readOnly": true,
@@ -2197,7 +2268,10 @@
21972268
"DESTROYED",
21982269
"DESTROY_SCHEDULED",
21992270
"PENDING_IMPORT",
2200-
"IMPORT_FAILED"
2271+
"IMPORT_FAILED",
2272+
"GENERATION_FAILED",
2273+
"PENDING_EXTERNAL_DESTRUCTION",
2274+
"EXTERNAL_DESTRUCTION_FAILED"
22012275
],
22022276
"enumDescriptions": [
22032277
"Not specified.",
@@ -2207,7 +2281,10 @@
22072281
"This version is destroyed, and the key material is no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.",
22082282
"This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.",
22092283
"This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.",
2210-
"This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason."
2284+
"This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.",
2285+
"This version was not generated successfully. It may not be used, enabled, disabled, or destroyed. Additional details can be found in CryptoKeyVersion.generation_failure_reason.",
2286+
"This version was destroyed, and it may not be used or enabled again. Cloud KMS is waiting for the corresponding key material residing in an external key manager to be destroyed.",
2287+
"This version was destroyed, and it may not be used or enabled again. However, Cloud KMS could not confirm that the corresponding key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason."
22112288
],
22122289
"type": "string"
22132290
}
@@ -2399,6 +2476,22 @@
23992476
},
24002477
"type": "object"
24012478
},
2479+
"EkmConfig": {
2480+
"description": "An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.",
2481+
"id": "EkmConfig",
2482+
"properties": {
2483+
"defaultEkmConnection": {
2484+
"description": "Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.",
2485+
"type": "string"
2486+
},
2487+
"name": {
2488+
"description": "Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.",
2489+
"readOnly": true,
2490+
"type": "string"
2491+
}
2492+
},
2493+
"type": "object"
2494+
},
24022495
"EkmConnection": {
24032496
"description": "An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.",
24042497
"id": "EkmConnection",
@@ -2409,10 +2502,28 @@
24092502
"readOnly": true,
24102503
"type": "string"
24112504
},
2505+
"cryptoSpacePath": {
2506+
"description": "Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.",
2507+
"type": "string"
2508+
},
24122509
"etag": {
24132510
"description": "Optional. Etag of the currently stored EkmConnection.",
24142511
"type": "string"
24152512
},
2513+
"keyManagementMode": {
2514+
"description": "Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.",
2515+
"enum": [
2516+
"KEY_MANAGEMENT_MODE_UNSPECIFIED",
2517+
"MANUAL",
2518+
"CLOUD_KMS"
2519+
],
2520+
"enumDescriptions": [
2521+
"Not specified.",
2522+
"EKM-side key management operations on CryptoKeys created with this EkmConnection must be initiated from the EKM directly and cannot be performed from Cloud KMS. This means that: * When creating a CryptoKeyVersion associated with this EkmConnection, the caller must supply the key path of pre-existing external key material that will be linked to the CryptoKeyVersion. * Destruction of external key material cannot be requested via the Cloud KMS API and must be performed directly in the EKM. * Automatic rotation of key material is not supported.",
2523+
"All CryptoKeys created with this EkmConnection use EKM-side key management operations initiated from Cloud KMS. This means that: * When a CryptoKeyVersion associated with this EkmConnection is created, the EKM automatically generates new key material and a new key path. The caller cannot supply the key path of pre-existing external key material. * Destruction of external key material associated with this EkmConnection can be requested by calling DestroyCryptoKeyVersion. * Automatic rotation of key material is supported."
2524+
],
2525+
"type": "string"
2526+
},
24162527
"name": {
24172528
"description": "Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.",
24182529
"readOnly": true,

0 commit comments

Comments
 (0)
Please sign in to comment.