Skip to content

Commit 419948b

Browse files
feat(notebooks): update the api
#### notebooks:v2 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.getConfig (Total Keys: 11) - schemas.Config (Total Keys: 9) - schemas.DefaultValues (Total Keys: 4) - schemas.ImageRelease (Total Keys: 6) - schemas.SupportedValues (Total Keys: 8)
1 parent 0f6e412 commit 419948b

File tree

4 files changed

+146
-6
lines changed

4 files changed

+146
-6
lines changed

docs/dyn/notebooks_v1.projects.locations.instances.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ <h3>Method Details</h3>
230230
&quot;a_key&quot;: &quot;A String&quot;,
231231
},
232232
&quot;machineType&quot;: &quot;A String&quot;, # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
233-
&quot;metadata&quot;: { # Custom metadata to apply to this instance.
233+
&quot;metadata&quot;: { # Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `&quot;--metadata=gcs-data-bucket=``BUCKET&#x27;&#x27;&quot;`.
234234
&quot;a_key&quot;: &quot;A String&quot;,
235235
},
236236
&quot;migrated&quot;: True or False, # Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
@@ -470,7 +470,7 @@ <h3>Method Details</h3>
470470
&quot;a_key&quot;: &quot;A String&quot;,
471471
},
472472
&quot;machineType&quot;: &quot;A String&quot;, # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
473-
&quot;metadata&quot;: { # Custom metadata to apply to this instance.
473+
&quot;metadata&quot;: { # Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `&quot;--metadata=gcs-data-bucket=``BUCKET&#x27;&#x27;&quot;`.
474474
&quot;a_key&quot;: &quot;A String&quot;,
475475
},
476476
&quot;migrated&quot;: True or False, # Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
@@ -689,7 +689,7 @@ <h3>Method Details</h3>
689689
&quot;a_key&quot;: &quot;A String&quot;,
690690
},
691691
&quot;machineType&quot;: &quot;A String&quot;, # Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
692-
&quot;metadata&quot;: { # Custom metadata to apply to this instance.
692+
&quot;metadata&quot;: { # Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `&quot;--metadata=gcs-data-bucket=``BUCKET&#x27;&#x27;&quot;`.
693693
&quot;a_key&quot;: &quot;A String&quot;,
694694
},
695695
&quot;migrated&quot;: True or False, # Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance

docs/dyn/notebooks_v2.projects.locations.instances.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ <h2>Instance Methods</h2>
9292
<p class="toc_element">
9393
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9494
<p class="firstline">Gets details of a single Instance.</p>
95+
<p class="toc_element">
96+
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.</p>
9598
<p class="toc_element">
9699
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
97100
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
@@ -495,6 +498,41 @@ <h3>Method Details</h3>
495498
}</pre>
496499
</div>
497500

501+
<div class="method">
502+
<code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
503+
<pre>Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.
504+
505+
Args:
506+
name: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
507+
x__xgafv: string, V1 error format.
508+
Allowed values
509+
1 - v1 error format
510+
2 - v2 error format
511+
512+
Returns:
513+
An object of the form:
514+
515+
{ # Response for getting WbI configurations in a location
516+
&quot;availableImages&quot;: [ # Output only. The list of available images to create a WbI.
517+
{ # ConfigImage represents an image release available to create a WbI
518+
&quot;imageName&quot;: &quot;A String&quot;, # Output only. The name of the image of the form workbench-instances-vYYYYmmdd--
519+
&quot;releaseName&quot;: &quot;A String&quot;, # Output only. The release of the image of the form m123
520+
},
521+
],
522+
&quot;defaultValues&quot;: { # DefaultValues represents the default configuration values. # Output only. The default values for configuration.
523+
&quot;machineType&quot;: &quot;A String&quot;, # Output only. The default machine type used by the backend if not provided by the user.
524+
},
525+
&quot;supportedValues&quot;: { # SupportedValues represents the values supported by the configuration. # Output only. The supported values for configuration.
526+
&quot;acceleratorTypes&quot;: [ # Output only. The accelerator types supported by WbI.
527+
&quot;A String&quot;,
528+
],
529+
&quot;machineTypes&quot;: [ # Output only. The machine types supported by WbI.
530+
&quot;A String&quot;,
531+
],
532+
},
533+
}</pre>
534+
</div>
535+
498536
<div class="method">
499537
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
500538
<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

