@maxim_mazurok/gapi.client.workstations-v1beta 0.0.20230517 → 0.0.20230607

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: 20230517
+// Revision: 20230607
 
 /// <reference types="gapi.client" />
 
@@ -92,7 +92,12 @@ declare namespace gapi.client {
             /** 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 service account specified in the workstation configuration. */
+            /**
+             * A Docker container image that defines a custom environment. Cloud Workstations provides a number of [preconfigured
+             * images](https://cloud.google.com/workstations/docs/preconfigured-base-images), but you can create your own [custom container
+             * images](https://cloud.google.com/workstations/docs/custom-container-images). If using a private image, the `host.gceInstance.serviceAccount` field must be specified in the
+             * workstation configuration and must have permission to pull the specified image. Otherwise, the image must be publicly accessible.s
+             */
             image?:
                 string;
             /** If set, overrides the USER specified in the image with the given uid. */
@@ -140,48 +145,64 @@ declare namespace gapi.client {
             /** A list of the type and count of accelerator cards attached to the instance. */
             accelerators?:
                 Accelerator[];
-            /** Size of the boot disk in GB. Defaults to 50. */
+            /** The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. */
             bootDiskSizeGb?:
                 number;
             /** A set of Compute Engine Confidential VM instance options. */
             confidentialInstanceConfig?:
                 GceConfidentialInstanceConfig;
-            /** Whether instances have no public IP address. */
+            /**
+             * When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private
+             * Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains
+             * `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
+             */
             disablePublicIpAddresses?:
                 boolean;
-            /** The name of a Compute Engine machine type. */
+            /**
+             * The type of machine to use for VM instances—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available
+             * machine types](https://cloud.google.com/workstations/docs/available-machine-types).
+             */
             machineType?:
                 string;
             /** 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. */
+            /** The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. */
             poolSize?:
                 number;
             /**
-             * 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.
+             * The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has `logginglogEntries.create`
+             * permission on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have permissions to pull the specified image. If you
+             * as the administrator want to be able to `ssh` into the underlying VM, you need to set this value to a service account for which you have the `iam.serviceAccounts.actAs` permission.
+             * Conversely, if you don't want anyone to be able to `ssh` into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account
+             * provided by the Cloud Workstations service, and the image must be publicly accessible.
              */
             serviceAccount?:
                 string;
             /** A set of Compute Engine Shielded instance options. */
             shieldedInstanceConfig?:
                 GceShieldedInstanceConfig;
-            /** Network tags to add to the Compute Engine machines backing the Workstations. */
+            /**
+             * Network tags to add to the Compute Engine machines backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs
+             * created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
+             */
             tags?:
                 string[];
         }
         interface GceRegionalPersistentDisk {
-            /** Type of the disk to use. Defaults to pd-standard. */
+            /** The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `pd-standard`. */
             diskType?:
                 string;
-            /** 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. */
+            /** 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`. */
             fsType?:
                 string;
-            /** What should happen to the disk after the workstation is deleted. Defaults to DELETE. */
+            /** Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. */
             reclaimPolicy?:
                 string;
-            /** Size of the disk in GB. Must be empty if source_snapshot is set. Defaults to 200. */
+            /**
+             * 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 `diskType` must be `pd-balanced` or `pd-ssd`.
+             */
             sizeGb?:
                 number;
             /** Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. */
@@ -507,7 +528,7 @@ declare namespace gapi.client {
             /** Output only. Current state of the workstation. */
             state?:
                 string;
-            /** Output only. A system-assigned unique identified for this resource. */
+            /** Output only. A system-assigned unique identifier for this resource. */
             uid?:
                 string;
             /** Output only. Time when this resource was most recently updated. */
@@ -560,7 +581,7 @@ declare namespace gapi.client {
             /** Immutable. Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster. */
             subnetwork?:
                 string;
-            /** Output only. A system-assigned unique identified for this resource. */
+            /** Output only. A system-assigned unique identifier for this resource. */
             uid?:
                 string;
             /** Output only. Time when this resource was most recently updated. */
@@ -574,7 +595,7 @@ declare namespace gapi.client {
             /** Output only. Status conditions describing the current resource state. */
             conditions?:
                 Status[];
-            /** Container that will be run for each workstation using this configuration when that workstation is started. */
+            /** Container that runs upon startup for each workstation using this workstation configuration. */
             container?:
                 Container;
             /** Output only. Time when this resource was created. */
@@ -590,17 +611,17 @@ declare namespace gapi.client {
             displayName?:
                 string;
             /**
-             * Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating
-             * system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).
+             * Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project.
+             * Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).
              */
             enableAuditAgent?:
                 boolean;
             /**
-             * Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the
+             * Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the
              * 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 the workstation configuration is created.
+             * of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked,
+             * the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
              */
             encryptionKey?:
                 CustomerEncryptionKey;
@@ -611,8 +632,9 @@ declare namespace gapi.client {
             host?:
                 Host;
             /**
-             * How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness.
-             * Defaults to 20 minutes.
+             * Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `0s` indicates that Cloud Workstations VMs created with this
+             * configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for
+             * seconds—for example, `7200s` (2 hours). The default is `1200s` (20 minutes).
              */
             idleTimeout?:
                 string;
@@ -635,12 +657,16 @@ declare namespace gapi.client {
             reconciling?:
                 boolean;
             /**
-             * How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be
-             * greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours.
+             * Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can
+             * be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified
+             * time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0`
+             * indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A
+             * value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not
+             * pick up security updates.
              */
             runningTimeout?:
                 string;
-            /** Output only. A system-assigned unique identified for this resource. */
+            /** Output only. A system-assigned unique identifier for this resource. */
             uid?:
                 string;
             /** Output only. Time when this resource was most recently updated. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.workstations-v1beta",
-  "version": "0.0.20230517",
+  "version": "0.0.20230607",
   "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: 20230517
+// Revision: 20230607
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */