@maxim_mazurok/gapi.client.workstations-v1beta 0.0.20240709 → 0.0.20240723

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 (2) hide show
  1. package/index.d.ts +16 -10
  2. package/package.json +1 -1
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=v1beta
12
- // Revision: 20240709
12
+ // Revision: 20240723
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -59,7 +59,7 @@ declare namespace gapi.client {
59
59
  accelerators?: Accelerator[];
60
60
  /** Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. */
61
61
  bootDiskSizeGb?: number;
62
- /** Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. */
62
+ /** Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. */
63
63
  enableNestedVirtualization?: boolean;
64
64
  /** Optional. Required. The id to be used for the boost config. */
65
65
  id?: string;
@@ -126,7 +126,7 @@ declare namespace gapi.client {
126
126
  disablePublicIpAddresses?: boolean;
127
127
  /** Optional. Whether to disable SSH access to the VM. */
128
128
  disableSsh?: boolean;
129
- /** Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. */
129
+ /** Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. */
130
130
  enableNestedVirtualization?: boolean;
131
131
  /** Optional. 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). */
132
132
  machineType?: string;
@@ -142,7 +142,7 @@ declare namespace gapi.client {
142
142
  shieldedInstanceConfig?: GceShieldedInstanceConfig;
143
143
  /** Optional. Network tags to add to the Compute Engine VMs 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). */
144
144
  tags?: string[];
145
- /** Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as https://cloud.google.com/resource-manager/docs/tags/tags-overview Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. */
145
+ /** Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. */
146
146
  vmTags?: {[P in string]: string};
147
147
  }
148
148
  interface GcePersistentDisk {
@@ -289,9 +289,9 @@ declare namespace gapi.client {
289
289
  version?: number;
290
290
  }
291
291
  interface PortRange {
292
- /** Required. Starting port number for the current range of ports. */
292
+ /** Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. */
293
293
  first?: number;
294
- /** Required. Ending port number for the current range of ports. */
294
+ /** Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. */
295
295
  last?: number;
296
296
  }
297
297
  interface PrivateClusterConfig {
@@ -349,6 +349,8 @@ declare namespace gapi.client {
349
349
  interface Workstation {
350
350
  /** Optional. Client-specified annotations. */
351
351
  annotations?: {[P in string]: string};
352
+ /** Output only. List of available boost configuration ids that this workstation can be boosted up to */
353
+ boostConfigs?: WorkstationBoostConfig[];
352
354
  /** Output only. Time when this workstation was created. */
353
355
  createTime?: string;
354
356
  /** Output only. Time when this workstation was soft-deleted. */
@@ -373,7 +375,7 @@ declare namespace gapi.client {
373
375
  satisfiesPzi?: boolean;
374
376
  /** Output only. Reserved for future use. */
375
377
  satisfiesPzs?: boolean;
376
- /** Optional. The source workstation from which this workstations persistent directories were cloned on creation. */
378
+ /** Optional. The source workstation from which this workstation's persistent directories were cloned on creation. */
377
379
  sourceWorkstation?: string;
378
380
  /** Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. */
379
381
  startTime?: string;
@@ -384,6 +386,10 @@ declare namespace gapi.client {
384
386
  /** Output only. Time when this workstation was most recently updated. */
385
387
  updateTime?: string;
386
388
  }
389
+ interface WorkstationBoostConfig {
390
+ /** Output only. Boost config id. */
391
+ id?: string;
392
+ }
387
393
  interface WorkstationCluster {
388
394
  /** Optional. Client-specified annotations. */
389
395
  annotations?: {[P in string]: string};
@@ -425,7 +431,7 @@ declare namespace gapi.client {
425
431
  updateTime?: string;
426
432
  }
427
433
  interface WorkstationConfig {
428
- /** Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. */
434
+ /** 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. */
429
435
  allowedPorts?: PortRange[];
430
436
  /** Optional. Client-specified annotations. */
431
437
  annotations?: {[P in string]: string};
@@ -443,7 +449,7 @@ declare namespace gapi.client {
443
449
  disableTcpConnections?: boolean;
444
450
  /** Optional. Human-readable name for this workstation configuration. */
445
451
  displayName?: string;
446
- /** Optional. 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). */
452
+ /** Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" */
447
453
  enableAuditAgent?: boolean;
448
454
  /** 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 might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. */
449
455
  encryptionKey?: CustomerEncryptionKey;
@@ -453,7 +459,7 @@ declare namespace gapi.client {
453
459
  etag?: string;
454
460
  /** Optional. Runtime host for the workstation. */
455
461
  host?: Host;
456
- /** Optional. Http options that customize the behavior of the workstation service's http proxy. */
462
+ /** Optional. HTTP options that customize the behavior of the workstation service's HTTP proxy. */
457
463
  httpOptions?: HttpOptions;
458
464
  /** Optional. 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). */
459
465
  idleTimeout?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workstations-v1beta",
3
- "version": "0.0.20240709",
3
+ "version": "0.0.20240723",
4
4
  "description": "TypeScript typings for Cloud Workstations API v1beta",
5
5
  "repository": {
6
6
  "type": "git",