@maxim_mazurok/gapi.client.workstations-v1beta 0.0.20230405 → 0.0.20230423

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://workstations.googleapis.com/$discovery/rest?version=v1beta
-// Revision: 20230405
+// Revision: 20230423
 
 /// <reference types="gapi.client" />
 
@@ -72,9 +72,9 @@ declare namespace gapi.client {
             args?: string[];
             /** If set, overrides the default ENTRYPOINT specified by the image. */
             command?: string[];
-            /** Environment variables passed to the container. */
+            /** Environment variables passed to the container's entrypoint. */
             env?: { [P in string]: string };
-            /** Docker image defining the container. This image must be accessible by the config's service account. */
+            /** Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. */
             image?: string;
             /** If set, overrides the USER specified in the image with the given uid. */
             runAsUser?: number;
@@ -114,11 +114,13 @@ declare namespace gapi.client {
             disablePublicIpAddresses?: boolean;
             /** The name of a Compute Engine machine type. */
             machineType?: string;
-            /** Number of instances to pool for faster workstation starup. */
+            /** Output only. Number of instances currently available in the pool for faster workstation startup. */
+            pooledInstances?: number;
+            /** Number of instances to pool for faster workstation startup. */
             poolSize?: number;
             /**
-             * Email address of the service account that will be used on VM instances used to support this config. If not set, VMs will run with a Google-managed service account. This service
-             * account must have permission to pull the specified container image, otherwise the image must be publicly accessible.
+             * Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must
+             * have permission to pull the specified container image; otherwise, the image must be publicly accessible.
              */
             serviceAccount?: string;
             /** A set of Compute Engine Shielded instance options. */
@@ -157,7 +159,7 @@ declare namespace gapi.client {
         }
         interface GenerateAccessTokenResponse {
             /**
-             * The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname, for example,
+             * The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example,
              * `Authorization: Bearer `.
              */
             accessToken?: string;
@@ -308,6 +310,12 @@ declare namespace gapi.client {
              */
             serviceAttachmentUri?: string;
         }
+        interface ReadinessCheck {
+            /** Path to which the request should be sent. */
+            path?: string;
+            /** Port to which the request should be sent. */
+            port?: number;
+        }
         interface SetIamPolicyRequest {
             /**
              * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
@@ -321,7 +329,7 @@ declare namespace gapi.client {
             updateMask?: string;
         }
         interface StartWorkstationRequest {
-            /** If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. */
+            /** If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
             etag?: string;
             /** If set, validate the request and preview the review, but do not actually apply it. */
             validateOnly?: boolean;
@@ -338,7 +346,7 @@ declare namespace gapi.client {
             message?: string;
         }
         interface StopWorkstationRequest {
-            /** If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. */
+            /** If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
             etag?: string;
             /** If set, validate the request and preview the review, but do not actually apply it. */
             validateOnly?: boolean;
@@ -363,9 +371,9 @@ declare namespace gapi.client {
             deleteTime?: string;
             /** Human-readable name for this resource. */
             displayName?: string;
-            /** Environment variables passed to the workstation container. */
+            /** Environment variables passed to the workstation container's entrypoint. */
             env?: { [P in string]: string };
-            /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
+            /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
             etag?: string;
             /**
              * Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To
@@ -391,8 +399,8 @@ declare namespace gapi.client {
             /** Output only. Status conditions describing the current resource state. */
             conditions?: Status[];
             /**
-             * Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall
-             * rules allow egress from the Workstation VMs to this address.
+             * Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall
+             * rules allow egress from the workstation VMs to this address.
              */
             controlPlaneIp?: string;
             /** Output only. Time when this resource was created. */
@@ -403,7 +411,7 @@ declare namespace gapi.client {
             deleteTime?: string;
             /** Human-readable name for this resource. */
             displayName?: string;
-            /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
+            /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
             etag?: string;
             /** Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. */
             labels?: { [P in string]: string };
@@ -447,10 +455,10 @@ declare namespace gapi.client {
              * persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect
              * disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version
              * of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked,
-             * the workstation session will automatically be stopped within 7 hours. Immutable after workstation config is created.
+             * the workstation session will automatically be stopped within 7 hours. Immutable after the workstation configuration is created.
              */
             encryptionKey?: CustomerEncryptionKey;
-            /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
+            /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
             etag?: string;
             /** Runtime host for the workstation. */
             host?: Host;
@@ -465,6 +473,11 @@ declare namespace gapi.client {
             name?: string;
             /** Directories to persist across workstation sessions. */
             persistentDirectories?: PersistentDirectory[];
+            /**
+             * Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200
+             * status codes.
+             */
+            readinessChecks?: ReadinessCheck[];
             /** Output only. Indicates whether this resource is currently being updated to match its intended state. */
             reconciling?: boolean;
             /**
@@ -705,7 +718,7 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. */
+                /** If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. */
                 etag?: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
@@ -847,7 +860,7 @@ declare namespace gapi.client {
                 /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                 uploadType?: string;
             }): Request<Policy>;
-            /** Returns all Workstations using the specified config. */
+            /** Returns all Workstations using the specified workstation configuration. */
             list(request?: {
                 /** V1 error format. */
                 "$.xgafv"?: string;
@@ -878,7 +891,7 @@ declare namespace gapi.client {
                 /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                 uploadType?: string;
             }): Request<ListWorkstationsResponse>;
-            /** Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission. */
+            /** Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. */
             listUsable(request?: {
                 /** V1 error format. */
                 "$.xgafv"?: string;
@@ -915,7 +928,7 @@ declare namespace gapi.client {
                 "$.xgafv"?: string;
                 /** OAuth access token. */
                 access_token?: string;
-                /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
+                /** If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
                 allowMissing?: boolean;
                 /** Data format for response. */
                 alt?: string;
@@ -933,7 +946,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** 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. */
                 quotaUser?: string;
-                /** Required. Mask specifying which fields in the config should be updated. */
+                /** Required. Mask specifying which fields in the workstation configuration should be updated. */
                 updateMask?: string;
                 /** Upload protocol for media (e.g. "raw", "multipart"). */
                 upload_protocol?: string;
@@ -949,7 +962,7 @@ declare namespace gapi.client {
                 "$.xgafv"?: string;
                 /** OAuth access token. */
                 access_token?: string;
-                /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
+                /** If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
                 allowMissing?: boolean;
                 /** Data format for response. */
                 alt?: string;
@@ -967,7 +980,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** 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. */
                 quotaUser?: string;
-                /** Required. Mask specifying which fields in the config should be updated. */
+                /** Required. Mask specifying which fields in the workstation configuration should be updated. */
                 updateMask?: string;
                 /** Upload protocol for media (e.g. "raw", "multipart"). */
                 upload_protocol?: string;
@@ -1184,7 +1197,7 @@ declare namespace gapi.client {
                 uploadType?: string;
                 /** If set, validate the request and preview the review, but do not actually apply it. */
                 validateOnly?: boolean;
-                /** Required. ID to use for the config. */
+                /** Required. ID to use for the workstation configuration. */
                 workstationConfigId?: string;
                 /** Request body */
                 resource: WorkstationConfig;
@@ -1216,7 +1229,7 @@ declare namespace gapi.client {
                 uploadType?: string;
                 /** If set, validate the request and preview the review, but do not actually apply it. */
                 validateOnly?: boolean;
-                /** Required. ID to use for the config. */
+                /** Required. ID to use for the workstation configuration. */
                 workstationConfigId?: string;
             },
             body: WorkstationConfig): Request<Operation>;
@@ -1230,15 +1243,15 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** If set, the request will be rejected if the latest version of the config on the server does not have this etag. */
+                /** If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag. */
                 etag?: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;
-                /** If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations. */
+                /** If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations. */
                 force?: boolean;
                 /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                 key?: string;
-                /** Required. Name of the config to delete. */
+                /** Required. Name of the workstation configuration to delete. */
                 name: string;
                 /** OAuth 2.0 token for the current user. */
                 oauth_token?: string;
@@ -1386,7 +1399,7 @@ declare namespace gapi.client {
                 "$.xgafv"?: string;
                 /** OAuth access token. */
                 access_token?: string;
-                /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
+                /** If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
                 allowMissing?: boolean;
                 /** Data format for response. */
                 alt?: string;
@@ -1404,7 +1417,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** 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. */
                 quotaUser?: string;
-                /** Required. Mask specifying which fields in the config should be updated. */
+                /** Required. Mask specifying which fields in the workstation configuration should be updated. */
                 updateMask?: string;
                 /** Upload protocol for media (e.g. "raw", "multipart"). */
                 upload_protocol?: string;
@@ -1420,7 +1433,7 @@ declare namespace gapi.client {
                 "$.xgafv"?: string;
                 /** OAuth access token. */
                 access_token?: string;
-                /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
+                /** If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
                 allowMissing?: boolean;
                 /** Data format for response. */
                 alt?: string;
@@ -1438,7 +1451,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** 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. */
                 quotaUser?: string;
-                /** Required. Mask specifying which fields in the config should be updated. */
+                /** Required. Mask specifying which fields in the workstation configuration should be updated. */
                 updateMask?: string;
                 /** Upload protocol for media (e.g. "raw", "multipart"). */
                 upload_protocol?: string;
@@ -1590,7 +1603,7 @@ declare namespace gapi.client {
                 alt?: string;
                 /** JSONP */
                 callback?: string;
-                /** If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this etag. */
+                /** If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. */
                 etag?: string;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.workstations-v1beta",
-  "version": "0.0.20230405",
+  "version": "0.0.20230423",
   "description": "TypeScript typings for Cloud Workstations API v1beta",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230405
+// Revision: 20230423
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -215,6 +215,7 @@ gapi.load('client', async () => {
                     },
                     disablePublicIpAddresses: true,
                     machineType: "Test string",
+                    pooledInstances: 42,
                     poolSize: 42,
                     serviceAccount: "Test string",
                     shieldedInstanceConfig: {
@@ -244,6 +245,12 @@ gapi.load('client', async () => {
                     mountPath: "Test string",
                 }
             ],
+            readinessChecks: [
+                {
+                    path: "Test string",
+                    port: 42,
+                }
+            ],
             reconciling: true,
             runningTimeout: "Test string",
             uid: "Test string",
@@ -330,6 +337,7 @@ gapi.load('client', async () => {
                     },
                     disablePublicIpAddresses: true,
                     machineType: "Test string",
+                    pooledInstances: 42,
                     poolSize: 42,
                     serviceAccount: "Test string",
                     shieldedInstanceConfig: {
@@ -359,6 +367,12 @@ gapi.load('client', async () => {
                     mountPath: "Test string",
                 }
             ],
+            readinessChecks: [
+                {
+                    path: "Test string",
+                    port: 42,
+                }
+            ],
             reconciling: true,
             runningTimeout: "Test string",
             uid: "Test string",
@@ -460,13 +474,13 @@ gapi.load('client', async () => {
             "options.requestedPolicyVersion": 42,
             resource: "Test string",
         });
-        /** Returns all Workstations using the specified config. */
+        /** Returns all Workstations using the specified workstation configuration. */
         await gapi.client.workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list({
             pageSize: 42,
             pageToken: "Test string",
             parent: "Test string",
         });
-        /** Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission. */
+        /** Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. */
         await gapi.client.workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable({
             pageSize: 42,
             pageToken: "Test string",