Skip to content

Commit 7dc2784

Browse files
feat(cloudkms): update the api
#### cloudkms:v1 The following keys were added: - resources.projects.resources.locations.methods.generateRandomBytes (Total Keys: 12) - schemas.CryptoKey.properties.destroyScheduledDuration (Total Keys: 2) - schemas.CryptoKey.properties.importOnly.type (Total Keys: 1) - schemas.GenerateRandomBytesRequest (Total Keys: 5) - schemas.GenerateRandomBytesResponse (Total Keys: 6)
1 parent 8e59148 commit 7dc2784

File tree

3 files changed

+129
-1
lines changed

3 files changed

+129
-1
lines changed

docs/dyn/cloudkms_v1.projects.locations.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ <h2>Instance Methods</h2>
8282
<p class="toc_element">
8383
<code><a href="#close">close()</a></code></p>
8484
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<code><a href="#generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</a></code></p>
87+
<p class="firstline">Generate random bytes using the Cloud KMS randomness source in the provided location.</p>
8588
<p class="toc_element">
8689
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8790
<p class="firstline">Gets information about a location.</p>
@@ -97,6 +100,34 @@ <h3>Method Details</h3>
97100
<pre>Close httplib2 connections.</pre>
98101
</div>
99102

103+
<div class="method">
104+
<code class="details" id="generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</code>
105+
<pre>Generate random bytes using the Cloud KMS randomness source in the provided location.
106+
107+
Args:
108+
location: string, The project-specific location in which to generate random bytes. For example, &quot;projects/my-project/locations/us-central1&quot;. (required)
109+
body: object, The request body.
110+
The object takes the form of:
111+
112+
{ # Request message for KeyManagementService.GenerateRandomBytes.
113+
&quot;lengthBytes&quot;: 42, # The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.
114+
&quot;protectionLevel&quot;: &quot;A String&quot;, # The ProtectionLevel to use when generating the random data. Defaults to SOFTWARE.
115+
}
116+
117+
x__xgafv: string, V1 error format.
118+
Allowed values
119+
1 - v1 error format
120+
2 - v2 error format
121+
122+
Returns:
123+
An object of the form:
124+
125+
{ # Response message for KeyManagementService.GenerateRandomBytes.
126+
&quot;data&quot;: &quot;A String&quot;, # The generated data.
127+
&quot;dataCrc32c&quot;: &quot;A String&quot;, # Integrity verification field. A CRC32C checksum of the returned GenerateRandomBytesResponse.data. An integrity check of GenerateRandomBytesResponse.data can be performed by 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 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 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 this type.
128+
}</pre>
129+
</div>
130+
100131
<div class="method">
101132
<code class="details" id="get">get(name, x__xgafv=None)</code>
102133
<pre>Gets information about a location.

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,8 @@ <h3>Method Details</h3>
132132

133133
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
134134
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
135+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
136+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
135137
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
136138
&quot;a_key&quot;: &quot;A String&quot;,
137139
},
@@ -188,6 +190,8 @@ <h3>Method Details</h3>
188190

189191
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
190192
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
193+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
194+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
191195
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
192196
&quot;a_key&quot;: &quot;A String&quot;,
193197
},
@@ -315,6 +319,8 @@ <h3>Method Details</h3>
315319

316320
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
317321
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
322+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
323+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
318324
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
319325
&quot;a_key&quot;: &quot;A String&quot;,
320326
},
@@ -434,6 +440,8 @@ <h3>Method Details</h3>
434440
&quot;cryptoKeys&quot;: [ # The list of CryptoKeys.
435441
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
436442
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
443+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
444+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
437445
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
438446
&quot;a_key&quot;: &quot;A String&quot;,
439447
},
@@ -508,6 +516,8 @@ <h3>Method Details</h3>
508516

509517
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
510518
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
519+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
520+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
511521
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
512522
&quot;a_key&quot;: &quot;A String&quot;,
513523
},
@@ -563,6 +573,8 @@ <h3>Method Details</h3>
563573

564574
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
565575
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
576+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
577+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
566578
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
567579
&quot;a_key&quot;: &quot;A String&quot;,
568580
},
@@ -746,6 +758,8 @@ <h3>Method Details</h3>
746758

