@maxim_mazurok/gapi.client.workstations-v1 0.1.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 +128 -113
  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
 
@@ -40,7 +40,11 @@ declare namespace gapi.client {
40
40
  /** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
41
41
  exemptedMembers?: string[];
42
42
  /** The log type that this config enables. */
43
- logType?: string;
43
+ logType?:
44
+ | 'LOG_TYPE_UNSPECIFIED'
45
+ | 'ADMIN_READ'
46
+ | 'DATA_WRITE'
47
+ | 'DATA_READ';
44
48
  }
45
49
  interface Binding {
46
50
  /** The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
@@ -117,7 +121,7 @@ declare namespace gapi.client {
117
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. */
118
122
  archiveTimeout?: string;
119
123
  /** Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. */
120
- reclaimPolicy?: string;
124
+ reclaimPolicy?: 'RECLAIM_POLICY_UNSPECIFIED' | 'DELETE' | 'RETAIN';
121
125
  /** 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`. */
122
126
  sizeGb?: number;
123
127
  /** Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. */
@@ -178,12 +182,14 @@ declare namespace gapi.client {
178
182
  sourceSnapshot?: string;
179
183
  }
180
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;
181
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"`. */
182
188
  diskType?: string;
183
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"`. */
184
190
  fsType?: string;
185
191
  /** Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. */
186
- reclaimPolicy?: string;
192
+ reclaimPolicy?: 'RECLAIM_POLICY_UNSPECIFIED' | 'DELETE' | 'RETAIN';
187
193
  /** 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"`. */
188
194
  sizeGb?: number;
189
195
  /** Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions. */
@@ -365,21 +371,21 @@ declare namespace gapi.client {
365
371
  boostConfig?: string;
366
372
  /** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
367
373
  etag?: string;
368
- /** 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. */
369
375
  validateOnly?: boolean;
370
376
  }
371
377
  interface Status {
372
378
  /** The status code, which should be an enum value of google.rpc.Code. */
373
379
  code?: number;
374
380
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
375
- details?: Array<{[P in string]: any}>;
381
+ details?: {[P in string]: any}[];
376
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. */
377
383
  message?: string;
378
384
  }
379
385
  interface StopWorkstationRequest {
380
386
  /** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
381
387
  etag?: string;
382
- /** 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. */
383
389
  validateOnly?: boolean;
384
390
  }
385
391
  interface TestIamPermissionsRequest {
@@ -420,7 +426,12 @@ declare namespace gapi.client {
420
426
  /** Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. */
421
427
  startTime?: string;
422
428
  /** Output only. Current state of the workstation. */
423
- state?: string;
429
+ state?:
430
+ | 'STATE_UNSPECIFIED'
431
+ | 'STATE_STARTING'
432
+ | 'STATE_RUNNING'
433
+ | 'STATE_STOPPING'
434
+ | 'STATE_STOPPED';
424
435
  /** Output only. A system-assigned unique identifier for this workstation. */
425
436
  uid?: string;
426
437
  /** Output only. Time when this workstation was most recently updated. */
@@ -465,6 +476,10 @@ declare namespace gapi.client {
465
476
  uid?: string;
466
477
  /** Output only. Time when this workstation cluster was most recently updated. */
467
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;
468
483
  }
469
484
  interface WorkstationConfig {
470
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. */
@@ -524,11 +539,11 @@ declare namespace gapi.client {
524
539
  /** 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`. */
525
540
  cancel(request: {
526
541
  /** V1 error format. */
527
- '$.xgafv'?: string;
542
+ '$.xgafv'?: '1' | '2';
528
543
  /** OAuth access token. */
529
544
  access_token?: string;
530
545
  /** Data format for response. */
531
- alt?: string;
546
+ alt?: 'json' | 'media' | 'proto';
532
547
  /** JSONP */
533
548
  callback?: string;
534
549
  /** Selector specifying which fields to include in a partial response. */
@@ -553,11 +568,11 @@ declare namespace gapi.client {
553
568
  cancel(
554
569
  request: {
555
570
  /** V1 error format. */
556
- '$.xgafv'?: string;
571
+ '$.xgafv'?: '1' | '2';
557
572
  /** OAuth access token. */
558
573
  access_token?: string;
559
574
  /** Data format for response. */
560
- alt?: string;
575
+ alt?: 'json' | 'media' | 'proto';
561
576
  /** JSONP */
562
577
  callback?: string;
563
578
  /** Selector specifying which fields to include in a partial response. */
@@ -582,11 +597,11 @@ declare namespace gapi.client {
582
597
  /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
583
598
  delete(request?: {
584
599
  /** V1 error format. */
585
- '$.xgafv'?: string;
600
+ '$.xgafv'?: '1' | '2';
586
601
  /** OAuth access token. */
587
602
  access_token?: string;
588
603
  /** Data format for response. */
589
- alt?: string;
604
+ alt?: 'json' | 'media' | 'proto';
590
605
  /** JSONP */
591
606
  callback?: string;
592
607
  /** Selector specifying which fields to include in a partial response. */
@@ -609,11 +624,11 @@ declare namespace gapi.client {
609
624
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
610
625
  get(request?: {
611
626
  /** V1 error format. */
612
- '$.xgafv'?: string;
627
+ '$.xgafv'?: '1' | '2';
613
628
  /** OAuth access token. */
614
629
  access_token?: string;
615
630
  /** Data format for response. */
616
- alt?: string;
631
+ alt?: 'json' | 'media' | 'proto';
617
632
  /** JSONP */
618
633
  callback?: string;
619
634
  /** Selector specifying which fields to include in a partial response. */
@@ -636,11 +651,11 @@ declare namespace gapi.client {
636
651
  /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
637
652
  list(request?: {
638
653
  /** V1 error format. */
639
- '$.xgafv'?: string;
654
+ '$.xgafv'?: '1' | '2';
640
655
  /** OAuth access token. */
641
656
  access_token?: string;
642
657
  /** Data format for response. */
643
- alt?: string;
658
+ alt?: 'json' | 'media' | 'proto';
644
659
  /** JSONP */
645
660
  callback?: string;
646
661
  /** Selector specifying which fields to include in a partial response. */
@@ -673,11 +688,11 @@ declare namespace gapi.client {
673
688
  /** Creates a new workstation. */
674
689
  create(request: {
675
690
  /** V1 error format. */
676
- '$.xgafv'?: string;
691
+ '$.xgafv'?: '1' | '2';
677
692
  /** OAuth access token. */
678
693
  access_token?: string;
679
694
  /** Data format for response. */
680
- alt?: string;
695
+ alt?: 'json' | 'media' | 'proto';
681
696
  /** JSONP */
682
697
  callback?: string;
683
698
  /** Selector specifying which fields to include in a partial response. */
@@ -696,7 +711,7 @@ declare namespace gapi.client {
696
711
  upload_protocol?: string;
697
712
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
698
713
  uploadType?: string;
699
- /** 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. */
700
715
  validateOnly?: boolean;
701
716
  /** Required. ID to use for the workstation. */
702
717
  workstationId?: string;
@@ -706,11 +721,11 @@ declare namespace gapi.client {
706
721
  create(
707
722
  request: {
708
723
  /** V1 error format. */
709
- '$.xgafv'?: string;
724
+ '$.xgafv'?: '1' | '2';
710
725
  /** OAuth access token. */
711
726
  access_token?: string;
712
727
  /** Data format for response. */
713
- alt?: string;
728
+ alt?: 'json' | 'media' | 'proto';
714
729
  /** JSONP */
715
730
  callback?: string;
716
731
  /** Selector specifying which fields to include in a partial response. */
@@ -729,7 +744,7 @@ declare namespace gapi.client {
729
744
  upload_protocol?: string;
730
745
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
731
746
  uploadType?: string;
732
- /** 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. */
733
748
  validateOnly?: boolean;
734
749
  /** Required. ID to use for the workstation. */
735
750
  workstationId?: string;
@@ -739,11 +754,11 @@ declare namespace gapi.client {
739
754
  /** Deletes the specified workstation. */
740
755
  delete(request?: {
741
756
  /** V1 error format. */
742
- '$.xgafv'?: string;
757
+ '$.xgafv'?: '1' | '2';
743
758
  /** OAuth access token. */
744
759
  access_token?: string;
745
760
  /** Data format for response. */
746
- alt?: string;
761
+ alt?: 'json' | 'media' | 'proto';
747
762
  /** JSONP */
748
763
  callback?: string;
749
764
  /** Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
@@ -764,17 +779,17 @@ declare namespace gapi.client {
764
779
  upload_protocol?: string;
765
780
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
766
781
  uploadType?: string;
767
- /** 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. */
768
783
  validateOnly?: boolean;
769
784
  }): Request<Operation>;
770
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. */
771
786
  generateAccessToken(request: {
772
787
  /** V1 error format. */
773
- '$.xgafv'?: string;
788
+ '$.xgafv'?: '1' | '2';
774
789
  /** OAuth access token. */
775
790
  access_token?: string;
776
791
  /** Data format for response. */
777
- alt?: string;
792
+ alt?: 'json' | 'media' | 'proto';
778
793
  /** JSONP */
779
794
  callback?: string;
780
795
  /** Selector specifying which fields to include in a partial response. */
@@ -799,11 +814,11 @@ declare namespace gapi.client {
799
814
  generateAccessToken(
800
815
  request: {
801
816
  /** V1 error format. */
802
- '$.xgafv'?: string;
817
+ '$.xgafv'?: '1' | '2';
803
818
  /** OAuth access token. */
804
819
  access_token?: string;
805
820
  /** Data format for response. */
806
- alt?: string;
821
+ alt?: 'json' | 'media' | 'proto';
807
822
  /** JSONP */
808
823
  callback?: string;
809
824
  /** Selector specifying which fields to include in a partial response. */
@@ -828,11 +843,11 @@ declare namespace gapi.client {
828
843
  /** Returns the requested workstation. */
829
844
  get(request?: {
830
845
  /** V1 error format. */
831
- '$.xgafv'?: string;
846
+ '$.xgafv'?: '1' | '2';
832
847
  /** OAuth access token. */
833
848
  access_token?: string;
834
849
  /** Data format for response. */
835
- alt?: string;
850
+ alt?: 'json' | 'media' | 'proto';
836
851
  /** JSONP */
837
852
  callback?: string;
838
853
  /** Selector specifying which fields to include in a partial response. */
@@ -855,11 +870,11 @@ declare namespace gapi.client {
855
870
  /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
856
871
  getIamPolicy(request?: {
857
872
  /** V1 error format. */
858
- '$.xgafv'?: string;
873
+ '$.xgafv'?: '1' | '2';
859
874
  /** OAuth access token. */
860
875
  access_token?: string;
861
876
  /** Data format for response. */
862
- alt?: string;
877
+ alt?: 'json' | 'media' | 'proto';
863
878
  /** JSONP */
864
879
  callback?: string;
865
880
  /** Selector specifying which fields to include in a partial response. */
@@ -884,11 +899,11 @@ declare namespace gapi.client {
884
899
  /** Returns all Workstations using the specified workstation configuration. */
885
900
  list(request?: {
886
901
  /** V1 error format. */
887
- '$.xgafv'?: string;
902
+ '$.xgafv'?: '1' | '2';
888
903
  /** OAuth access token. */
889
904
  access_token?: string;
890
905
  /** Data format for response. */
891
- alt?: string;
906
+ alt?: 'json' | 'media' | 'proto';
892
907
  /** JSONP */
893
908
  callback?: string;
894
909
  /** Selector specifying which fields to include in a partial response. */
@@ -917,11 +932,11 @@ declare namespace gapi.client {
917
932
  /** Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. */
918
933
  listUsable(request?: {
919
934
  /** V1 error format. */
920
- '$.xgafv'?: string;
935
+ '$.xgafv'?: '1' | '2';
921
936
  /** OAuth access token. */
922
937
  access_token?: string;
923
938
  /** Data format for response. */
924
- alt?: string;
939
+ alt?: 'json' | 'media' | 'proto';
925
940
  /** JSONP */
926
941
  callback?: string;
927
942
  /** Selector specifying which fields to include in a partial response. */
@@ -948,13 +963,13 @@ declare namespace gapi.client {
948
963
  /** Updates an existing workstation. */
949
964
  patch(request: {
950
965
  /** V1 error format. */
951
- '$.xgafv'?: string;
966
+ '$.xgafv'?: '1' | '2';
952
967
  /** OAuth access token. */
953
968
  access_token?: string;
954
- /** 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. */
955
970
  allowMissing?: boolean;
956
971
  /** Data format for response. */
957
- alt?: string;
972
+ alt?: 'json' | 'media' | 'proto';
958
973
  /** JSONP */
959
974
  callback?: string;
960
975
  /** Selector specifying which fields to include in a partial response. */
@@ -969,13 +984,13 @@ declare namespace gapi.client {
969
984
  prettyPrint?: boolean;
970
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. */
971
986
  quotaUser?: string;
972
- /** Required. Mask specifying which fields in the workstation configuration should be updated. */
987
+ /** Required. Mask specifying which fields in the workstation should be updated. */
973
988
  updateMask?: string;
974
989
  /** Upload protocol for media (e.g. "raw", "multipart"). */
975
990
  upload_protocol?: string;
976
991
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
977
992
  uploadType?: string;
978
- /** 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. */
979
994
  validateOnly?: boolean;
980
995
  /** Request body */
981
996
  resource: Workstation;
@@ -983,13 +998,13 @@ declare namespace gapi.client {
983
998
  patch(
984
999
  request: {
985
1000
  /** V1 error format. */
986
- '$.xgafv'?: string;
1001
+ '$.xgafv'?: '1' | '2';
987
1002
  /** OAuth access token. */
988
1003
  access_token?: string;
989
- /** 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. */
990
1005
  allowMissing?: boolean;
991
1006
  /** Data format for response. */
992
- alt?: string;
1007
+ alt?: 'json' | 'media' | 'proto';
993
1008
  /** JSONP */
994
1009
  callback?: string;
995
1010
  /** Selector specifying which fields to include in a partial response. */
@@ -1004,13 +1019,13 @@ declare namespace gapi.client {
1004
1019
  prettyPrint?: boolean;
1005
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. */
1006
1021
  quotaUser?: string;
1007
- /** Required. Mask specifying which fields in the workstation configuration should be updated. */
1022
+ /** Required. Mask specifying which fields in the workstation should be updated. */
1008
1023
  updateMask?: string;
1009
1024
  /** Upload protocol for media (e.g. "raw", "multipart"). */
1010
1025
  upload_protocol?: string;
1011
1026
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1012
1027
  uploadType?: string;
1013
- /** 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. */
1014
1029
  validateOnly?: boolean;
1015
1030
  },
1016
1031
  body: Workstation,
@@ -1019,11 +1034,11 @@ declare namespace gapi.client {
1019
1034
  setIamPolicy(
1020
1035
  request: {
1021
1036
  /** V1 error format. */
1022
- '$.xgafv'?: string;
1037
+ '$.xgafv'?: '1' | '2';
1023
1038
  /** OAuth access token. */
1024
1039
  access_token?: string;
1025
1040
  /** Data format for response. */
1026
- alt?: string;
1041
+ alt?: 'json' | 'media' | 'proto';
1027
1042
  /** JSONP */
1028
1043
  callback?: string;
1029
1044
  /** Selector specifying which fields to include in a partial response. */
@@ -1048,11 +1063,11 @@ declare namespace gapi.client {
1048
1063
  /** Starts running a workstation so that users can connect to it. */
1049
1064
  start(request: {
1050
1065
  /** V1 error format. */
1051
- '$.xgafv'?: string;
1066
+ '$.xgafv'?: '1' | '2';
1052
1067
  /** OAuth access token. */
1053
1068
  access_token?: string;
1054
1069
  /** Data format for response. */
1055
- alt?: string;
1070
+ alt?: 'json' | 'media' | 'proto';
1056
1071
  /** JSONP */
1057
1072
  callback?: string;
1058
1073
  /** Selector specifying which fields to include in a partial response. */
@@ -1077,11 +1092,11 @@ declare namespace gapi.client {
1077
1092
  start(
1078
1093
  request: {
1079
1094
  /** V1 error format. */
1080
- '$.xgafv'?: string;
1095
+ '$.xgafv'?: '1' | '2';
1081
1096
  /** OAuth access token. */
1082
1097
  access_token?: string;
1083
1098
  /** Data format for response. */
1084
- alt?: string;
1099
+ alt?: 'json' | 'media' | 'proto';
1085
1100
  /** JSONP */
1086
1101
  callback?: string;
1087
1102
  /** Selector specifying which fields to include in a partial response. */
@@ -1106,11 +1121,11 @@ declare namespace gapi.client {
1106
1121
  /** Stops running a workstation, reducing costs. */
1107
1122
  stop(request: {
1108
1123
  /** V1 error format. */
1109
- '$.xgafv'?: string;
1124
+ '$.xgafv'?: '1' | '2';
1110
1125
  /** OAuth access token. */
1111
1126
  access_token?: string;
1112
1127
  /** Data format for response. */
1113
- alt?: string;
1128
+ alt?: 'json' | 'media' | 'proto';
1114
1129
  /** JSONP */
1115
1130
  callback?: string;
1116
1131
  /** Selector specifying which fields to include in a partial response. */
@@ -1135,11 +1150,11 @@ declare namespace gapi.client {
1135
1150
  stop(
1136
1151
  request: {
1137
1152
  /** V1 error format. */
1138
- '$.xgafv'?: string;
1153
+ '$.xgafv'?: '1' | '2';
1139
1154
  /** OAuth access token. */
1140
1155
  access_token?: string;
1141
1156
  /** Data format for response. */
1142
- alt?: string;
1157
+ alt?: 'json' | 'media' | 'proto';
1143
1158
  /** JSONP */
1144
1159
  callback?: string;
1145
1160
  /** Selector specifying which fields to include in a partial response. */
@@ -1165,11 +1180,11 @@ declare namespace gapi.client {
1165
1180
  testIamPermissions(
1166
1181
  request: {
1167
1182
  /** V1 error format. */
1168
- '$.xgafv'?: string;
1183
+ '$.xgafv'?: '1' | '2';
1169
1184
  /** OAuth access token. */
1170
1185
  access_token?: string;
1171
1186
  /** Data format for response. */
1172
- alt?: string;
1187
+ alt?: 'json' | 'media' | 'proto';
1173
1188
  /** JSONP */
1174
1189
  callback?: string;
1175
1190
  /** Selector specifying which fields to include in a partial response. */
@@ -1196,11 +1211,11 @@ declare namespace gapi.client {
1196
1211
  /** Creates a new workstation configuration. */
1197
1212
  create(request: {
1198
1213
  /** V1 error format. */
1199
- '$.xgafv'?: string;
1214
+ '$.xgafv'?: '1' | '2';
1200
1215
  /** OAuth access token. */
1201
1216
  access_token?: string;
1202
1217
  /** Data format for response. */
1203
- alt?: string;
1218
+ alt?: 'json' | 'media' | 'proto';
1204
1219
  /** JSONP */
1205
1220
  callback?: string;
1206
1221
  /** Selector specifying which fields to include in a partial response. */
@@ -1219,7 +1234,7 @@ declare namespace gapi.client {
1219
1234
  upload_protocol?: string;
1220
1235
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1221
1236
  uploadType?: string;
1222
- /** 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. */
1223
1238
  validateOnly?: boolean;
1224
1239
  /** Required. ID to use for the workstation configuration. */
1225
1240
  workstationConfigId?: string;
@@ -1229,11 +1244,11 @@ declare namespace gapi.client {
1229
1244
  create(
1230
1245
  request: {
1231
1246
  /** V1 error format. */
1232
- '$.xgafv'?: string;
1247
+ '$.xgafv'?: '1' | '2';
1233
1248
  /** OAuth access token. */
1234
1249
  access_token?: string;
1235
1250
  /** Data format for response. */
1236
- alt?: string;
1251
+ alt?: 'json' | 'media' | 'proto';
1237
1252
  /** JSONP */
1238
1253
  callback?: string;
1239
1254
  /** Selector specifying which fields to include in a partial response. */
@@ -1252,7 +1267,7 @@ declare namespace gapi.client {
1252
1267
  upload_protocol?: string;
1253
1268
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1254
1269
  uploadType?: string;
1255
- /** 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. */
1256
1271
  validateOnly?: boolean;
1257
1272
  /** Required. ID to use for the workstation configuration. */
1258
1273
  workstationConfigId?: string;
@@ -1262,11 +1277,11 @@ declare namespace gapi.client {
1262
1277
  /** Deletes the specified workstation configuration. */
1263
1278
  delete(request?: {
1264
1279
  /** V1 error format. */
1265
- '$.xgafv'?: string;
1280
+ '$.xgafv'?: '1' | '2';
1266
1281
  /** OAuth access token. */
1267
1282
  access_token?: string;
1268
1283
  /** Data format for response. */
1269
- alt?: string;
1284
+ alt?: 'json' | 'media' | 'proto';
1270
1285
  /** JSONP */
1271
1286
  callback?: string;
1272
1287
  /** Optional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag. */
@@ -1289,17 +1304,17 @@ declare namespace gapi.client {
1289
1304
  upload_protocol?: string;
1290
1305
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1291
1306
  uploadType?: string;
1292
- /** 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. */
1293
1308
  validateOnly?: boolean;
1294
1309
  }): Request<Operation>;
1295
1310
  /** Returns the requested workstation configuration. */
1296
1311
  get(request?: {
1297
1312
  /** V1 error format. */
1298
- '$.xgafv'?: string;
1313
+ '$.xgafv'?: '1' | '2';
1299
1314
  /** OAuth access token. */
1300
1315
  access_token?: string;
1301
1316
  /** Data format for response. */
1302
- alt?: string;
1317
+ alt?: 'json' | 'media' | 'proto';
1303
1318
  /** JSONP */
1304
1319
  callback?: string;
1305
1320
  /** Selector specifying which fields to include in a partial response. */
@@ -1322,11 +1337,11 @@ declare namespace gapi.client {
1322
1337
  /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
1323
1338
  getIamPolicy(request?: {
1324
1339
  /** V1 error format. */
1325
- '$.xgafv'?: string;
1340
+ '$.xgafv'?: '1' | '2';
1326
1341
  /** OAuth access token. */
1327
1342
  access_token?: string;
1328
1343
  /** Data format for response. */
1329
- alt?: string;
1344
+ alt?: 'json' | 'media' | 'proto';
1330
1345
  /** JSONP */
1331
1346
  callback?: string;
1332
1347
  /** Selector specifying which fields to include in a partial response. */
@@ -1351,11 +1366,11 @@ declare namespace gapi.client {
1351
1366
  /** Returns all workstation configurations in the specified cluster. */
1352
1367
  list(request?: {
1353
1368
  /** V1 error format. */
1354
- '$.xgafv'?: string;
1369
+ '$.xgafv'?: '1' | '2';
1355
1370
  /** OAuth access token. */
1356
1371
  access_token?: string;
1357
1372
  /** Data format for response. */
1358
- alt?: string;
1373
+ alt?: 'json' | 'media' | 'proto';
1359
1374
  /** JSONP */
1360
1375
  callback?: string;
1361
1376
  /** Selector specifying which fields to include in a partial response. */
@@ -1384,11 +1399,11 @@ declare namespace gapi.client {
1384
1399
  /** Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission. */
1385
1400
  listUsable(request?: {
1386
1401
  /** V1 error format. */
1387
- '$.xgafv'?: string;
1402
+ '$.xgafv'?: '1' | '2';
1388
1403
  /** OAuth access token. */
1389
1404
  access_token?: string;
1390
1405
  /** Data format for response. */
1391
- alt?: string;
1406
+ alt?: 'json' | 'media' | 'proto';
1392
1407
  /** JSONP */
1393
1408
  callback?: string;
1394
1409
  /** Selector specifying which fields to include in a partial response. */
@@ -1415,13 +1430,13 @@ declare namespace gapi.client {
1415
1430
  /** Updates an existing workstation configuration. */
1416
1431
  patch(request: {
1417
1432
  /** V1 error format. */
1418
- '$.xgafv'?: string;
1433
+ '$.xgafv'?: '1' | '2';
1419
1434
  /** OAuth access token. */
1420
1435
  access_token?: string;
1421
1436
  /** Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
1422
1437
  allowMissing?: boolean;
1423
1438
  /** Data format for response. */
1424
- alt?: string;
1439
+ alt?: 'json' | 'media' | 'proto';
1425
1440
  /** JSONP */
1426
1441
  callback?: string;
1427
1442
  /** Selector specifying which fields to include in a partial response. */
@@ -1442,7 +1457,7 @@ declare namespace gapi.client {
1442
1457
  upload_protocol?: string;
1443
1458
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1444
1459
  uploadType?: string;
1445
- /** 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. */
1446
1461
  validateOnly?: boolean;
1447
1462
  /** Request body */
1448
1463
  resource: WorkstationConfig;
@@ -1450,13 +1465,13 @@ declare namespace gapi.client {
1450
1465
  patch(
1451
1466
  request: {
1452
1467
  /** V1 error format. */
1453
- '$.xgafv'?: string;
1468
+ '$.xgafv'?: '1' | '2';
1454
1469
  /** OAuth access token. */
1455
1470
  access_token?: string;
1456
1471
  /** Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
1457
1472
  allowMissing?: boolean;
1458
1473
  /** Data format for response. */
1459
- alt?: string;
1474
+ alt?: 'json' | 'media' | 'proto';
1460
1475
  /** JSONP */
1461
1476
  callback?: string;
1462
1477
  /** Selector specifying which fields to include in a partial response. */
@@ -1477,7 +1492,7 @@ declare namespace gapi.client {
1477
1492
  upload_protocol?: string;
1478
1493
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1479
1494
  uploadType?: string;
1480
- /** 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. */
1481
1496
  validateOnly?: boolean;
1482
1497
  },
1483
1498
  body: WorkstationConfig,
@@ -1486,11 +1501,11 @@ declare namespace gapi.client {
1486
1501
  setIamPolicy(
1487
1502
  request: {
1488
1503
  /** V1 error format. */
1489
- '$.xgafv'?: string;
1504
+ '$.xgafv'?: '1' | '2';
1490
1505
  /** OAuth access token. */
1491
1506
  access_token?: string;
1492
1507
  /** Data format for response. */
1493
- alt?: string;
1508
+ alt?: 'json' | 'media' | 'proto';
1494
1509
  /** JSONP */
1495
1510
  callback?: string;
1496
1511
  /** Selector specifying which fields to include in a partial response. */
@@ -1516,11 +1531,11 @@ declare namespace gapi.client {
1516
1531
  testIamPermissions(
1517
1532
  request: {
1518
1533
  /** V1 error format. */
1519
- '$.xgafv'?: string;
1534
+ '$.xgafv'?: '1' | '2';
1520
1535
  /** OAuth access token. */
1521
1536
  access_token?: string;
1522
1537
  /** Data format for response. */
1523
- alt?: string;
1538
+ alt?: 'json' | 'media' | 'proto';
1524
1539
  /** JSONP */
1525
1540
  callback?: string;
1526
1541
  /** Selector specifying which fields to include in a partial response. */
@@ -1548,11 +1563,11 @@ declare namespace gapi.client {
1548
1563
  /** Creates a new workstation cluster. */
1549
1564
  create(request: {
1550
1565
  /** V1 error format. */
1551
- '$.xgafv'?: string;
1566
+ '$.xgafv'?: '1' | '2';
1552
1567
  /** OAuth access token. */
1553
1568
  access_token?: string;
1554
1569
  /** Data format for response. */
1555
- alt?: string;
1570
+ alt?: 'json' | 'media' | 'proto';
1556
1571
  /** JSONP */
1557
1572
  callback?: string;
1558
1573
  /** Selector specifying which fields to include in a partial response. */
@@ -1571,7 +1586,7 @@ declare namespace gapi.client {
1571
1586
  upload_protocol?: string;
1572
1587
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1573
1588
  uploadType?: string;
1574
- /** 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. */
1575
1590
  validateOnly?: boolean;
1576
1591
  /** Required. ID to use for the workstation cluster. */
1577
1592
  workstationClusterId?: string;
@@ -1581,11 +1596,11 @@ declare namespace gapi.client {
1581
1596
  create(
1582
1597
  request: {
1583
1598
  /** V1 error format. */
1584
- '$.xgafv'?: string;
1599
+ '$.xgafv'?: '1' | '2';
1585
1600
  /** OAuth access token. */
1586
1601
  access_token?: string;
1587
1602
  /** Data format for response. */
1588
- alt?: string;
1603
+ alt?: 'json' | 'media' | 'proto';
1589
1604
  /** JSONP */
1590
1605
  callback?: string;
1591
1606
  /** Selector specifying which fields to include in a partial response. */
@@ -1604,7 +1619,7 @@ declare namespace gapi.client {
1604
1619
  upload_protocol?: string;
1605
1620
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1606
1621
  uploadType?: string;
1607
- /** 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. */
1608
1623
  validateOnly?: boolean;
1609
1624
  /** Required. ID to use for the workstation cluster. */
1610
1625
  workstationClusterId?: string;
@@ -1614,11 +1629,11 @@ declare namespace gapi.client {
1614
1629
  /** Deletes the specified workstation cluster. */
1615
1630
  delete(request?: {
1616
1631
  /** V1 error format. */
1617
- '$.xgafv'?: string;
1632
+ '$.xgafv'?: '1' | '2';
1618
1633
  /** OAuth access token. */
1619
1634
  access_token?: string;
1620
1635
  /** Data format for response. */
1621
- alt?: string;
1636
+ alt?: 'json' | 'media' | 'proto';
1622
1637
  /** JSONP */
1623
1638
  callback?: string;
1624
1639
  /** Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. */
@@ -1641,17 +1656,17 @@ declare namespace gapi.client {
1641
1656
  upload_protocol?: string;
1642
1657
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1643
1658
  uploadType?: string;
1644
- /** 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. */
1645
1660
  validateOnly?: boolean;
1646
1661
  }): Request<Operation>;
1647
1662
  /** Returns the requested workstation cluster. */
1648
1663
  get(request?: {
1649
1664
  /** V1 error format. */
1650
- '$.xgafv'?: string;
1665
+ '$.xgafv'?: '1' | '2';
1651
1666
  /** OAuth access token. */
1652
1667
  access_token?: string;
1653
1668
  /** Data format for response. */
1654
- alt?: string;
1669
+ alt?: 'json' | 'media' | 'proto';
1655
1670
  /** JSONP */
1656
1671
  callback?: string;
1657
1672
  /** Selector specifying which fields to include in a partial response. */
@@ -1674,11 +1689,11 @@ declare namespace gapi.client {
1674
1689
  /** Returns all workstation clusters in the specified location. */
1675
1690
  list(request?: {
1676
1691
  /** V1 error format. */
1677
- '$.xgafv'?: string;
1692
+ '$.xgafv'?: '1' | '2';
1678
1693
  /** OAuth access token. */
1679
1694
  access_token?: string;
1680
1695
  /** Data format for response. */
1681
- alt?: string;
1696
+ alt?: 'json' | 'media' | 'proto';
1682
1697
  /** JSONP */
1683
1698
  callback?: string;
1684
1699
  /** Selector specifying which fields to include in a partial response. */
@@ -1707,13 +1722,13 @@ declare namespace gapi.client {
1707
1722
  /** Updates an existing workstation cluster. */
1708
1723
  patch(request: {
1709
1724
  /** V1 error format. */
1710
- '$.xgafv'?: string;
1725
+ '$.xgafv'?: '1' | '2';
1711
1726
  /** OAuth access token. */
1712
1727
  access_token?: string;
1713
1728
  /** Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored. */
1714
1729
  allowMissing?: boolean;
1715
1730
  /** Data format for response. */
1716
- alt?: string;
1731
+ alt?: 'json' | 'media' | 'proto';
1717
1732
  /** JSONP */
1718
1733
  callback?: string;
1719
1734
  /** Selector specifying which fields to include in a partial response. */
@@ -1734,7 +1749,7 @@ declare namespace gapi.client {
1734
1749
  upload_protocol?: string;
1735
1750
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1736
1751
  uploadType?: string;
1737
- /** 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. */
1738
1753
  validateOnly?: boolean;
1739
1754
  /** Request body */
1740
1755
  resource: WorkstationCluster;
@@ -1742,13 +1757,13 @@ declare namespace gapi.client {
1742
1757
  patch(
1743
1758
  request: {
1744
1759
  /** V1 error format. */
1745
- '$.xgafv'?: string;
1760
+ '$.xgafv'?: '1' | '2';
1746
1761
  /** OAuth access token. */
1747
1762
  access_token?: string;
1748
1763
  /** Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored. */
1749
1764
  allowMissing?: boolean;
1750
1765
  /** Data format for response. */
1751
- alt?: string;
1766
+ alt?: 'json' | 'media' | 'proto';
1752
1767
  /** JSONP */
1753
1768
  callback?: string;
1754
1769
  /** Selector specifying which fields to include in a partial response. */
@@ -1769,7 +1784,7 @@ declare namespace gapi.client {
1769
1784
  upload_protocol?: string;
1770
1785
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1771
1786
  uploadType?: string;
1772
- /** 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. */
1773
1788
  validateOnly?: boolean;
1774
1789
  },
1775
1790
  body: WorkstationCluster,
@@ -1780,11 +1795,11 @@ declare namespace gapi.client {
1780
1795
  /** Gets information about a location. */
1781
1796
  get(request?: {
1782
1797
  /** V1 error format. */
1783
- '$.xgafv'?: string;
1798
+ '$.xgafv'?: '1' | '2';
1784
1799
  /** OAuth access token. */
1785
1800
  access_token?: string;
1786
1801
  /** Data format for response. */
1787
- alt?: string;
1802
+ alt?: 'json' | 'media' | 'proto';
1788
1803
  /** JSONP */
1789
1804
  callback?: string;
1790
1805
  /** Selector specifying which fields to include in a partial response. */
@@ -1804,17 +1819,17 @@ declare namespace gapi.client {
1804
1819
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1805
1820
  uploadType?: string;
1806
1821
  }): Request<Location>;
1807
- /** 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. */
1808
1823
  list(request?: {
1809
1824
  /** V1 error format. */
1810
- '$.xgafv'?: string;
1825
+ '$.xgafv'?: '1' | '2';
1811
1826
  /** OAuth access token. */
1812
1827
  access_token?: string;
1813
1828
  /** Data format for response. */
1814
- alt?: string;
1829
+ alt?: 'json' | 'media' | 'proto';
1815
1830
  /** JSONP */
1816
1831
  callback?: string;
1817
- /** 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. */
1818
1833
  extraLocationTypes?: string | string[];
1819
1834
  /** Selector specifying which fields to include in a partial response. */
1820
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.1.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: