Skip to content

Commit a2867a0

Browse files
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>

0 commit comments

Comments
 (0)