@maxim_mazurok/gapi.client.workstations-v1 0.2.20260218 → 0.2.20260526

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.
Files changed (3) hide show
  1. package/index.d.ts +31 -25
  2. package/package.json +1 -1
  3. 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: 20260218
12
+ // Revision: 20260526
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -182,6 +182,8 @@ declare namespace gapi.client {
182
182
  sourceSnapshot?: string;
183
183
  }
184
184
  interface GceRegionalPersistentDisk {
185
+ /** 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. */
186
+ archiveTimeout?: string;
185
187
  /** 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
188
  diskType?: string;
187
189
  /** 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"`. */
@@ -369,21 +371,21 @@ declare namespace gapi.client {
369
371
  boostConfig?: string;
370
372
  /** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
371
373
  etag?: string;
372
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
374
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
373
375
  validateOnly?: boolean;
374
376
  }
375
377
  interface Status {
376
378
  /** The status code, which should be an enum value of google.rpc.Code. */
377
379
  code?: number;
378
380
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
379
- details?: Array<{[P in string]: any}>;
381
+ details?: {[P in string]: any}[];
380
382
  /** 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
383
  message?: string;
382
384
  }
383
385
  interface StopWorkstationRequest {
384
386
  /** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
385
387
  etag?: string;
386
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
388
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
387
389
  validateOnly?: boolean;
388
390
  }
389
391
  interface TestIamPermissionsRequest {
@@ -474,6 +476,10 @@ declare namespace gapi.client {
474
476
  uid?: string;
475
477
  /** Output only. Time when this workstation cluster was most recently updated. */
476
478
  updateTime?: string;
479
+ /** 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. */
480
+ workstationAuthorizationUrl?: string;
481
+ /** 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. */
482
+ workstationLaunchUrl?: string;
477
483
  }
478
484
  interface WorkstationConfig {
479
485
  /** 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. */
@@ -705,7 +711,7 @@ declare namespace gapi.client {
705
711
  upload_protocol?: string;
706
712
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
707
713
  uploadType?: string;
708
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
714
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
709
715
  validateOnly?: boolean;
710
716
  /** Required. ID to use for the workstation. */
711
717
  workstationId?: string;
@@ -738,7 +744,7 @@ declare namespace gapi.client {
738
744
  upload_protocol?: string;
739
745
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
740
746
  uploadType?: string;
741
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
747
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
742
748
  validateOnly?: boolean;
743
749
  /** Required. ID to use for the workstation. */
744
750
  workstationId?: string;
@@ -773,7 +779,7 @@ declare namespace gapi.client {
773
779
  upload_protocol?: string;
774
780
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
775
781
  uploadType?: string;
776
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
782
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
777
783
  validateOnly?: boolean;
778
784
  }): Request<Operation>;
779
785
  /** 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 +966,7 @@ declare namespace gapi.client {
960
966
  '$.xgafv'?: '1' | '2';
961
967
  /** OAuth access token. */
962
968
  access_token?: string;
963
- /** Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
969
+ /** Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. */
964
970
  allowMissing?: boolean;
965
971
  /** Data format for response. */
966
972
  alt?: 'json' | 'media' | 'proto';
@@ -978,13 +984,13 @@ declare namespace gapi.client {
978
984
  prettyPrint?: boolean;
979
985
  /** 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
986
  quotaUser?: string;
981
- /** Required. Mask specifying which fields in the workstation configuration should be updated. */
987
+ /** Required. Mask specifying which fields in the workstation should be updated. */
982
988
  updateMask?: string;
983
989
  /** Upload protocol for media (e.g. "raw", "multipart"). */
984
990
  upload_protocol?: string;
985
991
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
986
992
  uploadType?: string;
987
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
993
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
988
994
  validateOnly?: boolean;
989
995
  /** Request body */
990
996
  resource: Workstation;
@@ -995,7 +1001,7 @@ declare namespace gapi.client {
995
1001
  '$.xgafv'?: '1' | '2';
996
1002
  /** OAuth access token. */
997
1003
  access_token?: string;
998
- /** Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
1004
+ /** Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored. */
999
1005
  allowMissing?: boolean;
1000
1006
  /** Data format for response. */
1001
1007
  alt?: 'json' | 'media' | 'proto';
@@ -1013,13 +1019,13 @@ declare namespace gapi.client {
1013
1019
  prettyPrint?: boolean;
1014
1020
  /** 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
1021
  quotaUser?: string;
1016
- /** Required. Mask specifying which fields in the workstation configuration should be updated. */
1022
+ /** Required. Mask specifying which fields in the workstation should be updated. */
1017
1023
  updateMask?: string;
1018
1024
  /** Upload protocol for media (e.g. "raw", "multipart"). */
1019
1025
  upload_protocol?: string;
1020
1026
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1021
1027
  uploadType?: string;
1022
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1028
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1023
1029
  validateOnly?: boolean;
1024
1030
  },
1025
1031
  body: Workstation,
@@ -1228,7 +1234,7 @@ declare namespace gapi.client {
1228
1234
  upload_protocol?: string;
1229
1235
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1230
1236
  uploadType?: string;
1231
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1237
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1232
1238
  validateOnly?: boolean;
1233
1239
  /** Required. ID to use for the workstation configuration. */
1234
1240
  workstationConfigId?: string;
@@ -1261,7 +1267,7 @@ declare namespace gapi.client {
1261
1267
  upload_protocol?: string;
1262
1268
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1263
1269
  uploadType?: string;
1264
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1270
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1265
1271
  validateOnly?: boolean;
1266
1272
  /** Required. ID to use for the workstation configuration. */
1267
1273
  workstationConfigId?: string;
@@ -1298,7 +1304,7 @@ declare namespace gapi.client {
1298
1304
  upload_protocol?: string;
1299
1305
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1300
1306
  uploadType?: string;
1301
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1307
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1302
1308
  validateOnly?: boolean;
1303
1309
  }): Request<Operation>;
1304
1310
  /** Returns the requested workstation configuration. */
@@ -1451,7 +1457,7 @@ declare namespace gapi.client {
1451
1457
  upload_protocol?: string;
1452
1458
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1453
1459
  uploadType?: string;
1454
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1460
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1455
1461
  validateOnly?: boolean;
1456
1462
  /** Request body */
1457
1463
  resource: WorkstationConfig;
@@ -1486,7 +1492,7 @@ declare namespace gapi.client {
1486
1492
  upload_protocol?: string;
1487
1493
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1488
1494
  uploadType?: string;
1489
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1495
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1490
1496
  validateOnly?: boolean;
1491
1497
  },
1492
1498
  body: WorkstationConfig,
@@ -1580,7 +1586,7 @@ declare namespace gapi.client {
1580
1586
  upload_protocol?: string;
1581
1587
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1582
1588
  uploadType?: string;
1583
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1589
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1584
1590
  validateOnly?: boolean;
1585
1591
  /** Required. ID to use for the workstation cluster. */
1586
1592
  workstationClusterId?: string;
@@ -1613,7 +1619,7 @@ declare namespace gapi.client {
1613
1619
  upload_protocol?: string;
1614
1620
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1615
1621
  uploadType?: string;
1616
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1622
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1617
1623
  validateOnly?: boolean;
1618
1624
  /** Required. ID to use for the workstation cluster. */
1619
1625
  workstationClusterId?: string;
@@ -1650,7 +1656,7 @@ declare namespace gapi.client {
1650
1656
  upload_protocol?: string;
1651
1657
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1652
1658
  uploadType?: string;
1653
- /** Optional. If set, validate the request and preview the review, but do not apply it. */
1659
+ /** Optional. If set, validate the request and preview the result, but do not apply it. */
1654
1660
  validateOnly?: boolean;
1655
1661
  }): Request<Operation>;
1656
1662
  /** Returns the requested workstation cluster. */
@@ -1743,7 +1749,7 @@ declare namespace gapi.client {
1743
1749
  upload_protocol?: string;
1744
1750
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1745
1751
  uploadType?: string;
1746
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1752
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1747
1753
  validateOnly?: boolean;
1748
1754
  /** Request body */
1749
1755
  resource: WorkstationCluster;
@@ -1778,7 +1784,7 @@ declare namespace gapi.client {
1778
1784
  upload_protocol?: string;
1779
1785
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1780
1786
  uploadType?: string;
1781
- /** Optional. If set, validate the request and preview the review, but do not actually apply it. */
1787
+ /** Optional. If set, validate the request and preview the result, but do not actually apply it. */
1782
1788
  validateOnly?: boolean;
1783
1789
  },
1784
1790
  body: WorkstationCluster,
@@ -1813,7 +1819,7 @@ declare namespace gapi.client {
1813
1819
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1814
1820
  uploadType?: string;
1815
1821
  }): Request<Location>;
1816
- /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
1822
+ /** 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
1823
  list(request?: {
1818
1824
  /** V1 error format. */
1819
1825
  '$.xgafv'?: '1' | '2';
@@ -1823,7 +1829,7 @@ declare namespace gapi.client {
1823
1829
  alt?: 'json' | 'media' | 'proto';
1824
1830
  /** JSONP */
1825
1831
  callback?: string;
1826
- /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
1832
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
1827
1833
  extraLocationTypes?: string | string[];
1828
1834
  /** Selector specifying which fields to include in a partial response. */
1829
1835
  fields?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workstations-v1",
3
- "version": "0.2.20260218",
3
+ "version": "0.2.20260526",
4
4
  "description": "TypeScript typings for Cloud Workstations API v1",
5
5
  "repository": {
6
6
  "type": "git",
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: