feat(notebooks): update the API

#### notebooks:v1 The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.DiagnoseInstanceRequest.properties.timeoutMinutes.description - schemas.DiagnoseRuntimeRequest.properties.timeoutMinutes.description - schemas.Instance.properties.machineType.description - schemas.OperationMetadata.properties.requestedCancellation.description - schemas.Schedule.properties.state.enumDescriptions - schemas.SetInstanceMachineTypeRequest.properties.machineType.description #### notebooks:v2 The following keys were added: - schemas.Instance.properties.enableThirdPartyIdentity.description - schemas.Instance.properties.enableThirdPartyIdentity.type The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.AcceleratorConfig.properties.type.enum - schemas.AcceleratorConfig.properties.type.enumDescriptions - schemas.DiagnoseInstanceRequest.properties.timeoutMinutes.description - schemas.OperationMetadata.properties.requestedCancellation.description
googleapis · Jan 29, 2025 · c584b31 · c584b31
1 parent 61648dc
commit c584b31
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 22 deletions.
diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json
@@ -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",
@@ -2008,7 +2008,7 @@
       }
     }
   },
-  "revision": "20240918",
+  "revision": "20241204",
   "rootUrl": "https://notebooks.googleapis.com/",
   "schemas": {
     "AcceleratorConfig": {
@@ -2132,7 +2132,7 @@
           "description": "Required. Defines flags that are used to run the diagnostic tool"
         },
         "timeoutMinutes": {
-          "description": "Optional. Maxmium amount of time in minutes before the operation times out.",
+          "description": "Optional. Maximum amount of time in minutes before the operation times out.",
           "format": "int32",
           "type": "integer"
         }
@@ -2148,7 +2148,7 @@
           "description": "Required. Defines flags that are used to run the diagnostic tool"
         },
         "timeoutMinutes": {
-          "description": "Optional. Maxmium amount of time in minutes before the operation times out.",
+          "description": "Optional. Maximum amount of time in minutes before the operation times out.",
           "format": "int32",
           "type": "integer"
         }
@@ -2706,7 +2706,7 @@
           "type": "object"
         },
         "machineType": {
-          "description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.",
+          "description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this instance.",
           "type": "string"
         },
         "metadata": {
@@ -3360,7 +3360,7 @@
           "type": "string"
         },
         "requestedCancellation": {
-          "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+          "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
           "type": "boolean"
         },
         "statusMessage": {
@@ -3968,9 +3968,9 @@
           "enumDescriptions": [
             "Unspecified state.",
             "The job is executing normally.",
-            "The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest.",
+            "The job is paused by the user. It will not execute. A user can intentionally pause the job using [Cloud Scheduler](https://cloud.google.com/scheduler/docs/creating#pause).",
             "The job is disabled by the system due to error. The user cannot directly set a job to be disabled.",
-            "The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received.",
+            "The job state resulting from a failed [CloudScheduler.UpdateJob](https://cloud.google.com/scheduler/docs/creating#edit) operation. To recover a job from this state, retry [CloudScheduler.UpdateJob](https://cloud.google.com/scheduler/docs/creating#edit) until a successful response is received.",
             "The schedule resource is being created.",
             "The schedule resource is being deleted."
           ],
@@ -4109,7 +4109,7 @@
       "id": "SetInstanceMachineTypeRequest",
       "properties": {
         "machineType": {
-          "description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).",
+          "description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource).",
           "type": "string"
         }
       },

diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json
@@ -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",
@@ -904,7 +904,7 @@
       }
     }
   },
