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 3d9bd70

Browse files
committedOct 17, 2023
feat(cloudtasks): update the api
#### cloudtasks:v2 The following keys were added: - resources.projects.resources.locations.methods.getCmekConfig (Total Keys: 11) - resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 15) - schemas.CmekConfig (Total Keys: 5) #### cloudtasks:v2beta2 The following keys were deleted: - resources.projects.resources.locations.methods.updateCmekConfig.parameters.locationsId (Total Keys: 3) - resources.projects.resources.locations.methods.updateCmekConfig.parameters.projectsId (Total Keys: 3) The following keys were added: - resources.projects.resources.locations.methods.updateCmekConfig.parameters.name (Total Keys: 4) The following keys were changed: - resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 2) #### cloudtasks:v2beta3 The following keys were deleted: - resources.projects.resources.locations.methods.updateCmekConfig.parameters.locationsId (Total Keys: 3) - resources.projects.resources.locations.methods.updateCmekConfig.parameters.projectsId (Total Keys: 3) The following keys were added: - resources.projects.resources.locations.methods.updateCmekConfig.parameters.name (Total Keys: 4) The following keys were changed: - resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 2)
1 parent fe82cbf commit 3d9bd70

6 files changed

+149
-29
lines changed
 

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

+55
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,18 @@ <h2>Instance Methods</h2>
8585
<p class="toc_element">
8686
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8787
<p class="firstline">Gets information about a location.</p>
88+
<p class="toc_element">
89+
<code><a href="#getCmekConfig">getCmekConfig(name, x__xgafv=None)</a></code></p>
90+
<p class="firstline">Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.</p>
8891
<p class="toc_element">
8992
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
9093
<p class="firstline">Lists information about the supported locations for this service.</p>
9194
<p class="toc_element">
9295
<code><a href="#list_next">list_next()</a></code></p>
9396
<p class="firstline">Retrieves the next page of results.</p>
97+
<p class="toc_element">
98+
<code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
99+
<p class="firstline">Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.</p>
94100
<h3>Method Details</h3>
95101
<div class="method">
96102
<code class="details" id="close">close()</code>
@@ -124,6 +130,26 @@ <h3>Method Details</h3>
124130
}</pre>
125131
</div>
126132

