Skip to content

Commit 396b4d0

Browse files
feat(cloudtasks): update the api
#### cloudtasks:v2beta3 The following keys were added: - resources.projects.resources.locations.methods.getCmekConfig (Total Keys: 11) - resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 17) - schemas.CmekConfig (Total Keys: 5)
1 parent 0a61805 commit 396b4d0

File tree

4 files changed

+138
-3
lines changed

4 files changed

+138
-3
lines changed

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

Lines changed: 56 additions & 0 deletions
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(projectsId, locationsId, 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 resource name. 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,34 @@ <h3>Method Details</h3>
173199
</pre>
174200
</div>
175201

202+
<div class="method">
203+
<code class="details" id="updateCmekConfig">updateCmekConfig(projectsId, locationsId, 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+
projectsId: string, A parameter (required)
208+
locationsId: string, A parameter (required)
209+
body: object, The request body.
210+
The object takes the form of:
211+
212+
{ # CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.
213+
&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.
214+
&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`
215+
}
216+
217+
updateMask: string, List of fields to be updated in this request.
218+
x__xgafv: string, V1 error format.
219+
Allowed values
220+
1 - v1 error format
221+
2 - v2 error format
222+
223+
Returns:
224+
An object of the form:
225+
226+
{ # CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.
227+
&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.
228+
&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`
229+
}</pre>
230+
</div>
231+
176232
</body></html>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,7 @@
685685
}
686686
}
687687
},
688-
"revision": "20230906",
688+
"revision": "20230927",
689689
"rootUrl": "https://cloudtasks.googleapis.com/",
690690
"schemas": {
691691
"AppEngineHttpRequest": {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -939,7 +939,7 @@
939939
}
940940
}
941941
},
942-
"revision": "20230906",
942+
"revision": "20230927",
943943
"rootUrl": "https://cloudtasks.googleapis.com/",
944944
"schemas": {
945945
"AcknowledgeTaskRequest": {

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

Lines changed: 80 additions & 1 deletion
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": "v2beta3/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 resource name. 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": "v2beta3/{+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": "v2beta3/projects/{projectsId}/locations",
@@ -174,6 +199,44 @@
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": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig",
206+
"httpMethod": "PATCH",
207+
"id": "cloudtasks.projects.locations.updateCmekConfig",
208+
"parameterOrder": [
209+
"projectsId",
210+
"locationsId"
211+
],
212+
"parameters": {
213+
"locationsId": {
214+
"location": "path",
215+
"required": true,
216+
"type": "string"
217+
},
218+
"projectsId": {
219+
"location": "path",
220+
"required": true,
221+
"type": "string"
222+
},
223+
"updateMask": {
224+
"description": "List of fields to be updated in this request.",
225+
"format": "google-fieldmask",
226+
"location": "query",
227+
"type": "string"
228+
}
229+
},
230+
"path": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig",
231+
"request": {
232+
"$ref": "CmekConfig"
233+
},
234+
"response": {
235+
"$ref": "CmekConfig"
236+
},
237+
"scopes": [
238+
"https://www.googleapis.com/auth/cloud-platform"
239+
]
177240
}
178241
},
179242
"resources": {
@@ -732,7 +795,7 @@
732795
}
733796
}
734797
},
735-
"revision": "20230906",
798+
"revision": "20230927",
736799
"rootUrl": "https://cloudtasks.googleapis.com/",
737800
"schemas": {
738801
"AppEngineHttpQueue": {
@@ -890,6 +953,22 @@
890953
},
891954
"type": "object"
892955
},
956+
"CmekConfig": {
957+
"description": "CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer\u2019s hands.",
958+
"id": "CmekConfig",
959+
"properties": {
960+
"kmsKey": {
961+
"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.",
962+
"type": "string"
963+
},
964+
"name": {
965+
"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`",
966+
"readOnly": true,
967+
"type": "string"
968+
}
969+
},
970+
"type": "object"
971+
},
893972
"CreateTaskRequest": {
894973
"description": "Request message for CreateTask.",
895974
"id": "CreateTaskRequest",

0 commit comments

Comments
 (0)