googleapiclient/discovery_cache/documents/notebooks.v1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2008,7 +2008,7 @@
20082008
}
20092009
}
20102010
},
2011-
"revision": "20231003",
2011+
"revision": "20231019",
20122012
"rootUrl": "https://notebooks.googleapis.com/",
20132013
"schemas": {
20142014
"AcceleratorConfig": {
@@ -2707,7 +2707,7 @@
27072707
"additionalProperties": {
27082708
"type": "string"
27092709
},
2710-
"description": "Custom metadata to apply to this instance.",
2710+
"description": "Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `\"--metadata=gcs-data-bucket=``BUCKET''\"`.",
27112711
"type": "object"
27122712
},
27132713
"migrated": {

googleapiclient/discovery_cache/documents/notebooks.v2.json

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,31 @@
325325
"https://www.googleapis.com/auth/cloud-platform"
326326
]
327327
},
328+
"getConfig": {
329+
"description": "Gets general backend configurations that might also affect the frontend. Location is required by CCFE. Although we could bypass it to send location- less request directly to the backend job, we would need CPE (go/cloud-cpe). Having the location might also be useful depending on the query.",
330+
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances:getConfig",
331+
"httpMethod": "GET",
332+
"id": "notebooks.projects.locations.instances.getConfig",
333+
"parameterOrder": [
334+
"name"
335+
],
336+
"parameters": {
337+
"name": {
338+
"description": "Required. Format: `projects/{project_id}/locations/{location}`",
339+
"location": "path",
340+
"pattern": "^projects/[^/]+/locations/[^/]+$",
341+
"required": true,
342+
"type": "string"
343+
}
344+
},
345+
"path": "v2/{+name}/instances:getConfig",
346+
"response": {
347+
"$ref": "Config"
348+
},
349+
"scopes": [
350+
"https://www.googleapis.com/auth/cloud-platform"
351+
]
352+
},
328353
"getIamPolicy": {
329354
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
330355
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy",
@@ -823,7 +848,7 @@
823848
}
824849
}
825850
},
826-
"revision": "20231003",
851+
"revision": "20231019",
827852
"rootUrl": "https://notebooks.googleapis.com/",
828853
"schemas": {
829854
"AcceleratorConfig": {
@@ -967,6 +992,31 @@
967992
},
968993
"type": "object"
969994
},
995+
"Config": {
996+
"description": "Response for getting WbI configurations in a location",
997+
"id": "Config",
998+
"properties": {
999+
"availableImages": {
1000+
"description": "Output only. The list of available images to create a WbI.",
1001+
"items": {
1002+
"$ref": "ImageRelease"
1003+
},
1004+
"readOnly": true,
1005+
"type": "array"
1006+
},
1007+
"defaultValues": {
1008+
"$ref": "DefaultValues",
1009+
"description": "Output only. The default values for configuration.",
1010+
"readOnly": true
1011+
},
1012+
"supportedValues": {
1013+
"$ref": "SupportedValues",
1014+
"description": "Output only. The supported values for configuration.",
1015+
"readOnly": true
1016+
}
1017+
},
1018+
"type": "object"
1019+
},
9701020
"ContainerImage": {
9711021
"description": "Definition of a container image for starting a notebook instance with the environment installed in a container.",
9721022
"id": "ContainerImage",
@@ -1030,6 +1080,18 @@
10301080
},
10311081
"type": "object"
10321082
},
1083+
"DefaultValues": {
1084+
"description": "DefaultValues represents the default configuration values.",
1085+
"id": "DefaultValues",
1086+
"properties": {
1087+
"machineType": {
1088+
"description": "Output only. The default machine type used by the backend if not provided by the user.",
1089+
"readOnly": true,
1090+
"type": "string"
1091+
}
1092+
},
1093+
"type": "object"
1094+
},
10331095
"DiagnoseInstanceRequest": {
10341096
"description": "Request for creating a notebook instance diagnostic file.",
10351097
"id": "DiagnoseInstanceRequest",
@@ -1237,6 +1299,23 @@
12371299
},
12381300
"type": "object"
12391301
},
1302+
"ImageRelease": {
1303+
"description": "ConfigImage represents an image release available to create a WbI",
1304+
"id": "ImageRelease",
1305+
"properties": {
1306+
"imageName": {
1307+
"description": "Output only. The name of the image of the form workbench-instances-vYYYYmmdd--",
1308+
"readOnly": true,
1309+
"type": "string"
1310+
},
1311+
"releaseName": {
1312+
"description": "Output only. The release of the image of the form m123",
1313+
"readOnly": true,
1314+
"type": "string"
1315+
}
1316+
},
1317+
"type": "object"
1318+
},
12401319
"Instance": {
12411320
"description": "The definition of a notebook instance.",
12421321
"id": "Instance",
@@ -1713,6 +1792,29 @@
17131792
"properties": {},
17141793
"type": "object"
17151794
},
1795+
"SupportedValues": {
1796+
"description": "SupportedValues represents the values supported by the configuration.",
1797+
"id": "SupportedValues",
1798+
"properties": {
1799+
"acceleratorTypes": {
1800+
"description": "Output only. The accelerator types supported by WbI.",
1801+
"items": {
1802+
"type": "string"
1803+
},
1804+
"readOnly": true,
1805+
"type": "array"
1806+
},
1807+
"machineTypes": {
1808+
"description": "Output only. The machine types supported by WbI.",
1809+
"items": {
1810+
"type": "string"
1811+
},
1812+
"readOnly": true,
1813+
"type": "array"
1814+
}
1815+
},
1816+
"type": "object"
1817+
},
17161818
"TestIamPermissionsRequest": {
17171819
"description": "Request message for `TestIamPermissions` method.",
17181820
"id": "TestIamPermissionsRequest",

0 commit comments

Comments
 (0)