747759
{ # A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
748760
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this CryptoKey was created.
761+
&quot;destroyScheduledDuration&quot;: &quot;A String&quot;, # 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 duration is 24 hours.
762+
&quot;importOnly&quot;: True or False, # Immutable. Whether this key may contain imported versions only.
749763
&quot;labels&quot;: { # Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
750764
&quot;a_key&quot;: &quot;A String&quot;,
751765
},

googleapiclient/discovery_cache/documents/cloudkms.v1.json

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,35 @@
112112
"resources": {
113113
"locations": {
114114
"methods": {
115+
"generateRandomBytes": {
116+
"description": "Generate random bytes using the Cloud KMS randomness source in the provided location.",
117+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateRandomBytes",
118+
"httpMethod": "POST",
119+
"id": "cloudkms.projects.locations.generateRandomBytes",
120+
"parameterOrder": [
121+
"location"
122+
],
123+
"parameters": {
124+
"location": {
125+
"description": "The project-specific location in which to generate random bytes. For example, \"projects/my-project/locations/us-central1\".",
126+
"location": "path",
127+
"pattern": "^projects/[^/]+/locations/[^/]+$",
128+
"required": true,
129+
"type": "string"
130+
}
131+
},
132+
"path": "v1/{+location}:generateRandomBytes",
133+
"request": {
134+
"$ref": "GenerateRandomBytesRequest"
135+
},
136+
"response": {
137+
"$ref": "GenerateRandomBytesResponse"
138+
},
139+
"scopes": [
140+
"https://www.googleapis.com/auth/cloud-platform",
141+
"https://www.googleapis.com/auth/cloudkms"
142+
]
143+
},
115144
"get": {
116145
"description": "Gets information about a location.",
117146
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
@@ -1317,7 +1346,7 @@
13171346
}
13181347
}
13191348
},
1320-
"revision": "20210723",
1349+
"revision": "20210803",
13211350
"rootUrl": "https://cloudkms.googleapis.com/",
13221351
"schemas": {
13231352
"AsymmetricDecryptRequest": {
@@ -1539,6 +1568,15 @@
15391568
"readOnly": true,
15401569
"type": "string"
15411570
},
1571+
"destroyScheduledDuration": {
1572+
"description": "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 duration is 24 hours.",
1573+
"format": "google-duration",
1574+
"type": "string"
1575+
},
1576+
"importOnly": {
1577+
"description": "Immutable. Whether this key may contain imported versions only.",
1578+
"type": "boolean"
1579+
},
15421580
"labels": {
15431581
"additionalProperties": {
15441582
"type": "string"
@@ -2007,6 +2045,51 @@
20072045
},
20082046
"type": "object"
20092047
},
2048+
"GenerateRandomBytesRequest": {
2049+
"description": "Request message for KeyManagementService.GenerateRandomBytes.",
2050+
"id": "GenerateRandomBytesRequest",
2051+
"properties": {
2052+
"lengthBytes": {
2053+
"description": "The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.",
2054+
"format": "int32",
2055+
"type": "integer"
2056+
},
2057+
"protectionLevel": {
2058+
"description": "The ProtectionLevel to use when generating the random data. Defaults to SOFTWARE.",
2059+
"enum": [
2060+
"PROTECTION_LEVEL_UNSPECIFIED",
2061+
"SOFTWARE",
2062+
"HSM",
2063+
"EXTERNAL"
2064+
],
2065+
"enumDescriptions": [
2066+
"Not specified.",
2067+
"Crypto operations are performed in software.",
2068+
"Crypto operations are performed in a Hardware Security Module.",
2069+
"Crypto operations are performed by an external key manager."
2070+
],
2071+
"type": "string"
2072+
}
2073+
},
2074+
"type": "object"
2075+
},
2076+
"GenerateRandomBytesResponse": {
2077+
"description": "Response message for KeyManagementService.GenerateRandomBytes.",
2078+
"id": "GenerateRandomBytesResponse",
2079+
"properties": {
2080+
"data": {
2081+
"description": "The generated data.",
2082+
"format": "byte",
2083+
"type": "string"
2084+
},
2085+
"dataCrc32c": {
2086+
"description": "Integrity verification field. A CRC32C checksum of the returned GenerateRandomBytesResponse.data. An integrity check of GenerateRandomBytesResponse.data can be performed by 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 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 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 this type.",
2087+
"format": "int64",
2088+
"type": "string"
2089+
}
2090+
},
2091+
"type": "object"
2092+
},
20102093
"ImportCryptoKeyVersionRequest": {
20112094
"description": "Request message for KeyManagementService.ImportCryptoKeyVersion.",
20122095
"id": "ImportCryptoKeyVersionRequest",

0 commit comments

Comments
 (0)