Skip to content

Commit

Permalink
feat(notebooks): update the api
Browse files Browse the repository at this point in the history
#### notebooks:v2

The following keys were added:
- schemas.Instance.properties.enableThirdPartyIdentity.type (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Dec 17, 2024
1 parent 6f1d805 commit d083735
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/dyn/notebooks_v1.projects.locations.operations.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h1><a href="notebooks_v1.html">Notebooks API</a> . <a href="notebooks_v1.projec
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

Args:
name: string, The name of the operation resource to be cancelled. (required)
Expand Down
4 changes: 4 additions & 0 deletions docs/dyn/notebooks_v2.projects.locations.instances.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Instance creation time.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Email address of entity that sent original CreateInstance request.
&quot;disableProxyAccess&quot;: True or False, # Optional. If true, the notebook instance will not register with the proxy.
&quot;enableThirdPartyIdentity&quot;: True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
&quot;gceSetup&quot;: { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
&quot;acceleratorConfigs&quot;: [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration.
{ # An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on `type` and `core_count` combinations. TPUs are not supported. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
Expand Down Expand Up @@ -418,6 +419,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Instance creation time.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Email address of entity that sent original CreateInstance request.
&quot;disableProxyAccess&quot;: True or False, # Optional. If true, the notebook instance will not register with the proxy.
&quot;enableThirdPartyIdentity&quot;: True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
&quot;gceSetup&quot;: { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
&quot;acceleratorConfigs&quot;: [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration.
{ # An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on `type` and `core_count` combinations. TPUs are not supported. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
Expand Down Expand Up @@ -616,6 +618,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Instance creation time.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Email address of entity that sent original CreateInstance request.
&quot;disableProxyAccess&quot;: True or False, # Optional. If true, the notebook instance will not register with the proxy.
&quot;enableThirdPartyIdentity&quot;: True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
&quot;gceSetup&quot;: { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
&quot;acceleratorConfigs&quot;: [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration.
{ # An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on `type` and `core_count` combinations. TPUs are not supported. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
Expand Down Expand Up @@ -753,6 +756,7 @@ <h3>Method Details</h3>
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Instance creation time.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Email address of entity that sent original CreateInstance request.
&quot;disableProxyAccess&quot;: True or False, # Optional. If true, the notebook instance will not register with the proxy.
&quot;enableThirdPartyIdentity&quot;: True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
&quot;gceSetup&quot;: { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
&quot;acceleratorConfigs&quot;: [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration.
{ # An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on `type` and `core_count` combinations. TPUs are not supported. See [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination.
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/notebooks_v2.projects.locations.operations.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ <h1><a href="notebooks_v2.html">Notebooks API</a> . <a href="notebooks_v2.projec
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand All @@ -95,7 +95,7 @@ <h2>Instance Methods</h2>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

Args:
name: string, The name of the operation resource to be cancelled. (required)
Expand Down
4 changes: 2 additions & 2 deletions googleapiclient/discovery_cache/documents/notebooks.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -1201,7 +1201,7 @@
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "notebooks.projects.locations.operations.cancel",
Expand Down Expand Up @@ -2008,7 +2008,7 @@
}
}
},
"revision": "20241106",
"revision": "20241204",
"rootUrl": "https://notebooks.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
Expand Down
8 changes: 6 additions & 2 deletions googleapiclient/discovery_cache/documents/notebooks.v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "notebooks.projects.locations.operations.cancel",
Expand Down Expand Up @@ -904,7 +904,7 @@
}
}
},
"revision": "20241106",
"revision": "20241204",
"rootUrl": "https://notebooks.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
Expand Down Expand Up @@ -1406,6 +1406,10 @@
"description": "Optional. If true, the notebook instance will not register with the proxy.",
"type": "boolean"
},
"enableThirdPartyIdentity": {
"description": "Optional. Flag that specifies that a notebook can be accessed with third party identity provider.",
"type": "boolean"
},
"gceSetup": {
"$ref": "GceSetup",
"description": "Optional. Compute Engine setup for the notebook. Uses notebook-defined fields."
Expand Down

0 comments on commit d083735

Please sign in to comment.