Skip to content

Commit c584b31

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
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
1 parent 61648dc commit c584b31

File tree

4 files changed

+34
-22
lines changed

4 files changed

+34
-22
lines changed

‎discovery/notebooks-v1.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,7 +1201,7 @@
12011201
"operations": {
12021202
"methods": {
12031203
"cancel": {
1204-
"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`.",
1204+
"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`.",
12051205
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
12061206
"httpMethod": "POST",
12071207
"id": "notebooks.projects.locations.operations.cancel",
@@ -2008,7 +2008,7 @@
20082008
}
20092009
}
20102010
},
2011-
"revision": "20240918",
2011+
"revision": "20241204",
20122012
"rootUrl": "https://notebooks.googleapis.com/",
20132013
"schemas": {
20142014
"AcceleratorConfig": {
@@ -2132,7 +2132,7 @@
21322132
"description": "Required. Defines flags that are used to run the diagnostic tool"
21332133
},
21342134
"timeoutMinutes": {
2135-
"description": "Optional. Maxmium amount of time in minutes before the operation times out.",
2135+
"description": "Optional. Maximum amount of time in minutes before the operation times out.",
21362136
"format": "int32",
21372137
"type": "integer"
21382138
}
@@ -2148,7 +2148,7 @@
21482148
"description": "Required. Defines flags that are used to run the diagnostic tool"
21492149
},
21502150
"timeoutMinutes": {
2151-
"description": "Optional. Maxmium amount of time in minutes before the operation times out.",
2151+
"description": "Optional. Maximum amount of time in minutes before the operation times out.",
21522152
"format": "int32",
21532153
"type": "integer"
21542154
}
@@ -2706,7 +2706,7 @@
27062706
"type": "object"
27072707
},
27082708
"machineType": {
2709-
"description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.",
2709+
"description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this instance.",
27102710
"type": "string"
27112711
},
27122712
"metadata": {
@@ -3360,7 +3360,7 @@
33603360
"type": "string"
33613361
},
33623362
"requestedCancellation": {
3363-
"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`.",
3363+
"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`.",
33643364
"type": "boolean"
33653365
},
33663366
"statusMessage": {
@@ -3968,9 +3968,9 @@
39683968
"enumDescriptions": [
39693969
"Unspecified state.",
39703970
"The job is executing normally.",
3971-
"The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest.",
3971+
"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).",
39723972
"The job is disabled by the system due to error. The user cannot directly set a job to be disabled.",
3973-
"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.",
3973+
"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.",
39743974
"The schedule resource is being created.",
39753975
"The schedule resource is being deleted."
39763976
],
@@ -4109,7 +4109,7 @@
41094109
"id": "SetInstanceMachineTypeRequest",
41104110
"properties": {
41114111
"machineType": {
4112-
"description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).",
4112+
"description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource).",
41134113
"type": "string"
41144114
}
41154115
},

‎discovery/notebooks-v2.json

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@
779779
"operations": {
780780
"methods": {
781781
"cancel": {
782-
"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`.",
782+
"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`.",
783783
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
784784
"httpMethod": "POST",
785785
"id": "notebooks.projects.locations.operations.cancel",
@@ -904,7 +904,7 @@
904904
}
905905
}
906906
},
907-
"revision": "20240918",
907+
"revision": "20250101",
908908
"rootUrl": "https://notebooks.googleapis.com/",
909909
"schemas": {
910910
"AcceleratorConfig": {
@@ -927,6 +927,8 @@
927927
"NVIDIA_TESLA_A100",
928928
"NVIDIA_A100_80GB",
929929
"NVIDIA_L4",
930+
"NVIDIA_H100_80GB",
931+
"NVIDIA_H100_MEGA_80GB",
930932
"NVIDIA_TESLA_T4_VWS",
931933
"NVIDIA_TESLA_P100_VWS",
932934
"NVIDIA_TESLA_P4_VWS"
@@ -940,6 +942,8 @@
940942
"Accelerator type is Nvidia Tesla A100 - 40GB.",
941943
"Accelerator type is Nvidia Tesla A100 - 80GB.",
942944
"Accelerator type is Nvidia Tesla L4.",
945+
"Accelerator type is Nvidia Tesla H100 - 80GB.",
946+
"Accelerator type is Nvidia Tesla H100 - MEGA 80GB.",
943947
"Accelerator type is NVIDIA Tesla T4 Virtual Workstations.",
944948
"Accelerator type is NVIDIA Tesla P100 Virtual Workstations.",
945949
"Accelerator type is NVIDIA Tesla P4 Virtual Workstations."
@@ -1168,7 +1172,7 @@
11681172
"description": "Required. Defines flags that are used to run the diagnostic tool"
11691173
},
11701174
"timeoutMinutes": {
1171-
"description": "Optional. Maxmium amount of time in minutes before the operation times out.",
1175+
"description": "Optional. Maximum amount of time in minutes before the operation times out.",
11721176
"format": "int32",
11731177
"type": "integer"
11741178
}
@@ -1406,6 +1410,10 @@
14061410
"description": "Optional. If true, the notebook instance will not register with the proxy.",
14071411
"type": "boolean"
14081412
},
1413+
"enableThirdPartyIdentity": {
1414+
"description": "Optional. Flag that specifies that a notebook can be accessed with third party identity provider.",
1415+
"type": "boolean"
1416+
},
14091417
"gceSetup": {
14101418
"$ref": "GceSetup",
14111419
"description": "Optional. Compute Engine setup for the notebook. Uses notebook-defined fields."
@@ -1718,7 +1726,7 @@
17181726
"type": "string"
17191727
},
17201728
"requestedCancellation": {
1721-
"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`.",
1729+
"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`.",
17221730
"type": "boolean"
17231731
},
17241732
"statusMessage": {

‎src/apis/notebooks/v1.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ export namespace notebooks_v1 {
193193
*/
194194
diagnosticConfig?: Schema$DiagnosticConfig;
195195
/**
196-
* Optional. Maxmium amount of time in minutes before the operation times out.
196+
* Optional. Maximum amount of time in minutes before the operation times out.
197197
*/
198198
timeoutMinutes?: number | null;
199199
}
@@ -206,7 +206,7 @@ export namespace notebooks_v1 {
206206
*/
207207
diagnosticConfig?: Schema$DiagnosticConfig;
208208
/**
209-
* Optional. Maxmium amount of time in minutes before the operation times out.
209+
* Optional. Maximum amount of time in minutes before the operation times out.
210210
*/
211211
timeoutMinutes?: number | null;
212212
}
@@ -573,7 +573,7 @@ export namespace notebooks_v1 {
573573
*/
574574
labels?: {[key: string]: string} | null;
575575
/**
576-
* Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
576+
* Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource) of this instance.
577577
*/
578578
machineType?: string | null;
579579
/**
@@ -998,7 +998,7 @@ export namespace notebooks_v1 {
998998
*/
999999
endTime?: string | null;
10001000
/**
1001-
* 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`.
1001+
* 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`.
10021002
*/
10031003
requestedCancellation?: boolean | null;
10041004
/**
@@ -1419,7 +1419,7 @@ export namespace notebooks_v1 {
14191419
*/
14201420
export interface Schema$SetInstanceMachineTypeRequest {
14211421
/**
1422-
* Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).
1422+
* Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-resource).
14231423
*/
14241424
machineType?: string | null;
14251425
}
@@ -5455,7 +5455,7 @@ export namespace notebooks_v1 {
54555455
}
54565456

54575457
/**
5458-
* 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`.
5458+
* 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`.
54595459
*
54605460
* @param params - Parameters for request
54615461
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

‎src/apis/notebooks/v2.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ export namespace notebooks_v2 {
278278
*/
279279
diagnosticConfig?: Schema$DiagnosticConfig;
280280
/**
281-
* Optional. Maxmium amount of time in minutes before the operation times out.
281+
* Optional. Maximum amount of time in minutes before the operation times out.
282282
*/
283283
timeoutMinutes?: number | null;
284284
}
@@ -456,6 +456,10 @@ export namespace notebooks_v2 {
456456
* Optional. If true, the notebook instance will not register with the proxy.
457457
*/
458458
disableProxyAccess?: boolean | null;
459+
/**
460+
* Optional. Flag that specifies that a notebook can be accessed with third party identity provider.
461+
*/
462+
enableThirdPartyIdentity?: boolean | null;
459463
/**
460464
* Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.
461465
*/
@@ -648,7 +652,7 @@ export namespace notebooks_v2 {
648652
*/
649653
endTime?: string | null;
650654
/**
651-
* 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`.
655+
* 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`.
652656
*/
653657
requestedCancellation?: boolean | null;
654658
/**
@@ -3173,7 +3177,7 @@ export namespace notebooks_v2 {
31733177
}
31743178

31753179
/**
3176-
* 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`.
3180+
* 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`.
31773181
*
31783182
* @param params - Parameters for request
31793183
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

0 commit comments

Comments
 (0)