133+
<div class="method">
134+
<code class="details" id="getCmekConfig">getCmekConfig(name, x__xgafv=None)</code>
135+
<pre>Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.
136+
137+
Args:
138+
name: string, Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig` (required)
139+
x__xgafv: string, V1 error format.
140+
Allowed values
141+
1 - v1 error format
142+
2 - v2 error format
143+
144+
Returns:
145+
An object of the form:
146+
147+
{ # CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.
148+
&quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
149+
&quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
150+
}</pre>
151+
</div>
152+
127153
<div class="method">
128154
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
129155
<pre>Lists information about the supported locations for this service.
@@ -173,4 +199,33 @@ <h3>Method Details</h3>
173199
</pre>
174200
</div>
175201

202+
<div class="method">
203+
<code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
204+
<pre>Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
205+
206+
Args:
207+
name: string, Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
208+
body: object, The request body.
209+
The object takes the form of:
210+
211+
{ # CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.
212+
&quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
213+
&quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
214+
}
215+
216+
updateMask: string, List of fields to be updated in this request.
217+
x__xgafv: string, V1 error format.
218+
Allowed values
219+
1 - v1 error format
220+
2 - v2 error format
221+
222+
Returns:
223+
An object of the form:
224+
225+
{ # CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.
226+
&quot;kmsKey&quot;: &quot;A String&quot;, # Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues &amp; Tasks in the region. Setting this as blank will turn off CMEK encryption.
227+
&quot;name&quot;: &quot;A String&quot;, # Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
228+
}</pre>
229+
</div>
230+
176231
</body></html>

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
9595
<code><a href="#list_next">list_next()</a></code></p>
9696
<p class="firstline">Retrieves the next page of results.</p>
9797
<p class="toc_element">
98-
<code><a href="#updateCmekConfig">updateCmekConfig(projectsId, locationsId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
98+
<code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
9999
<p class="firstline">Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.</p>
100100
<h3>Method Details</h3>
101101
<div class="method">
@@ -200,12 +200,11 @@ <h3>Method Details</h3>
200200
</div>
201201

202202
<div class="method">
203-
<code class="details" id="updateCmekConfig">updateCmekConfig(projectsId, locationsId, body=None, updateMask=None, x__xgafv=None)</code>
203+
<code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
204204
<pre>Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
205205

206206
Args:
207-
projectsId: string, A parameter (required)
208-
locationsId: string, A parameter (required)
207+
name: string, Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
209208
body: object, The request body.
210209
The object takes the form of:
211210

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
9595
<code><a href="#list_next">list_next()</a></code></p>
9696
<p class="firstline">Retrieves the next page of results.</p>
9797
<p class="toc_element">
98-
<code><a href="#updateCmekConfig">updateCmekConfig(projectsId, locationsId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
98+
<code><a href="#updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
9999
<p class="firstline">Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.</p>
100100
<h3>Method Details</h3>
101101
<div class="method">
@@ -200,12 +200,11 @@ <h3>Method Details</h3>
200200
</div>
201201

202202
<div class="method">
203-
<code class="details" id="updateCmekConfig">updateCmekConfig(projectsId, locationsId, body=None, updateMask=None, x__xgafv=None)</code>
203+
<code class="details" id="updateCmekConfig">updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
204204
<pre>Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.
205205

206206
Args:
207-
projectsId: string, A parameter (required)
208-
locationsId: string, A parameter (required)
207+
name: string, Output only. The config resource name which includes the project and location and must end in &#x27;cmekConfig&#x27;, in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
209208
body: object, The request body.
210209
The object takes the form of:
211210

‎googleapiclient/discovery_cache/documents/cloudtasks.v2.json

+76-1
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,31 @@
134134
"https://www.googleapis.com/auth/cloud-platform"
135135
]
136136
},
137+
"getCmekConfig": {
138+
"description": "Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.",
139+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/cmekConfig",
140+
"httpMethod": "GET",
141+
"id": "cloudtasks.projects.locations.getCmekConfig",
142+
"parameterOrder": [
143+
"name"
144+
],
145+
"parameters": {
146+
"name": {
147+
"description": "Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`",
148+
"location": "path",
149+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
150+
"required": true,
151+
"type": "string"
152+
}
153+
},
154+
"path": "v2/{+name}",
155+
"response": {
156+
"$ref": "CmekConfig"
157+
},
158+
"scopes": [
159+
"https://www.googleapis.com/auth/cloud-platform"
160+
]
161+
},
137162
"list": {
138163
"description": "Lists information about the supported locations for this service.",
139164
"flatPath": "v2/projects/{projectsId}/locations",
@@ -174,6 +199,40 @@
174199
"scopes": [
175200
"https://www.googleapis.com/auth/cloud-platform"
176201
]
202+
},
203+
"updateCmekConfig": {
204+
"description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.",
205+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/cmekConfig",
206+
"httpMethod": "PATCH",
207+
"id": "cloudtasks.projects.locations.updateCmekConfig",
208+
"parameterOrder": [
209+
"name"
210+
],
211+
"parameters": {
212+
"name": {
213+
"description": "Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
214+
"location": "path",
215+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
216+
"required": true,
217+
"type": "string"
218+
},
219+
"updateMask": {
220+
"description": "List of fields to be updated in this request.",
221+
"format": "google-fieldmask",
222+
"location": "query",
223+
"type": "string"
224+
}
225+
},
226+
"path": "v2/{+name}",
227+
"request": {
228+
"$ref": "CmekConfig"
229+
},
230+
"response": {
231+
"$ref": "CmekConfig"
232+
},
233+
"scopes": [
234+
"https://www.googleapis.com/auth/cloud-platform"
235+
]
177236
}
178237
},
179238
"resources": {
@@ -685,7 +744,7 @@
685744
}
686745
}
687746
},
688-
"revision": "20230927",
747+
"revision": "20230929",
689748
"rootUrl": "https://cloudtasks.googleapis.com/",
690749
"schemas": {
691750
"AppEngineHttpRequest": {
@@ -810,6 +869,22 @@
810869
},
811870
"type": "object"
812871
},
872+
"CmekConfig": {
873+
"description": "CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer\u2019s hands.",
874+
"id": "CmekConfig",
875+
"properties": {
876+
"kmsKey": {
877+
"description": "Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.",
878+
"type": "string"
879+
},
880+
"name": {
881+
"description": "Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
882+
"readOnly": true,
883+
"type": "string"
884+
}
885+
},
886+
"type": "object"
887+
},
813888
"CreateTaskRequest": {
814889
"description": "Request message for CreateTask.",
815890
"id": "CreateTaskRequest",

‎googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json

+6-10
Original file line numberDiff line numberDiff line change
@@ -238,17 +238,13 @@
238238
"httpMethod": "PATCH",
239239
"id": "cloudtasks.projects.locations.updateCmekConfig",
240240
"parameterOrder": [
241-
"projectsId",
242-
"locationsId"
241+
"name"
243242
],
244243
"parameters": {
245-
"locationsId": {
246-
"location": "path",
247-
"required": true,
248-
"type": "string"
249-
},
250-
"projectsId": {
244+
"name": {
245+
"description": "Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
251246
"location": "path",
247+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
252248
"required": true,
253249
"type": "string"
254250
},
@@ -259,7 +255,7 @@
259255
"type": "string"
260256
}
261257
},
262-
"path": "v2beta2/projects/{projectsId}/locations/{locationsId}/cmekConfig",
258+
"path": "v2beta2/{+name}",
263259
"request": {
264260
"$ref": "CmekConfig"
265261
},
@@ -939,7 +935,7 @@
939935
}
940936
}
941937
},
942-
"revision": "20230927",
938+
"revision": "20230929",
943939
"rootUrl": "https://cloudtasks.googleapis.com/",
944940
"schemas": {
945941
"AcknowledgeTaskRequest": {

‎googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json

+6-10
Original file line numberDiff line numberDiff line change
@@ -206,17 +206,13 @@
206206
"httpMethod": "PATCH",
207207
"id": "cloudtasks.projects.locations.updateCmekConfig",
208208
"parameterOrder": [
209-
"projectsId",
210-
"locationsId"
209+
"name"
211210
],
212211
"parameters": {
213-
"locationsId": {
214-
"location": "path",
215-
"required": true,
216-
"type": "string"
217-
},
218-
"projectsId": {
212+
"name": {
213+
"description": "Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
219214
"location": "path",
215+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
220216
"required": true,
221217
"type": "string"
222218
},
@@ -227,7 +223,7 @@
227223
"type": "string"
228224
}
229225
},
230-
"path": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig",
226+
"path": "v2beta3/{+name}",
231227
"request": {
232228
"$ref": "CmekConfig"
233229
},
@@ -795,7 +791,7 @@
795791
}
796792
}
797793
},
798-
"revision": "20230927",
794+
"revision": "20230929",
799795
"rootUrl": "https://cloudtasks.googleapis.com/",
800796
"schemas": {
801797
"AppEngineHttpQueue": {

0 commit comments

Comments
 (0)
Please sign in to comment.