-  "revision": "20240918",
+  "revision": "20250101",
   "rootUrl": "https://notebooks.googleapis.com/",
   "schemas": {
     "AcceleratorConfig": {
@@ -927,6 +927,8 @@
             "NVIDIA_TESLA_A100",
             "NVIDIA_A100_80GB",
             "NVIDIA_L4",
+            "NVIDIA_H100_80GB",
+            "NVIDIA_H100_MEGA_80GB",
             "NVIDIA_TESLA_T4_VWS",
             "NVIDIA_TESLA_P100_VWS",
             "NVIDIA_TESLA_P4_VWS"
@@ -940,6 +942,8 @@
             "Accelerator type is Nvidia Tesla A100 - 40GB.",
             "Accelerator type is Nvidia Tesla A100 - 80GB.",
             "Accelerator type is Nvidia Tesla L4.",
+            "Accelerator type is Nvidia Tesla H100 - 80GB.",
+            "Accelerator type is Nvidia Tesla H100 - MEGA 80GB.",
             "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.",
             "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.",
             "Accelerator type is NVIDIA Tesla P4 Virtual Workstations."
@@ -1168,7 +1172,7 @@
           "description": "Required. Defines flags that are used to run the diagnostic tool"
         },
         "timeoutMinutes": {
-          "description": "Optional. Maxmium amount of time in minutes before the operation times out.",
+          "description": "Optional. Maximum amount of time in minutes before the operation times out.",
           "format": "int32",
           "type": "integer"
         }
@@ -1406,6 +1410,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."
@@ -1718,7 +1726,7 @@
           "type": "string"
         },
         "requestedCancellation": {
-          "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+          "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
           "type": "boolean"
         },
         "statusMessage": {

diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts
@@ -193,7 +193,7 @@ export namespace notebooks_v1 {
      */
     diagnosticConfig?: Schema$DiagnosticConfig;
     /**
-     * Optional. Maxmium amount of time in minutes before the operation times out.
+     * Optional. Maximum amount of time in minutes before the operation times out.
      */
     timeoutMinutes?: number | null;
   }
@@ -206,7 +206,7 @@ export namespace notebooks_v1 {
      */
     diagnosticConfig?: Schema$DiagnosticConfig;
     /**
-     * Optional. Maxmium amount of time in minutes before the operation times out.
+     * Optional. Maximum amount of time in minutes before the operation times out.
      */
     timeoutMinutes?: number | null;
   }
@@ -573,7 +573,7 @@ export namespace notebooks_v1 {
      */
     labels?: {[key: string]: string} | null;
     /**
-     * Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
+     * Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this instance.
      */
     machineType?: string | null;
     /**
@@ -998,7 +998,7 @@ export namespace notebooks_v1 {
      */
     endTime?: string | null;
     /**
-     * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+     * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
      */
     requestedCancellation?: boolean | null;
     /**
@@ -1419,7 +1419,7 @@ export namespace notebooks_v1 {
    */
   export interface Schema$SetInstanceMachineTypeRequest {
     /**
-     * Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).
+     * Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource).
      */
     machineType?: string | null;
   }
@@ -5455,7 +5455,7 @@ export namespace notebooks_v1 {
     }
 
     /**
-     * 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`.
+     * 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`.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts
@@ -278,7 +278,7 @@ export namespace notebooks_v2 {
      */
     diagnosticConfig?: Schema$DiagnosticConfig;
     /**
-     * Optional. Maxmium amount of time in minutes before the operation times out.
+     * Optional. Maximum amount of time in minutes before the operation times out.
      */
     timeoutMinutes?: number | null;
   }
@@ -456,6 +456,10 @@ export namespace notebooks_v2 {
      * Optional. If true, the notebook instance will not register with the proxy.
      */
     disableProxyAccess?: boolean | null;
+    /**
+     * Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
+     */
+    enableThirdPartyIdentity?: boolean | null;
     /**
      * Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
      */
@@ -648,7 +652,7 @@ export namespace notebooks_v2 {
      */
     endTime?: string | null;
     /**
-     * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+     * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
      */
     requestedCancellation?: boolean | null;
     /**
@@ -3173,7 +3177,7 @@ export namespace notebooks_v2 {
     }
 
     /**
-     * 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`.
+     * 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`.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.