@maxim_mazurok/gapi.client.workstations-v1 0.2.20260218 → 0.2.20260604
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +43 -25
- package/package.json +1 -1
- package/readme.md +17 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://workstations.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260604
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -120,6 +120,8 @@ declare namespace gapi.client {
|
|
|
120
120
|
interface GceHyperdiskBalancedHighAvailability {
|
|
121
121
|
/** Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. */
|
|
122
122
|
archiveTimeout?: string;
|
|
123
|
+
/** Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to unlimited if not set. */
|
|
124
|
+
maxSizeGb?: number;
|
|
123
125
|
/** Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. */
|
|
124
126
|
reclaimPolicy?: 'RECLAIM_POLICY_UNSPECIFIED' | 'DELETE' | 'RETAIN';
|
|
125
127
|
/** Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. */
|
|
@@ -182,10 +184,14 @@ declare namespace gapi.client {
|
|
|
182
184
|
sourceSnapshot?: string;
|
|
183
185
|
}
|
|
184
186
|
interface GceRegionalPersistentDisk {
|
|
187
|
+
/** Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. */
|
|
188
|
+
archiveTimeout?: string;
|
|
185
189
|
/** Optional. The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`. */
|
|
186
190
|
diskType?: string;
|
|
187
191
|
/** Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to `"ext4"`. */
|
|
188
192
|
fsType?: string;
|
|
193
|
+
/** Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to unlimited if not set. */
|
|
194
|
+
maxSizeGb?: number;
|
|
189
195
|
/** Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. */
|
|
190
196
|
reclaimPolicy?: 'RECLAIM_POLICY_UNSPECIFIED' | 'DELETE' | 'RETAIN';
|
|
191
197
|
/** Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`. */
|
|
@@ -369,21 +375,21 @@ declare namespace gapi.client {
|
|
|
369
375
|
boostConfig?: string;
|
|
370
376
|
/** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
|
|
371
377
|
etag?: string;
|
|
372
|
-
/** Optional. If set, validate the request and preview the
|
|
378
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
373
379
|
validateOnly?: boolean;
|
|
374
380
|
}
|
|
375
381
|
interface Status {
|
|
376
382
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
377
383
|
code?: number;
|
|
378
384
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
379
|
-
details?:
|
|
385
|
+
details?: {[P in string]: any}[];
|
|
380
386
|
/** 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. */
|
|
381
387
|
message?: string;
|
|
382
388
|
}
|
|
383
389
|
interface StopWorkstationRequest {
|
|
384
390
|
/** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
|
|
385
391
|
etag?: string;
|
|
386
|
-
/** Optional. If set, validate the request and preview the
|
|
392
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
387
393
|
validateOnly?: boolean;
|
|
388
394
|
}
|
|
389
395
|
interface TestIamPermissionsRequest {
|
|
@@ -415,6 +421,8 @@ declare namespace gapi.client {
|
|
|
415
421
|
labels?: {[P in string]: string};
|
|
416
422
|
/** Identifier. Full name of this workstation. */
|
|
417
423
|
name?: string;
|
|
424
|
+
/** Optional. Directories to persist across workstation sessions. */
|
|
425
|
+
persistentDirectories?: WorkstationPersistentDirectory[];
|
|
418
426
|
/** Output only. Indicates whether this workstation is currently being updated to match its intended state. */
|
|
419
427
|
reconciling?: boolean;
|
|
420
428
|
/** Optional. Output only. Runtime host for the workstation when in STATE_RUNNING. */
|
|
@@ -474,6 +482,10 @@ declare namespace gapi.client {
|
|
|
474
482
|
uid?: string;
|
|
475
483
|
/** Output only. Time when this workstation cluster was most recently updated. */
|
|
476
484
|
updateTime?: string;
|
|
485
|
+
/** Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. */
|
|
486
|
+
workstationAuthorizationUrl?: string;
|
|
487
|
+
/** Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. */
|
|
488
|
+
workstationLaunchUrl?: string;
|
|
477
489
|
}
|
|
478
490
|
interface WorkstationConfig {
|
|
479
491
|
/** Optional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535. */
|
|
@@ -529,6 +541,12 @@ declare namespace gapi.client {
|
|
|
529
541
|
/** Output only. Time when this workstation configuration was most recently updated. */
|
|
530
542
|
updateTime?: string;
|
|
531
543
|
}
|
|
544
|
+
interface WorkstationPersistentDirectory {
|
|
545
|
+
/** Optional. The mount path of the persistent directory. */
|
|
546
|
+
mountPath?: string;
|
|
547
|
+
/** Optional. Size of the persistent directory in GB. If specified in an update request, this is the desired size of the directory. */
|
|
548
|
+
sizeGb?: number;
|
|
549
|
+
}
|
|
532
550
|
interface OperationsResource {
|
|
533
551
|
/** 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`. */
|
|
534
552
|
cancel(request: {
|
|
@@ -705,7 +723,7 @@ declare namespace gapi.client {
|
|
|
705
723
|
upload_protocol?: string;
|
|
706
724
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
707
725
|
uploadType?: string;
|
|
708
|
-
/** Optional. If set, validate the request and preview the
|
|
726
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
709
727
|
validateOnly?: boolean;
|
|
710
728
|
/** Required. ID to use for the workstation. */
|
|
711
729
|
workstationId?: string;
|
|
@@ -738,7 +756,7 @@ declare namespace gapi.client {
|
|
|
738
756
|
upload_protocol?: string;
|
|
739
757
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
740
758
|
uploadType?: string;
|
|
741
|
-
/** Optional. If set, validate the request and preview the
|
|
759
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
742
760
|
validateOnly?: boolean;
|
|
743
761
|
/** Required. ID to use for the workstation. */
|
|
744
762
|
workstationId?: string;
|
|
@@ -773,7 +791,7 @@ declare namespace gapi.client {
|
|
|
773
791
|
upload_protocol?: string;
|
|
774
792
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
775
793
|
uploadType?: string;
|
|
776
|
-
/** Optional. If set, validate the request and preview the
|
|
794
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
777
795
|
validateOnly?: boolean;
|
|
778
796
|
}): Request<Operation>;
|
|
779
797
|
/** Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token. */
|
|
@@ -960,7 +978,7 @@ declare namespace gapi.client {
|
|
|
960
978
|
'$.xgafv'?: '1' | '2';
|
|
961
979
|
/** OAuth access token. */
|
|
962
980
|
access_token?: string;
|
|
963
|
-
/** Optional. If set and the workstation
|
|
981
|
+
/** Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. */
|
|
964
982
|
allowMissing?: boolean;
|
|
965
983
|
/** Data format for response. */
|
|
966
984
|
alt?: 'json' | 'media' | 'proto';
|
|
@@ -978,13 +996,13 @@ declare namespace gapi.client {
|
|
|
978
996
|
prettyPrint?: boolean;
|
|
979
997
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
980
998
|
quotaUser?: string;
|
|
981
|
-
/** Required. Mask specifying which fields in the workstation
|
|
999
|
+
/** Required. Mask specifying which fields in the workstation should be updated. */
|
|
982
1000
|
updateMask?: string;
|
|
983
1001
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
984
1002
|
upload_protocol?: string;
|
|
985
1003
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
986
1004
|
uploadType?: string;
|
|
987
|
-
/** Optional. If set, validate the request and preview the
|
|
1005
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
988
1006
|
validateOnly?: boolean;
|
|
989
1007
|
/** Request body */
|
|
990
1008
|
resource: Workstation;
|
|
@@ -995,7 +1013,7 @@ declare namespace gapi.client {
|
|
|
995
1013
|
'$.xgafv'?: '1' | '2';
|
|
996
1014
|
/** OAuth access token. */
|
|
997
1015
|
access_token?: string;
|
|
998
|
-
/** Optional. If set and the workstation
|
|
1016
|
+
/** Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. */
|
|
999
1017
|
allowMissing?: boolean;
|
|
1000
1018
|
/** Data format for response. */
|
|
1001
1019
|
alt?: 'json' | 'media' | 'proto';
|
|
@@ -1013,13 +1031,13 @@ declare namespace gapi.client {
|
|
|
1013
1031
|
prettyPrint?: boolean;
|
|
1014
1032
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1015
1033
|
quotaUser?: string;
|
|
1016
|
-
/** Required. Mask specifying which fields in the workstation
|
|
1034
|
+
/** Required. Mask specifying which fields in the workstation should be updated. */
|
|
1017
1035
|
updateMask?: string;
|
|
1018
1036
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1019
1037
|
upload_protocol?: string;
|
|
1020
1038
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1021
1039
|
uploadType?: string;
|
|
1022
|
-
/** Optional. If set, validate the request and preview the
|
|
1040
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1023
1041
|
validateOnly?: boolean;
|
|
1024
1042
|
},
|
|
1025
1043
|
body: Workstation,
|
|
@@ -1228,7 +1246,7 @@ declare namespace gapi.client {
|
|
|
1228
1246
|
upload_protocol?: string;
|
|
1229
1247
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1230
1248
|
uploadType?: string;
|
|
1231
|
-
/** Optional. If set, validate the request and preview the
|
|
1249
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1232
1250
|
validateOnly?: boolean;
|
|
1233
1251
|
/** Required. ID to use for the workstation configuration. */
|
|
1234
1252
|
workstationConfigId?: string;
|
|
@@ -1261,7 +1279,7 @@ declare namespace gapi.client {
|
|
|
1261
1279
|
upload_protocol?: string;
|
|
1262
1280
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1263
1281
|
uploadType?: string;
|
|
1264
|
-
/** Optional. If set, validate the request and preview the
|
|
1282
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1265
1283
|
validateOnly?: boolean;
|
|
1266
1284
|
/** Required. ID to use for the workstation configuration. */
|
|
1267
1285
|
workstationConfigId?: string;
|
|
@@ -1298,7 +1316,7 @@ declare namespace gapi.client {
|
|
|
1298
1316
|
upload_protocol?: string;
|
|
1299
1317
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1300
1318
|
uploadType?: string;
|
|
1301
|
-
/** Optional. If set, validate the request and preview the
|
|
1319
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1302
1320
|
validateOnly?: boolean;
|
|
1303
1321
|
}): Request<Operation>;
|
|
1304
1322
|
/** Returns the requested workstation configuration. */
|
|
@@ -1451,7 +1469,7 @@ declare namespace gapi.client {
|
|
|
1451
1469
|
upload_protocol?: string;
|
|
1452
1470
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1453
1471
|
uploadType?: string;
|
|
1454
|
-
/** Optional. If set, validate the request and preview the
|
|
1472
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1455
1473
|
validateOnly?: boolean;
|
|
1456
1474
|
/** Request body */
|
|
1457
1475
|
resource: WorkstationConfig;
|
|
@@ -1486,7 +1504,7 @@ declare namespace gapi.client {
|
|
|
1486
1504
|
upload_protocol?: string;
|
|
1487
1505
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1488
1506
|
uploadType?: string;
|
|
1489
|
-
/** Optional. If set, validate the request and preview the
|
|
1507
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1490
1508
|
validateOnly?: boolean;
|
|
1491
1509
|
},
|
|
1492
1510
|
body: WorkstationConfig,
|
|
@@ -1580,7 +1598,7 @@ declare namespace gapi.client {
|
|
|
1580
1598
|
upload_protocol?: string;
|
|
1581
1599
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1582
1600
|
uploadType?: string;
|
|
1583
|
-
/** Optional. If set, validate the request and preview the
|
|
1601
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1584
1602
|
validateOnly?: boolean;
|
|
1585
1603
|
/** Required. ID to use for the workstation cluster. */
|
|
1586
1604
|
workstationClusterId?: string;
|
|
@@ -1613,7 +1631,7 @@ declare namespace gapi.client {
|
|
|
1613
1631
|
upload_protocol?: string;
|
|
1614
1632
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1615
1633
|
uploadType?: string;
|
|
1616
|
-
/** Optional. If set, validate the request and preview the
|
|
1634
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1617
1635
|
validateOnly?: boolean;
|
|
1618
1636
|
/** Required. ID to use for the workstation cluster. */
|
|
1619
1637
|
workstationClusterId?: string;
|
|
@@ -1650,7 +1668,7 @@ declare namespace gapi.client {
|
|
|
1650
1668
|
upload_protocol?: string;
|
|
1651
1669
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1652
1670
|
uploadType?: string;
|
|
1653
|
-
/** Optional. If set, validate the request and preview the
|
|
1671
|
+
/** Optional. If set, validate the request and preview the result, but do not apply it. */
|
|
1654
1672
|
validateOnly?: boolean;
|
|
1655
1673
|
}): Request<Operation>;
|
|
1656
1674
|
/** Returns the requested workstation cluster. */
|
|
@@ -1743,7 +1761,7 @@ declare namespace gapi.client {
|
|
|
1743
1761
|
upload_protocol?: string;
|
|
1744
1762
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1745
1763
|
uploadType?: string;
|
|
1746
|
-
/** Optional. If set, validate the request and preview the
|
|
1764
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1747
1765
|
validateOnly?: boolean;
|
|
1748
1766
|
/** Request body */
|
|
1749
1767
|
resource: WorkstationCluster;
|
|
@@ -1778,7 +1796,7 @@ declare namespace gapi.client {
|
|
|
1778
1796
|
upload_protocol?: string;
|
|
1779
1797
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1780
1798
|
uploadType?: string;
|
|
1781
|
-
/** Optional. If set, validate the request and preview the
|
|
1799
|
+
/** Optional. If set, validate the request and preview the result, but do not actually apply it. */
|
|
1782
1800
|
validateOnly?: boolean;
|
|
1783
1801
|
},
|
|
1784
1802
|
body: WorkstationCluster,
|
|
@@ -1813,7 +1831,7 @@ declare namespace gapi.client {
|
|
|
1813
1831
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1814
1832
|
uploadType?: string;
|
|
1815
1833
|
}): Request<Location>;
|
|
1816
|
-
/** Lists information about the supported locations for this service. This method
|
|
1834
|
+
/** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
|
|
1817
1835
|
list(request?: {
|
|
1818
1836
|
/** V1 error format. */
|
|
1819
1837
|
'$.xgafv'?: '1' | '2';
|
|
@@ -1823,7 +1841,7 @@ declare namespace gapi.client {
|
|
|
1823
1841
|
alt?: 'json' | 'media' | 'proto';
|
|
1824
1842
|
/** JSONP */
|
|
1825
1843
|
callback?: string;
|
|
1826
|
-
/** Optional. Do not use this field
|
|
1844
|
+
/** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
1827
1845
|
extraLocationTypes?: string | string[];
|
|
1828
1846
|
/** Selector specifying which fields to include in a partial response. */
|
|
1829
1847
|
fields?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Cloud Workstations API:
|
|
|
11
11
|
npm install @types/gapi.client.workstations-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.workstations-v1"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|