Skip to content

Commit

Permalink
feat(notebooks): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed Jun 29, 2021
1 parent b333d96 commit 831ba93
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 3 deletions.
48 changes: 48 additions & 0 deletions docs/dyn/notebooks_v1.projects.locations.instances.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#updateConfig">updateConfig(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update Notebook Instance configurations.</p>
<p class="toc_element">
<code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the Shielded instance configuration of a single Instance.</p>
Expand Down Expand Up @@ -1107,6 +1110,51 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="updateConfig">updateConfig(name, body=None, x__xgafv=None)</code>
<pre>Update Notebook Instance configurations.

Args:
name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
body: object, The request body.
The object takes the form of:

{ # Request for updating instance configurations.
&quot;config&quot;: { # Notebook instance configurations that can be updated. # The instance configurations to be updated.
&quot;enableHealthMonitoring&quot;: True or False, # Verifies core internal services are running. More info: go/notebooks-health
&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).
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
&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.
&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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&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.
},
&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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&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}`.
&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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>

<div class="method">
<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</code>
<pre>Updates the Shielded instance configuration of a single Instance.
Expand Down
62 changes: 59 additions & 3 deletions googleapiclient/discovery_cache/documents/notebooks.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateConfig": {
"description": "Update Notebook Instance configurations.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateConfig",
"httpMethod": "PATCH",
"id": "notebooks.projects.locations.instances.updateConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:updateConfig",
"request": {
"$ref": "UpdateInstanceConfigRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateShieldedInstanceConfig": {
"description": "Updates the Shielded instance configuration of a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateShieldedInstanceConfig",
Expand Down Expand Up @@ -1553,7 +1581,7 @@
}
}
},
"revision": "20210603",
"revision": "20210610",
"rootUrl": "https://notebooks.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
Expand Down Expand Up @@ -1803,7 +1831,8 @@
"SUCCEEDED",
"FAILED",
"CANCELLING",
"CANCELLED"
"CANCELLED",
"EXPIRED"
],
"enumDescriptions": [
"The job state is unspecified.",
Expand All @@ -1813,7 +1842,8 @@
"The job completed successfully.",
"The job failed. `error_message` should contain the details of the failure.",
"The job is being cancelled. `error_message` should describe the reason for the cancellation.",
"The job has been cancelled. `error_message` should describe the reason for the cancellation."
"The job has been cancelled. `error_message` should describe the reason for the cancellation.",
"The jobs has become expired (added for uCAIP jobs) https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState"
],
"readOnly": true,
"type": "string"
Expand Down Expand Up @@ -2201,6 +2231,21 @@
},
"type": "object"
},
"InstanceConfig": {
"description": "Notebook instance configurations that can be updated.",
"id": "InstanceConfig",
"properties": {
"enableHealthMonitoring": {
"description": "Verifies core internal services are running. More info: go/notebooks-health",
"type": "boolean"
},
"notebookUpgradeSchedule": {
"description": "Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).",
"type": "string"
}
},
"type": "object"
},
"IsInstanceUpgradeableResponse": {
"description": "Response for checking if a notebook instance is upgradeable.",
"id": "IsInstanceUpgradeableResponse",
Expand Down Expand Up @@ -3224,6 +3269,17 @@
"properties": {},
"type": "object"
},
"UpdateInstanceConfigRequest": {
"description": "Request for updating instance configurations.",
"id": "UpdateInstanceConfigRequest",
"properties": {
"config": {
"$ref": "InstanceConfig",
"description": "The instance configurations to be updated."
}
},
"type": "object"
},
"UpdateShieldedInstanceConfigRequest": {
"description": "Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance",
"id": "UpdateShieldedInstanceConfigRequest",
Expand Down

0 comments on commit 831ba93

Please sign in to comment.