Skip to content

Commit 2b9e8a8

Browse files
feat(notebooks): update the API
#### notebooks:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.type - schemas.ListOperationsResponse.properties.unreachable.description - schemas.ListOperationsResponse.properties.unreachable.items.type - schemas.ListOperationsResponse.properties.unreachable.type The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description #### notebooks:v2 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.type - schemas.DataDisk.properties.resourcePolicies.description - schemas.DataDisk.properties.resourcePolicies.items.type - schemas.DataDisk.properties.resourcePolicies.type - schemas.ListOperationsResponse.properties.unreachable.description - schemas.ListOperationsResponse.properties.unreachable.items.type - schemas.ListOperationsResponse.properties.unreachable.type The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.resources.instances.methods.patch.parameters.name.description - schemas.Instance.properties.name.description
1 parent ca944e1 commit 2b9e8a8

File tree

4 files changed

+72
-15
lines changed

4 files changed

+72
-15
lines changed

discovery/notebooks-v1.json

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
],
145145
"parameters": {
146146
"extraLocationTypes": {
147-
"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
147+
"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
148148
"location": "query",
149149
"repeated": true,
150150
"type": "string"
@@ -1315,6 +1315,11 @@
13151315
"description": "The standard list page token.",
13161316
"location": "query",
13171317
"type": "string"
1318+
},
1319+
"returnPartialSuccess": {
1320+
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1321+
"location": "query",
1322+
"type": "boolean"
13181323
}
13191324
},
13201325
"path": "v1/{+name}/operations",
@@ -2014,7 +2019,7 @@
20142019
}
20152020
}
20162021
},
2017-
"revision": "20250430",
2022+
"revision": "20251008",
20182023
"rootUrl": "https://notebooks.googleapis.com/",
20192024
"schemas": {
20202025
"AcceleratorConfig": {
@@ -3048,6 +3053,13 @@
30483053
"$ref": "Operation"
30493054
},
30503055
"type": "array"
3056+
},
3057+
"unreachable": {
3058+
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
3059+
"items": {
3060+
"type": "string"
3061+
},
3062+
"type": "array"
30513063
}
30523064
},
30533065
"type": "object"

discovery/notebooks-v2.json

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
],
145145
"parameters": {
146146
"extraLocationTypes": {
147-
"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
147+
"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
148148
"location": "query",
149149
"repeated": true,
150150
"type": "string"
@@ -499,7 +499,7 @@
499499
],
500500
"parameters": {
501501
"name": {
502-
"description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
502+
"description": "Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
503503
"location": "path",
504504
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
505505
"required": true,
@@ -949,6 +949,11 @@
949949
"description": "The standard list page token.",
950950
"location": "query",
951951
"type": "string"
952+
},
953+
"returnPartialSuccess": {
954+
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
955+
"location": "query",
956+
"type": "boolean"
952957
}
953958
},
954959
"path": "v2/{+name}/operations",
@@ -966,7 +971,7 @@
966971
}
967972
}
968973
},
969-
"revision": "20250710",
974+
"revision": "20251008",
970975
"rootUrl": "https://notebooks.googleapis.com/",
971976
"schemas": {
972977
"AcceleratorConfig": {
@@ -1268,6 +1273,13 @@
12681273
"kmsKey": {
12691274
"description": "Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about using your own encryption keys.",
12701275
"type": "string"
1276+
},
1277+
"resourcePolicies": {
1278+
"description": "Optional. The resource policies to apply to the data disk.",
1279+
"items": {
1280+
"type": "string"
1281+
},
1282+
"type": "array"
12711283
}
12721284
},
12731285
"type": "object"
@@ -1637,7 +1649,7 @@
16371649
"type": "object"
16381650
},
16391651
"name": {
1640-
"description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
1652+
"description": "Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
16411653
"readOnly": true,
16421654
"type": "string"
16431655
},
@@ -1766,6 +1778,13 @@
17661778
"$ref": "Operation"
17671779
},
17681780
"type": "array"
1781+
},
1782+
"unreachable": {
1783+
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
1784+
"items": {
1785+
"type": "string"
1786+
},
1787+
"type": "array"
17691788
}
17701789
},
17711790
"type": "object"

