Skip to content

Commit 831ba93

Browse files
feat(notebooks): update the api
#### notebooks:v1 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.updateConfig (Total Keys: 12) - schemas.InstanceConfig (Total Keys: 4) - schemas.UpdateInstanceConfigRequest (Total Keys: 3)
1 parent b333d96 commit 831ba93

File tree

2 files changed

+107
-3
lines changed

2 files changed

+107
-3
lines changed

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ <h2>Instance Methods</h2>
134134
<p class="toc_element">
135135
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
136136
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
137+
<p class="toc_element">
138+
<code><a href="#updateConfig">updateConfig(name, body=None, x__xgafv=None)</a></code></p>
139+
<p class="firstline">Update Notebook Instance configurations.</p>
137140
<p class="toc_element">
138141
<code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</a></code></p>
139142
<p class="firstline">Updates the Shielded instance configuration of a single Instance.</p>
@@ -1107,6 +1110,51 @@ <h3>Method Details</h3>
11071110
}</pre>
11081111
</div>
11091112

1113+
<div class="method">
1114+
<code class="details" id="updateConfig">updateConfig(name, body=None, x__xgafv=None)</code>
1115+
<pre>Update Notebook Instance configurations.
1116+
1117+
Args:
1118+
name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
1119+
body: object, The request body.
1120+
The object takes the form of:
1121+
1122+
{ # Request for updating instance configurations.
1123+
&quot;config&quot;: { # Notebook instance configurations that can be updated. # The instance configurations to be updated.
1124+
&quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. More info: go/notebooks-health
1125+
&quot;notebookUpgradeSchedule&quot;: &quot;A String&quot;, # Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
1126+
},
1127+
}
1128+
1129+
x__xgafv: string, V1 error format.
1130+
Allowed values
1131+
1 - v1 error format
1132+
2 - v2 error format
1133+
1134+
Returns:
1135+
An object of the form:
1136+
1137+
{ # This resource represents a long-running operation that is the result of a network API call.
1138+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
1139+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
1140+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1141+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1142+
{
1143+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1144+
},
1145+
],
1146+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
1147+
},
1148+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
1149+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1150+
},
1151+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
1152+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
1153+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1154+
},
1155+
}</pre>
1156+
</div>
1157+
11101158
<div class="method">
11111159
<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</code>
11121160
<pre>Updates the Shielded instance configuration of a single Instance.

googleapiclient/discovery_cache/documents/notebooks.v1.json

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,34 @@
943943
"https://www.googleapis.com/auth/cloud-platform"
944944
]
945945
},
946+
"updateConfig": {
947+
"description": "Update Notebook Instance configurations.",
948+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateConfig",
949+
"httpMethod": "PATCH",
950+
"id": "notebooks.projects.locations.instances.updateConfig",
951+
"parameterOrder": [
952+
"name"
953+
],
954+
"parameters": {
955+
"name": {
956+
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
957+
"location": "path",
958+
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
959+
"required": true,
960+
"type": "string"
961+
}
962+
},
963+
"path": "v1/{+name}:updateConfig",
964+
"request": {
965+
"$ref": "UpdateInstanceConfigRequest"
966+
},
967+
"response": {
968+
"$ref": "Operation"
969+
},
970+
"scopes": [
971+
"https://www.googleapis.com/auth/cloud-platform"
972+
]
973+
},
946974
"updateShieldedInstanceConfig": {
947975
"description": "Updates the Shielded instance configuration of a single Instance.",
948976
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateShieldedInstanceConfig",
@@ -1553,7 +1581,7 @@
15531581
}
15541582
}
15551583
},
1556-
"revision": "20210603",
1584+
"revision": "20210610",
15571585
"rootUrl": "https://notebooks.googleapis.com/",
15581586
"schemas": {
15591587
"AcceleratorConfig": {
@@ -1803,7 +1831,8 @@
18031831
"SUCCEEDED",
18041832
"FAILED",
18051833
"CANCELLING",
1806-
"CANCELLED"
1834+
"CANCELLED",
1835+
"EXPIRED"
18071836
],
18081837
"enumDescriptions": [
18091838
"The job state is unspecified.",
@@ -1813,7 +1842,8 @@
18131842
"The job completed successfully.",
18141843
"The job failed. `error_message` should contain the details of the failure.",
18151844
"The job is being cancelled. `error_message` should describe the reason for the cancellation.",
1816-
"The job has been cancelled. `error_message` should describe the reason for the cancellation."
1845+
"The job has been cancelled. `error_message` should describe the reason for the cancellation.",
1846+
"The jobs has become expired (added for uCAIP jobs) https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState"
18171847
],
18181848
"readOnly": true,
18191849
"type": "string"
@@ -2201,6 +2231,21 @@
22012231
},
22022232
"type": "object"
22032233
},
2234+
"InstanceConfig": {
2235+
"description": "Notebook instance configurations that can be updated.",
2236+
"id": "InstanceConfig",
2237+
"properties": {
2238+
"enableHealthMonitoring": {
2239+
"description": "Verifies core internal services are running. More info: go/notebooks-health",
2240+
"type": "boolean"
2241+
},
2242+
"notebookUpgradeSchedule": {
2243+
"description": "Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).",
2244+
"type": "string"
2245+
}
2246+
},
2247+
"type": "object"
2248+
},
22042249
"IsInstanceUpgradeableResponse": {
22052250
"description": "Response for checking if a notebook instance is upgradeable.",
22062251
"id": "IsInstanceUpgradeableResponse",
@@ -3224,6 +3269,17 @@
32243269
"properties": {},
32253270
"type": "object"
32263271
},
3272+
"UpdateInstanceConfigRequest": {
3273+
"description": "Request for updating instance configurations.",
3274+
"id": "UpdateInstanceConfigRequest",
3275+
"properties": {
3276+
"config": {
3277+
"$ref": "InstanceConfig",
3278+
"description": "The instance configurations to be updated."
3279+
}
3280+
},
3281+
"type": "object"
3282+
},
32273283
"UpdateShieldedInstanceConfigRequest": {
32283284
"description": "Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance",
32293285
"id": "UpdateShieldedInstanceConfigRequest",

0 commit comments

Comments
 (0)