src/apis/notebooks/v1.ts

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -780,6 +780,10 @@ export namespace notebooks_v1 {
780780
* A list of operations that matches the specified filter in the request.
781781
*/
782782
operations?: Schema$Operation[];
783+
/**
784+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
785+
*/
786+
unreachable?: string[] | null;
783787
}
784788
/**
785789
* Response for listing Managed Notebook Runtimes.
@@ -1957,7 +1961,7 @@ export namespace notebooks_v1 {
19571961
*
19581962
* // Do the magic
19591963
* const res = await notebooks.projects.locations.list({
1960-
* // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
1964+
* // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
19611965
* extraLocationTypes: 'placeholder-value',
19621966
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
19631967
* filter: 'placeholder-value',
@@ -2085,7 +2089,7 @@ export namespace notebooks_v1 {
20852089
export interface Params$Resource$Projects$Locations$List
20862090
extends StandardParameters {
20872091
/**
2088-
* Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2092+
* Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
20892093
*/
20902094
extraLocationTypes?: string[];
20912095
/**
@@ -8073,13 +8077,16 @@ export namespace notebooks_v1 {
80738077
* pageSize: 'placeholder-value',
80748078
* // The standard list page token.
80758079
* pageToken: 'placeholder-value',
8080+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
8081+
* returnPartialSuccess: 'placeholder-value',
80768082
* });
80778083
* console.log(res.data);
80788084
*
80798085
* // Example response
80808086
* // {
80818087
* // "nextPageToken": "my_nextPageToken",
8082-
* // "operations": []
8088+
* // "operations": [],
8089+
* // "unreachable": []
80838090
* // }
80848091
* }
80858092
*
@@ -8225,6 +8232,10 @@ export namespace notebooks_v1 {
82258232
* The standard list page token.
82268233
*/
82278234
pageToken?: string;
8235+
/**
8236+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
8237+
*/
8238+
returnPartialSuccess?: boolean;
82288239
}
82298240

82308241
export class Resource$Projects$Locations$Runtimes {

src/apis/notebooks/v2.ts

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,10 @@ export namespace notebooks_v2 {
298298
* Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id\}/locations/{location\}/keyRings/{key_ring_id\}/cryptoKeys/{key_id\}` Learn more about using your own encryption keys.
299299
*/
300300
kmsKey?: string | null;
301+
/**
302+
* Optional. The resource policies to apply to the data disk.
303+
*/
304+
resourcePolicies?: string[] | null;
301305
}
302306
/**
303307
* DefaultValues represents the default configuration values.
@@ -570,7 +574,7 @@ export namespace notebooks_v2 {
570574
*/
571575
labels?: {[key: string]: string} | null;
572576
/**
573-
* Output only. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
577+
* Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
574578
*/
575579
name?: string | null;
576580
/**
@@ -644,6 +648,10 @@ export namespace notebooks_v2 {
644648
* A list of operations that matches the specified filter in the request.
645649
*/
646650
operations?: Schema$Operation[];
651+
/**
652+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
653+
*/
654+
unreachable?: string[] | null;
647655
}
648656
/**
649657
* A resource that represents a Google Cloud location.
@@ -1209,7 +1217,7 @@ export namespace notebooks_v2 {
12091217
*
12101218
* // Do the magic
12111219
* const res = await notebooks.projects.locations.list({
1212-
* // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
1220+
* // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
12131221
* extraLocationTypes: 'placeholder-value',
12141222
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
12151223
* filter: 'placeholder-value',
@@ -1337,7 +1345,7 @@ export namespace notebooks_v2 {
13371345
export interface Params$Resource$Projects$Locations$List
13381346
extends StandardParameters {
13391347
/**
1340-
* Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
1348+
* Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
13411349
*/
13421350
extraLocationTypes?: string[];
13431351
/**
@@ -2897,7 +2905,7 @@ export namespace notebooks_v2 {
28972905
*
28982906
* // Do the magic
28992907
* const res = await notebooks.projects.locations.instances.patch({
2900-
* // Output only. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
2908+
* // Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
29012909
* name: 'projects/my-project/locations/my-location/instances/my-instance',
29022910
* // Optional. Idempotent request UUID.
29032911
* requestId: 'placeholder-value',
@@ -4789,7 +4797,7 @@ export namespace notebooks_v2 {
47894797
export interface Params$Resource$Projects$Locations$Instances$Patch
47904798
extends StandardParameters {
47914799
/**
4792-
* Output only. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
4800+
* Output only. Identifier. The name of this notebook instance. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}`
47934801
*/
47944802
name?: string;
47954803
/**
@@ -5392,13 +5400,16 @@ export namespace notebooks_v2 {
53925400
* pageSize: 'placeholder-value',
53935401
* // The standard list page token.
53945402
* pageToken: 'placeholder-value',
5403+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
5404+
* returnPartialSuccess: 'placeholder-value',
53955405
* });
53965406
* console.log(res.data);
53975407
*
53985408
* // Example response
53995409
* // {
54005410
* // "nextPageToken": "my_nextPageToken",
5401-
* // "operations": []
5411+
* // "operations": [],
5412+
* // "unreachable": []
54025413
* // }
54035414
* }
54045415
*
@@ -5544,5 +5555,9 @@ export namespace notebooks_v2 {
55445555
* The standard list page token.
55455556
*/
55465557
pageToken?: string;
5558+
/**
5559+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
5560+
*/
5561+
returnPartialSuccess?: boolean;
55475562
}
55485563
}

0 commit comments

Comments
 (0)