google-apis-workstations_v1beta 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dd7c865b5c820ae410400cba85772982b30be7bfa872827291217668fb177a87
4
- data.tar.gz: 27495fbf3f42fb2e175dcd7b622e00e078fb919ec75ac38e47926e0cecabf0fc
3
+ metadata.gz: c41e9faf788b09f95c6ff17acef839257771dfb09e6a2d05b80b2af048a8ff31
4
+ data.tar.gz: 467affcf50fe7ec34c8499e4ac7941d30628a681a9fae1cd32c3d6db610372b9
5
5
  SHA512:
6
- metadata.gz: 57974a045731a687c678d8b891617718548d4c1954a88f218d261cacedcb914636c054f2011f192dcfe6205bcc801de1b73792848b9a73dc211da603da49f311
7
- data.tar.gz: dd7cf2ccaf25eb6246722f01a0f60a5955f5cd2e82e136e67eb05f00e6b92f876f336578fec9c698a7be08b42fce7da1076db7257846be5e2c866a58721c14dd
6
+ metadata.gz: 045fc2bbac97e9dcf08396d9d3f3ccc0f901fce93d5828608d3eb8548ecf4d48f677264999161323746ae4e94410c3a7ab76df36b5ac8804612500bc0d4009c3
7
+ data.tar.gz: e05e8d3a6c12b2040a6863ca344bcbba8776aa3a622693c60d074ada9dfc094aed28ce965d21cc2314ac40a43910302d9e2a798094066abfbbb8eeab331b0203
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-workstations_v1beta
2
2
 
3
+ ### v0.15.0 (2023-08-13)
4
+
5
+ * Regenerated from discovery document revision 20230802
6
+
3
7
  ### v0.14.0 (2023-06-25)
4
8
 
5
9
  * Regenerated from discovery document revision 20230619
@@ -26,13 +26,13 @@ module Google
26
26
  class Accelerator
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
- # Number of accelerator cards exposed to the instance.
29
+ # Optional. Number of accelerator cards exposed to the instance.
30
30
  # Corresponds to the JSON property `count`
31
31
  # @return [Fixnum]
32
32
  attr_accessor :count
33
33
 
34
- # Type of accelerator resource to attach to the instance, for example, "nvidia-
35
- # tesla-p100".
34
+ # Optional. Type of accelerator resource to attach to the instance, for example,
35
+ # `"nvidia-tesla-p100"`.
36
36
  # Corresponds to the JSON property `type`
37
37
  # @return [String]
38
38
  attr_accessor :type
@@ -212,24 +212,24 @@ module Google
212
212
  class Container
213
213
  include Google::Apis::Core::Hashable
214
214
 
215
- # Arguments passed to the entrypoint.
215
+ # Optional. Arguments passed to the entrypoint.
216
216
  # Corresponds to the JSON property `args`
217
217
  # @return [Array<String>]
218
218
  attr_accessor :args
219
219
 
220
- # If set, overrides the default ENTRYPOINT specified by the image.
220
+ # Optional. If set, overrides the default ENTRYPOINT specified by the image.
221
221
  # Corresponds to the JSON property `command`
222
222
  # @return [Array<String>]
223
223
  attr_accessor :command
224
224
 
225
- # Environment variables passed to the container's entrypoint.
225
+ # Optional. Environment variables passed to the container's entrypoint.
226
226
  # Corresponds to the JSON property `env`
227
227
  # @return [Hash<String,String>]
228
228
  attr_accessor :env
229
229
 
230
- # A Docker container image that defines a custom environment. Cloud Workstations
231
- # provides a number of [preconfigured images](https://cloud.google.com/
232
- # workstations/docs/preconfigured-base-images), but you can create your own [
230
+ # Optional. A Docker container image that defines a custom environment. Cloud
231
+ # Workstations provides a number of [preconfigured images](https://cloud.google.
232
+ # com/workstations/docs/preconfigured-base-images), but you can create your own [
233
233
  # custom container images](https://cloud.google.com/workstations/docs/custom-
234
234
  # container-images). If using a private image, the `host.gceInstance.
235
235
  # serviceAccount` field must be specified in the workstation configuration and
@@ -239,12 +239,12 @@ module Google
239
239
  # @return [String]
240
240
  attr_accessor :image
241
241
 
242
- # If set, overrides the USER specified in the image with the given uid.
242
+ # Optional. If set, overrides the USER specified in the image with the given uid.
243
243
  # Corresponds to the JSON property `runAsUser`
244
244
  # @return [Fixnum]
245
245
  attr_accessor :run_as_user
246
246
 
247
- # If set, overrides the default DIR specified by the image.
247
+ # Optional. If set, overrides the default DIR specified by the image.
248
248
  # Corresponds to the JSON property `workingDir`
249
249
  # @return [String]
250
250
  attr_accessor :working_dir
@@ -272,8 +272,8 @@ module Google
272
272
  class CustomerEncryptionKey
273
273
  include Google::Apis::Core::Hashable
274
274
 
275
- # Immutable. The name of the Google Cloud KMS encryption key. For example, `
276
- # projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`.
275
+ # Immutable. The name of the Google Cloud KMS encryption key. For example, `"
276
+ # projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`.
277
277
  # The key must be in the same region as the workstation configuration.
278
278
  # Corresponds to the JSON property `kmsKey`
279
279
  # @return [String]
@@ -358,7 +358,7 @@ module Google
358
358
  class GceConfidentialInstanceConfig
359
359
  include Google::Apis::Core::Hashable
360
360
 
361
- # Whether the instance has confidential compute enabled.
361
+ # Optional. Whether the instance has confidential compute enabled.
362
362
  # Corresponds to the JSON property `enableConfidentialCompute`
363
363
  # @return [Boolean]
364
364
  attr_accessor :enable_confidential_compute
@@ -378,13 +378,14 @@ module Google
378
378
  class GceInstance
379
379
  include Google::Apis::Core::Hashable
380
380
 
381
- # A list of the type and count of accelerator cards attached to the instance.
381
+ # Optional. A list of the type and count of accelerator cards attached to the
382
+ # instance.
382
383
  # Corresponds to the JSON property `accelerators`
383
384
  # @return [Array<Google::Apis::WorkstationsV1beta::Accelerator>]
384
385
  attr_accessor :accelerators
385
386
 
386
- # The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk
387
- # size is `30` GB. Defaults to `50` GB.
387
+ # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum
388
+ # boot disk size is `30` GB. Defaults to `50` GB.
388
389
  # Corresponds to the JSON property `bootDiskSizeGb`
389
390
  # @return [Fixnum]
390
391
  attr_accessor :boot_disk_size_gb
@@ -394,33 +395,56 @@ module Google
394
395
  # @return [Google::Apis::WorkstationsV1beta::GceConfidentialInstanceConfig]
395
396
  attr_accessor :confidential_instance_config
396
397
 
397
- # When set to true, disables public IP addresses for VMs. If you disable public
398
- # IP addresses, you must set up Private Google Access or Cloud NAT on your
399
- # network. If you use Private Google Access and you use `private.googleapis.com`
400
- # or `restricted.googleapis.com` for Container Registry and Artifact Registry,
401
- # make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`.
402
- # Defaults to false (VMs have public IP addresses).
398
+ # Optional. When set to true, disables public IP addresses for VMs. If you
399
+ # disable public IP addresses, you must set up Private Google Access or Cloud
400
+ # NAT on your network. If you use Private Google Access and you use `private.
401
+ # googleapis.com` or `restricted.googleapis.com` for Container Registry and
402
+ # Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io`
403
+ # and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
403
404
  # Corresponds to the JSON property `disablePublicIpAddresses`
404
405
  # @return [Boolean]
405
406
  attr_accessor :disable_public_ip_addresses
406
407
  alias_method :disable_public_ip_addresses?, :disable_public_ip_addresses
407
408
 
408
- # Whether to enable nested virtualization on instances.
409
+ # Optional. Whether to enable nested virtualization on Cloud Workstations VMs
410
+ # created under this workstation configuration. Nested virtualization lets you
411
+ # run virtual machine (VM) instances inside your workstation. Before enabling
412
+ # nested virtualization, consider the following important considerations. Cloud
413
+ # Workstations instances are subject to the [same restrictions as Compute Engine
414
+ # instances](https://cloud.google.com/compute/docs/instances/nested-
415
+ # virtualization/overview#restrictions): * **Organization policy**: projects,
416
+ # folders, or organizations may be restricted from creating nested VMs if the **
417
+ # Disable VM nested virtualization** constraint is enforced in the organization
418
+ # policy. For more information, see the Compute Engine section, [Checking
419
+ # whether nested virtualization is allowed](https://cloud.google.com/compute/
420
+ # docs/instances/nested-virtualization/managing-constraint#
421
+ # checking_whether_nested_virtualization_is_allowed). * **Performance**: nested
422
+ # VMs might experience a 10% or greater decrease in performance for workloads
423
+ # that are CPU-bound and possibly greater than a 10% decrease for workloads that
424
+ # are input/output bound. * **Machine Type**: nested virtualization can only be
425
+ # enabled on workstation configurations that specify a machine_type in the N1 or
426
+ # N2 machine series. * **GPUs**: nested virtualization may not be enabled on
427
+ # workstation configurations with accelerators. * **Operating System**: Because [
428
+ # Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-
429
+ # details#container-optimized_os_cos) does not support nested virtualization,
430
+ # when nested virtualization is enabled, the underlying Compute Engine VM
431
+ # instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/
432
+ # images/os-details#ubuntu_lts) image.
409
433
  # Corresponds to the JSON property `enableNestedVirtualization`
410
434
  # @return [Boolean]
411
435
  attr_accessor :enable_nested_virtualization
412
436
  alias_method :enable_nested_virtualization?, :enable_nested_virtualization
413
437
 
414
- # The type of machine to use for VM instances—for example, `e2-standard-4`. For
415
- # more information about machine types that Cloud Workstations supports, see the
416
- # list of [available machine types](https://cloud.google.com/workstations/docs/
417
- # available-machine-types).
438
+ # Optional. The type of machine to use for VM instances—for example, `"e2-
439
+ # standard-4"`. For more information about machine types that Cloud Workstations
440
+ # supports, see the list of [available machine types](https://cloud.google.com/
441
+ # workstations/docs/available-machine-types).
418
442
  # Corresponds to the JSON property `machineType`
419
443
  # @return [String]
420
444
  attr_accessor :machine_type
421
445
 
422
- # The number of VMs that the system should keep idle so that new workstations
423
- # can be started quickly for new users. Defaults to `0` in the API.
446
+ # Optional. The number of VMs that the system should keep idle so that new
447
+ # workstations can be started quickly for new users. Defaults to `0` in the API.
424
448
  # Corresponds to the JSON property `poolSize`
425
449
  # @return [Fixnum]
426
450
  attr_accessor :pool_size
@@ -431,17 +455,17 @@ module Google
431
455
  # @return [Fixnum]
432
456
  attr_accessor :pooled_instances
433
457
 
434
- # The email address of the service account for Cloud Workstations VMs created
435
- # with this configuration. When specified, be sure that the service account has `
436
- # logginglogEntries.create` permission on the project so it can write logs out
437
- # to Cloud Logging. If using a custom container image, the service account must
438
- # have permissions to pull the specified image. If you as the administrator want
439
- # to be able to `ssh` into the underlying VM, you need to set this value to a
440
- # service account for which you have the `iam.serviceAccounts.actAs` permission.
441
- # Conversely, if you don't want anyone to be able to `ssh` into the underlying
442
- # VM, use a service account where no one has that permission. If not set, VMs
443
- # run with a service account provided by the Cloud Workstations service, and the
444
- # image must be publicly accessible.
458
+ # Optional. The email address of the service account for Cloud Workstations VMs
459
+ # created with this configuration. When specified, be sure that the service
460
+ # account has `logginglogEntries.create` permission on the project so it can
461
+ # write logs out to Cloud Logging. If using a custom container image, the
462
+ # service account must have permissions to pull the specified image. If you as
463
+ # the administrator want to be able to `ssh` into the underlying VM, you need to
464
+ # set this value to a service account for which you have the `iam.
465
+ # serviceAccounts.actAs` permission. Conversely, if you don't want anyone to be
466
+ # able to `ssh` into the underlying VM, use a service account where no one has
467
+ # that permission. If not set, VMs run with a service account provided by the
468
+ # Cloud Workstations service, and the image must be publicly accessible.
445
469
  # Corresponds to the JSON property `serviceAccount`
446
470
  # @return [String]
447
471
  attr_accessor :service_account
@@ -451,10 +475,10 @@ module Google
451
475
  # @return [Google::Apis::WorkstationsV1beta::GceShieldedInstanceConfig]
452
476
  attr_accessor :shielded_instance_config
453
477
 
454
- # Network tags to add to the Compute Engine machines backing the workstations.
455
- # This option applies [network tags](https://cloud.google.com/vpc/docs/add-
456
- # remove-network-tags) to VMs created with this configuration. These network
457
- # tags enable the creation of [firewall rules](https://cloud.google.com/
478
+ # Optional. Network tags to add to the Compute Engine VMs backing the
479
+ # workstations. This option applies [network tags](https://cloud.google.com/vpc/
480
+ # docs/add-remove-network-tags) to VMs created with this configuration. These
481
+ # network tags enable the creation of [firewall rules](https://cloud.google.com/
458
482
  # workstations/docs/configure-firewall-rules).
459
483
  # Corresponds to the JSON property `tags`
460
484
  # @return [Array<String>]
@@ -481,7 +505,7 @@ module Google
481
505
  end
482
506
 
483
507
  # A PersistentDirectory backed by a Compute Engine regional persistent disk. The
484
- # `persistentDirectories[]` field is repeated, but it may contain only one entry.
508
+ # persistent_directories field is repeated, but it may contain only one entry.
485
509
  # It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/
486
510
  # persistent-disks) that mounts to the workstation VM at `/home` when the
487
511
  # session starts and detaches when the session ends. If this field is empty,
@@ -490,35 +514,35 @@ module Google
490
514
  class GceRegionalPersistentDisk
491
515
  include Google::Apis::Core::Hashable
492
516
 
493
- # The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#
494
- # disk-types) for the home directory. Defaults to `pd-standard`.
517
+ # Optional. The [type of the persistent disk](https://cloud.google.com/compute/
518
+ # docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`.
495
519
  # Corresponds to the JSON property `diskType`
496
520
  # @return [String]
497
521
  attr_accessor :disk_type
498
522
 
499
- # Type of file system that the disk should be formatted with. The workstation
500
- # image must support this file system type. Must be empty if source_snapshot is
501
- # set. Defaults to `ext4`.
523
+ # Optional. Type of file system that the disk should be formatted with. The
524
+ # workstation image must support this file system type. Must be empty if
525
+ # source_snapshot is set. Defaults to `"ext4"`.
502
526
  # Corresponds to the JSON property `fsType`
503
527
  # @return [String]
504
528
  attr_accessor :fs_type
505
529
 
506
- # Whether the persistent disk should be deleted when the workstation is deleted.
507
- # Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
530
+ # Optional. Whether the persistent disk should be deleted when the workstation
531
+ # is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
508
532
  # Corresponds to the JSON property `reclaimPolicy`
509
533
  # @return [String]
510
534
  attr_accessor :reclaim_policy
511
535
 
512
- # The GB capacity of a persistent home directory for each workstation created
513
- # with this configuration. Must be empty if `source_snapshot` is set. Valid
514
- # values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If
515
- # less than `200` GB, the `diskType` must be `pd-balanced` or `pd-ssd`.
536
+ # Optional. The GB capacity of a persistent home directory for each workstation
537
+ # created with this configuration. Must be empty if source_snapshot is set.
538
+ # Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`.
539
+ # If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`.
516
540
  # Corresponds to the JSON property `sizeGb`
517
541
  # @return [Fixnum]
518
542
  attr_accessor :size_gb
519
543
 
520
- # Name of the snapshot to use as the source for the disk. If set, size_gb and
521
- # fs_type must be empty.
544
+ # Optional. Name of the snapshot to use as the source for the disk. If set,
545
+ # size_gb and fs_type must be empty.
522
546
  # Corresponds to the JSON property `sourceSnapshot`
523
547
  # @return [String]
524
548
  attr_accessor :source_snapshot
@@ -541,19 +565,19 @@ module Google
541
565
  class GceShieldedInstanceConfig
542
566
  include Google::Apis::Core::Hashable
543
567
 
544
- # Whether the instance has integrity monitoring enabled.
568
+ # Optional. Whether the instance has integrity monitoring enabled.
545
569
  # Corresponds to the JSON property `enableIntegrityMonitoring`
546
570
  # @return [Boolean]
547
571
  attr_accessor :enable_integrity_monitoring
548
572
  alias_method :enable_integrity_monitoring?, :enable_integrity_monitoring
549
573
 
550
- # Whether the instance has Secure Boot enabled.
574
+ # Optional. Whether the instance has Secure Boot enabled.
551
575
  # Corresponds to the JSON property `enableSecureBoot`
552
576
  # @return [Boolean]
553
577
  attr_accessor :enable_secure_boot
554
578
  alias_method :enable_secure_boot?, :enable_secure_boot
555
579
 
556
- # Whether the instance has the vTPM enabled.
580
+ # Optional. Whether the instance has the vTPM enabled.
557
581
  # Corresponds to the JSON property `enableVtpm`
558
582
  # @return [Boolean]
559
583
  attr_accessor :enable_vtpm
@@ -819,13 +843,13 @@ module Google
819
843
  class ListWorkstationsResponse
820
844
  include Google::Apis::Core::Hashable
821
845
 
822
- # Token to retrieve the next page of results, or empty if there are no more
823
- # results in the list.
846
+ # Optional. Token to retrieve the next page of results, or empty if there are no
847
+ # more results in the list.
824
848
  # Corresponds to the JSON property `nextPageToken`
825
849
  # @return [String]
826
850
  attr_accessor :next_page_token
827
851
 
828
- # Unreachable resources.
852
+ # Optional. Unreachable resources.
829
853
  # Corresponds to the JSON property `unreachable`
830
854
  # @return [Array<String>]
831
855
  attr_accessor :unreachable
@@ -884,13 +908,13 @@ module Google
884
908
  # @return [String]
885
909
  attr_accessor :name
886
910
 
887
- # The normal response of the operation in case of success. If the original
888
- # method returns no data on success, such as `Delete`, the response is `google.
889
- # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
890
- # the response should be the resource. For other methods, the response should
891
- # have the type `XxxResponse`, where `Xxx` is the original method name. For
892
- # example, if the original method name is `TakeSnapshot()`, the inferred
893
- # response type is `TakeSnapshotResponse`.
911
+ # The normal, successful response of the operation. If the original method
912
+ # returns no data on success, such as `Delete`, the response is `google.protobuf.
913
+ # Empty`. If the original method is standard `Get`/`Create`/`Update`, the
914
+ # response should be the resource. For other methods, the response should have
915
+ # the type `XxxResponse`, where `Xxx` is the original method name. For example,
916
+ # if the original method name is `TakeSnapshot()`, the inferred response type is
917
+ # `TakeSnapshotResponse`.
894
918
  # Corresponds to the JSON property `response`
895
919
  # @return [Hash<String,Object>]
896
920
  attr_accessor :response
@@ -971,7 +995,7 @@ module Google
971
995
  include Google::Apis::Core::Hashable
972
996
 
973
997
  # A PersistentDirectory backed by a Compute Engine regional persistent disk. The
974
- # `persistentDirectories[]` field is repeated, but it may contain only one entry.
998
+ # persistent_directories field is repeated, but it may contain only one entry.
975
999
  # It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/
976
1000
  # persistent-disks) that mounts to the workstation VM at `/home` when the
977
1001
  # session starts and detaches when the session ends. If this field is empty,
@@ -981,7 +1005,7 @@ module Google
981
1005
  # @return [Google::Apis::WorkstationsV1beta::GceRegionalPersistentDisk]
982
1006
  attr_accessor :gce_pd
983
1007
 
984
- # Location of this directory in the running workstation.
1008
+ # Optional. Location of this directory in the running workstation.
985
1009
  # Corresponds to the JSON property `mountPath`
986
1010
  # @return [String]
987
1011
  attr_accessor :mount_path
@@ -1008,22 +1032,22 @@ module Google
1008
1032
  # evaluates to `true`. A condition can add constraints based on attributes of
1009
1033
  # the request, the resource, or both. To learn which resources support
1010
1034
  # conditions in their IAM policies, see the [IAM documentation](https://cloud.
1011
- # google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
1035
+ # google.com/iam/help/conditions/resource-policies). **JSON example:** ``` ` "
1012
1036
  # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
1013
1037
  # "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
1014
1038
  # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
1015
1039
  # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
1016
1040
  # ], "condition": ` "title": "expirable access", "description": "Does not grant
1017
1041
  # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
1018
- # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
1019
- # bindings: - members: - user:mike@example.com - group:admins@example.com -
1020
- # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
1021
- # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
1022
- # com role: roles/resourcemanager.organizationViewer condition: title: expirable
1023
- # access description: Does not grant access after Sep 2020 expression: request.
1024
- # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
1025
- # a description of IAM and its features, see the [IAM documentation](https://
1026
- # cloud.google.com/iam/docs/).
1042
+ # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` ``` **YAML
1043
+ # example:** ``` bindings: - members: - user:mike@example.com - group:admins@
1044
+ # example.com - domain:google.com - serviceAccount:my-project-id@appspot.
1045
+ # gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: -
1046
+ # user:eve@example.com role: roles/resourcemanager.organizationViewer condition:
1047
+ # title: expirable access description: Does not grant access after Sep 2020
1048
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag:
1049
+ # BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the
1050
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
1027
1051
  class Policy
1028
1052
  include Google::Apis::Core::Hashable
1029
1053
 
@@ -1092,21 +1116,22 @@ module Google
1092
1116
  end
1093
1117
  end
1094
1118
 
1095
- # Configuration options for private clusters.
1119
+ # Configuration options for private workstation clusters.
1096
1120
  class PrivateClusterConfig
1097
1121
  include Google::Apis::Core::Hashable
1098
1122
 
1099
- # Additional projects that are allowed to attach to the workstation cluster's
1100
- # service attachment. By default, the workstation cluster's project and the VPC
1101
- # host project (if different) are allowed.
1123
+ # Optional. Additional projects that are allowed to attach to the workstation
1124
+ # cluster's service attachment. By default, the workstation cluster's project
1125
+ # and the VPC host project (if different) are allowed.
1102
1126
  # Corresponds to the JSON property `allowedProjects`
1103
1127
  # @return [Array<String>]
1104
1128
  attr_accessor :allowed_projects
1105
1129
 
1106
1130
  # Output only. Hostname for the workstation cluster. This field will be
1107
1131
  # populated only when private endpoint is enabled. To access workstations in the
1108
- # cluster, create a new DNS zone mapping this domain name to an internal IP
1109
- # address and a forwarding rule mapping that address to the service attachment.
1132
+ # workstation cluster, create a new DNS zone mapping this domain name to an
1133
+ # internal IP address and a forwarding rule mapping that address to the service
1134
+ # attachment.
1110
1135
  # Corresponds to the JSON property `clusterHostname`
1111
1136
  # @return [String]
1112
1137
  attr_accessor :cluster_hostname
@@ -1119,9 +1144,9 @@ module Google
1119
1144
 
1120
1145
  # Output only. Service attachment URI for the workstation cluster. The service
1121
1146
  # attachemnt is created when private endpoint is enabled. To access workstations
1122
- # in the cluster, configure access to the managed service using [Private Service
1123
- # Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-
1124
- # services).
1147
+ # in the workstation cluster, configure access to the managed service using [
1148
+ # Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-
1149
+ # service-connect-services).
1125
1150
  # Corresponds to the JSON property `serviceAttachmentUri`
1126
1151
  # @return [String]
1127
1152
  attr_accessor :service_attachment_uri
@@ -1143,12 +1168,12 @@ module Google
1143
1168
  class ReadinessCheck
1144
1169
  include Google::Apis::Core::Hashable
1145
1170
 
1146
- # Path to which the request should be sent.
1171
+ # Optional. Path to which the request should be sent.
1147
1172
  # Corresponds to the JSON property `path`
1148
1173
  # @return [String]
1149
1174
  attr_accessor :path
1150
1175
 
1151
- # Port to which the request should be sent.
1176
+ # Optional. Port to which the request should be sent.
1152
1177
  # Corresponds to the JSON property `port`
1153
1178
  # @return [Fixnum]
1154
1179
  attr_accessor :port
@@ -1179,22 +1204,22 @@ module Google
1179
1204
  # evaluates to `true`. A condition can add constraints based on attributes of
1180
1205
  # the request, the resource, or both. To learn which resources support
1181
1206
  # conditions in their IAM policies, see the [IAM documentation](https://cloud.
1182
- # google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
1207
+ # google.com/iam/help/conditions/resource-policies). **JSON example:** ``` ` "
1183
1208
  # bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
1184
1209
  # "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
1185
1210
  # serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
1186
1211
  # roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
1187
1212
  # ], "condition": ` "title": "expirable access", "description": "Does not grant
1188
1213
  # access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
1189
- # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
1190
- # bindings: - members: - user:mike@example.com - group:admins@example.com -
1191
- # domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
1192
- # role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
1193
- # com role: roles/resourcemanager.organizationViewer condition: title: expirable
1194
- # access description: Does not grant access after Sep 2020 expression: request.
1195
- # time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
1196
- # a description of IAM and its features, see the [IAM documentation](https://
1197
- # cloud.google.com/iam/docs/).
1214
+ # 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` ``` **YAML
1215
+ # example:** ``` bindings: - members: - user:mike@example.com - group:admins@
1216
+ # example.com - domain:google.com - serviceAccount:my-project-id@appspot.
1217
+ # gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: -
1218
+ # user:eve@example.com role: roles/resourcemanager.organizationViewer condition:
1219
+ # title: expirable access description: Does not grant access after Sep 2020
1220
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag:
1221
+ # BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the
1222
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
1198
1223
  # Corresponds to the JSON property `policy`
1199
1224
  # @return [Google::Apis::WorkstationsV1beta::Policy]
1200
1225
  attr_accessor :policy
@@ -1221,14 +1246,14 @@ module Google
1221
1246
  class StartWorkstationRequest
1222
1247
  include Google::Apis::Core::Hashable
1223
1248
 
1224
- # If set, the request will be rejected if the latest version of the workstation
1225
- # on the server does not have this ETag.
1249
+ # Optional. If set, the request will be rejected if the latest version of the
1250
+ # workstation on the server does not have this ETag.
1226
1251
  # Corresponds to the JSON property `etag`
1227
1252
  # @return [String]
1228
1253
  attr_accessor :etag
1229
1254
 
1230
- # If set, validate the request and preview the review, but do not actually apply
1231
- # it.
1255
+ # Optional. If set, validate the request and preview the review, but do not
1256
+ # actually apply it.
1232
1257
  # Corresponds to the JSON property `validateOnly`
1233
1258
  # @return [Boolean]
1234
1259
  attr_accessor :validate_only
@@ -1288,14 +1313,14 @@ module Google
1288
1313
  class StopWorkstationRequest
1289
1314
  include Google::Apis::Core::Hashable
1290
1315
 
1291
- # If set, the request will be rejected if the latest version of the workstation
1292
- # on the server does not have this ETag.
1316
+ # Optional. If set, the request will be rejected if the latest version of the
1317
+ # workstation on the server does not have this ETag.
1293
1318
  # Corresponds to the JSON property `etag`
1294
1319
  # @return [String]
1295
1320
  attr_accessor :etag
1296
1321
 
1297
- # If set, validate the request and preview the review, but do not actually apply
1298
- # it.
1322
+ # Optional. If set, validate the request and preview the review, but do not
1323
+ # actually apply it.
1299
1324
  # Corresponds to the JSON property `validateOnly`
1300
1325
  # @return [Boolean]
1301
1326
  attr_accessor :validate_only
@@ -1356,33 +1381,35 @@ module Google
1356
1381
  class Workstation
1357
1382
  include Google::Apis::Core::Hashable
1358
1383
 
1359
- # Client-specified annotations.
1384
+ # Optional. Client-specified annotations.
1360
1385
  # Corresponds to the JSON property `annotations`
1361
1386
  # @return [Hash<String,String>]
1362
1387
  attr_accessor :annotations
1363
1388
 
1364
- # Output only. Time when this resource was created.
1389
+ # Output only. Time when this workstation was created.
1365
1390
  # Corresponds to the JSON property `createTime`
1366
1391
  # @return [String]
1367
1392
  attr_accessor :create_time
1368
1393
 
1369
- # Output only. Time when this resource was soft-deleted.
1394
+ # Output only. Time when this workstation was soft-deleted.
1370
1395
  # Corresponds to the JSON property `deleteTime`
1371
1396
  # @return [String]
1372
1397
  attr_accessor :delete_time
1373
1398
 
1374
- # Human-readable name for this resource.
1399
+ # Optional. Human-readable name for this workstation.
1375
1400
  # Corresponds to the JSON property `displayName`
1376
1401
  # @return [String]
1377
1402
  attr_accessor :display_name
1378
1403
 
1379
- # Environment variables passed to the workstation container's entrypoint.
1404
+ # Optional. Environment variables passed to the workstation container's
1405
+ # entrypoint.
1380
1406
  # Corresponds to the JSON property `env`
1381
1407
  # @return [Hash<String,String>]
1382
1408
  attr_accessor :env
1383
1409
 
1384
- # Checksum computed by the server. May be sent on update and delete requests to
1385
- # make sure that the client has an up-to-date value before proceeding.
1410
+ # Optional. Checksum computed by the server. May be sent on update and delete
1411
+ # requests to make sure that the client has an up-to-date value before
1412
+ # proceeding.
1386
1413
  # Corresponds to the JSON property `etag`
1387
1414
  # @return [String]
1388
1415
  attr_accessor :etag
@@ -1395,18 +1422,19 @@ module Google
1395
1422
  # @return [String]
1396
1423
  attr_accessor :host
1397
1424
 
1398
- # Client-specified labels that are applied to the resource and that are also
1399
- # propagated to the underlying Compute Engine resources.
1425
+ # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources)
1426
+ # that are applied to the workstation and that are also propagated to the
1427
+ # underlying Compute Engine resources.
1400
1428
  # Corresponds to the JSON property `labels`
1401
1429
  # @return [Hash<String,String>]
1402
1430
  attr_accessor :labels
1403
1431
 
1404
- # Full name of this resource.
1432
+ # Full name of this workstation.
1405
1433
  # Corresponds to the JSON property `name`
1406
1434
  # @return [String]
1407
1435
  attr_accessor :name
1408
1436
 
1409
- # Output only. Indicates whether this resource is currently being updated to
1437
+ # Output only. Indicates whether this workstation is currently being updated to
1410
1438
  # match its intended state.
1411
1439
  # Corresponds to the JSON property `reconciling`
1412
1440
  # @return [Boolean]
@@ -1418,12 +1446,12 @@ module Google
1418
1446
  # @return [String]
1419
1447
  attr_accessor :state
1420
1448
 
1421
- # Output only. A system-assigned unique identifier for this resource.
1449
+ # Output only. A system-assigned unique identifier for this workstation.
1422
1450
  # Corresponds to the JSON property `uid`
1423
1451
  # @return [String]
1424
1452
  attr_accessor :uid
1425
1453
 
1426
- # Output only. Time when this resource was most recently updated.
1454
+ # Output only. Time when this workstation was most recently updated.
1427
1455
  # Corresponds to the JSON property `updateTime`
1428
1456
  # @return [String]
1429
1457
  attr_accessor :update_time
@@ -1450,100 +1478,103 @@ module Google
1450
1478
  end
1451
1479
  end
1452
1480
 
1453
- # A grouping of workstation configurations and the associated workstations in
1454
- # that region.
1481
+ # A workstation cluster resource in the Cloud Workstations API. Defines a group
1482
+ # of workstations in a particular region and the VPC network they're attached to.
1455
1483
  class WorkstationCluster
1456
1484
  include Google::Apis::Core::Hashable
1457
1485
 
1458
- # Client-specified annotations.
1486
+ # Optional. Client-specified annotations.
1459
1487
  # Corresponds to the JSON property `annotations`
1460
1488
  # @return [Hash<String,String>]
1461
1489
  attr_accessor :annotations
1462
1490
 
1463
- # Output only. Status conditions describing the current resource state.
1491
+ # Output only. Status conditions describing the workstation cluster's current
1492
+ # state.
1464
1493
  # Corresponds to the JSON property `conditions`
1465
1494
  # @return [Array<Google::Apis::WorkstationsV1beta::Status>]
1466
1495
  attr_accessor :conditions
1467
1496
 
1468
- # Output only. The private IP address of the control plane for this cluster.
1469
- # Workstation VMs need access to this IP address to work with the service, so
1470
- # make sure that your firewall rules allow egress from the workstation VMs to
1471
- # this address.
1497
+ # Output only. The private IP address of the control plane for this workstation
1498
+ # cluster. Workstation VMs need access to this IP address to work with the
1499
+ # service, so make sure that your firewall rules allow egress from the
1500
+ # workstation VMs to this address.
1472
1501
  # Corresponds to the JSON property `controlPlaneIp`
1473
1502
  # @return [String]
1474
1503
  attr_accessor :control_plane_ip
1475
1504
 
1476
- # Output only. Time when this resource was created.
1505
+ # Output only. Time when this workstation cluster was created.
1477
1506
  # Corresponds to the JSON property `createTime`
1478
1507
  # @return [String]
1479
1508
  attr_accessor :create_time
1480
1509
 
1481
- # Output only. Whether this resource is in degraded mode, in which case it may
1482
- # require user action to restore full functionality. Details can be found in the
1483
- # `conditions` field.
1510
+ # Output only. Whether this workstation cluster is in degraded mode, in which
1511
+ # case it may require user action to restore full functionality. Details can be
1512
+ # found in conditions.
1484
1513
  # Corresponds to the JSON property `degraded`
1485
1514
  # @return [Boolean]
1486
1515
  attr_accessor :degraded
1487
1516
  alias_method :degraded?, :degraded
1488
1517
 
1489
- # Output only. Time when this resource was soft-deleted.
1518
+ # Output only. Time when this workstation cluster was soft-deleted.
1490
1519
  # Corresponds to the JSON property `deleteTime`
1491
1520
  # @return [String]
1492
1521
  attr_accessor :delete_time
1493
1522
 
1494
- # Human-readable name for this resource.
1523
+ # Optional. Human-readable name for this workstation cluster.
1495
1524
  # Corresponds to the JSON property `displayName`
1496
1525
  # @return [String]
1497
1526
  attr_accessor :display_name
1498
1527
 
1499
- # Checksum computed by the server. May be sent on update and delete requests to
1500
- # make sure that the client has an up-to-date value before proceeding.
1528
+ # Optional. Checksum computed by the server. May be sent on update and delete
1529
+ # requests to make sure that the client has an up-to-date value before
1530
+ # proceeding.
1501
1531
  # Corresponds to the JSON property `etag`
1502
1532
  # @return [String]
1503
1533
  attr_accessor :etag
1504
1534
 
1505
- # Client-specified labels that are applied to the resource and that are also
1506
- # propagated to the underlying Compute Engine resources.
1535
+ # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources)
1536
+ # that are applied to the workstation cluster and that are also propagated to
1537
+ # the underlying Compute Engine resources.
1507
1538
  # Corresponds to the JSON property `labels`
1508
1539
  # @return [Hash<String,String>]
1509
1540
  attr_accessor :labels
1510
1541
 
1511
- # Full name of this resource.
1542
+ # Full name of this workstation cluster.
1512
1543
  # Corresponds to the JSON property `name`
1513
1544
  # @return [String]
1514
1545
  attr_accessor :name
1515
1546
 
1516
1547
  # Immutable. Name of the Compute Engine network in which instances associated
1517
- # with this cluster will be created.
1548
+ # with this workstation cluster will be created.
1518
1549
  # Corresponds to the JSON property `network`
1519
1550
  # @return [String]
1520
1551
  attr_accessor :network
1521
1552
 
1522
- # Configuration options for private clusters.
1553
+ # Configuration options for private workstation clusters.
1523
1554
  # Corresponds to the JSON property `privateClusterConfig`
1524
1555
  # @return [Google::Apis::WorkstationsV1beta::PrivateClusterConfig]
1525
1556
  attr_accessor :private_cluster_config
1526
1557
 
1527
- # Output only. Indicates whether this resource is currently being updated to
1528
- # match its intended state.
1558
+ # Output only. Indicates whether this workstation cluster is currently being
1559
+ # updated to match its intended state.
1529
1560
  # Corresponds to the JSON property `reconciling`
1530
1561
  # @return [Boolean]
1531
1562
  attr_accessor :reconciling
1532
1563
  alias_method :reconciling?, :reconciling
1533
1564
 
1534
1565
  # Immutable. Name of the Compute Engine subnetwork in which instances associated
1535
- # with this cluster will be created. Must be part of the subnetwork specified
1536
- # for this cluster.
1566
+ # with this workstation cluster will be created. Must be part of the subnetwork
1567
+ # specified for this workstation cluster.
1537
1568
  # Corresponds to the JSON property `subnetwork`
1538
1569
  # @return [String]
1539
1570
  attr_accessor :subnetwork
1540
1571
 
1541
- # Output only. A system-assigned unique identifier for this resource.
1572
+ # Output only. A system-assigned unique identifier for this workstation cluster.
1542
1573
  # Corresponds to the JSON property `uid`
1543
1574
  # @return [String]
1544
1575
  attr_accessor :uid
1545
1576
 
1546
- # Output only. Time when this resource was most recently updated.
1577
+ # Output only. Time when this workstation cluster was most recently updated.
1547
1578
  # Corresponds to the JSON property `updateTime`
1548
1579
  # @return [String]
1549
1580
  attr_accessor :update_time
@@ -1573,13 +1604,17 @@ module Google
1573
1604
  end
1574
1605
  end
1575
1606
 
1576
- # A set of configuration options that describe how a workstation runs.
1577
- # Workstation configurations are intended to be shared across multiple
1578
- # workstations.
1607
+ # A workstation configuration resource in the Cloud Workstations API.
1608
+ # Workstation configurations act as templates for workstations. The workstation
1609
+ # configuration defines details such as the workstation virtual machine (VM)
1610
+ # instance type, persistent storage, container image defining environment, which
1611
+ # IDE or Code Editor to use, and more. Administrators and platform teams can
1612
+ # also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/
1613
+ # docs/overview) rules to grant access to teams or to individual developers.
1579
1614
  class WorkstationConfig
1580
1615
  include Google::Apis::Core::Hashable
1581
1616
 
1582
- # Client-specified annotations.
1617
+ # Optional. Client-specified annotations.
1583
1618
  # Corresponds to the JSON property `annotations`
1584
1619
  # @return [Hash<String,String>]
1585
1620
  attr_accessor :annotations
@@ -1594,32 +1629,33 @@ module Google
1594
1629
  # @return [Google::Apis::WorkstationsV1beta::Container]
1595
1630
  attr_accessor :container
1596
1631
 
1597
- # Output only. Time when this resource was created.
1632
+ # Output only. Time when this workstation configuration was created.
1598
1633
  # Corresponds to the JSON property `createTime`
1599
1634
  # @return [String]
1600
1635
  attr_accessor :create_time
1601
1636
 
1602
1637
  # Output only. Whether this resource is degraded, in which case it may require
1603
- # user action to restore full functionality. See also the `conditions` field.
1638
+ # user action to restore full functionality. See also the conditions field.
1604
1639
  # Corresponds to the JSON property `degraded`
1605
1640
  # @return [Boolean]
1606
1641
  attr_accessor :degraded
1607
1642
  alias_method :degraded?, :degraded
1608
1643
 
1609
- # Output only. Time when this resource was soft-deleted.
1644
+ # Output only. Time when this workstation configuration was soft-deleted.
1610
1645
  # Corresponds to the JSON property `deleteTime`
1611
1646
  # @return [String]
1612
1647
  attr_accessor :delete_time
1613
1648
 
1614
- # Human-readable name for this resource.
1649
+ # Optional. Human-readable name for this workstation configuration.
1615
1650
  # Corresponds to the JSON property `displayName`
1616
1651
  # @return [String]
1617
1652
  attr_accessor :display_name
1618
1653
 
1619
- # Whether to enable Linux `auditd` logging on the workstation. When enabled, a
1620
- # service account must also be specified that has `logging.buckets.write`
1621
- # permission on the project. Operating system audit logging is distinct from [
1622
- # Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).
1654
+ # Optional. Whether to enable Linux `auditd` logging on the workstation. When
1655
+ # enabled, a service account must also be specified that has `logging.buckets.
1656
+ # write` permission on the project. Operating system audit logging is distinct
1657
+ # from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-
1658
+ # logging).
1623
1659
  # Corresponds to the JSON property `enableAuditAgent`
1624
1660
  # @return [Boolean]
1625
1661
  attr_accessor :enable_audit_agent
@@ -1634,8 +1670,9 @@ module Google
1634
1670
  # @return [Google::Apis::WorkstationsV1beta::CustomerEncryptionKey]
1635
1671
  attr_accessor :encryption_key
1636
1672
 
1637
- # Checksum computed by the server. May be sent on update and delete requests to
1638
- # make sure that the client has an up-to-date value before proceeding.
1673
+ # Optional. Checksum computed by the server. May be sent on update and delete
1674
+ # requests to make sure that the client has an up-to-date value before
1675
+ # proceeding.
1639
1676
  # Corresponds to the JSON property `etag`
1640
1677
  # @return [String]
1641
1678
  attr_accessor :etag
@@ -1645,69 +1682,72 @@ module Google
1645
1682
  # @return [Google::Apis::WorkstationsV1beta::Host]
1646
1683
  attr_accessor :host
1647
1684
 
1648
- # Number of seconds to wait before automatically stopping a workstation after it
1649
- # last received user traffic. A value of `0s` indicates that Cloud Workstations
1650
- # VMs created with this configuration should never time out due to idleness.
1651
- # Provide [duration](https://developers.google.com/protocol-buffers/docs/
1652
- # reference/google.protobuf#duration) terminated by `s` for seconds—for example,
1653
- # `7200s` (2 hours). The default is `1200s` (20 minutes).
1685
+ # Optional. Number of seconds to wait before automatically stopping a
1686
+ # workstation after it last received user traffic. A value of `"0s"` indicates
1687
+ # that Cloud Workstations VMs created with this configuration should never time
1688
+ # out due to idleness. Provide [duration](https://developers.google.com/protocol-
1689
+ # buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—
1690
+ # for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
1654
1691
  # Corresponds to the JSON property `idleTimeout`
1655
1692
  # @return [String]
1656
1693
  attr_accessor :idle_timeout
1657
1694
 
1658
- # Client-specified labels that are applied to the resource and that are also
1659
- # propagated to the underlying Compute Engine resources.
1695
+ # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources)
1696
+ # that are applied to the workstation configuration and that are also propagated
1697
+ # to the underlying Compute Engine resources.
1660
1698
  # Corresponds to the JSON property `labels`
1661
1699
  # @return [Hash<String,String>]
1662
1700
  attr_accessor :labels
1663
1701
 
1664
- # Full name of this resource.
1702
+ # Full name of this workstation configuration.
1665
1703
  # Corresponds to the JSON property `name`
1666
1704
  # @return [String]
1667
1705
  attr_accessor :name
1668
1706
 
1669
- # Directories to persist across workstation sessions.
1707
+ # Optional. Directories to persist across workstation sessions.
1670
1708
  # Corresponds to the JSON property `persistentDirectories`
1671
1709
  # @return [Array<Google::Apis::WorkstationsV1beta::PersistentDirectory>]
1672
1710
  attr_accessor :persistent_directories
1673
1711
 
1674
- # Readiness checks to perform when starting a workstation using this workstation
1675
- # configuration. Mark a workstation as running only after all specified
1676
- # readiness checks return 200 status codes.
1712
+ # Optional. Readiness checks to perform when starting a workstation using this
1713
+ # workstation configuration. Mark a workstation as running only after all
1714
+ # specified readiness checks return 200 status codes.
1677
1715
  # Corresponds to the JSON property `readinessChecks`
1678
1716
  # @return [Array<Google::Apis::WorkstationsV1beta::ReadinessCheck>]
1679
1717
  attr_accessor :readiness_checks
1680
1718
 
1681
- # Output only. Indicates whether this resource is currently being updated to
1682
- # match its intended state.
1719
+ # Output only. Indicates whether this workstation configuration is currently
1720
+ # being updated to match its intended state.
1683
1721
  # Corresponds to the JSON property `reconciling`
1684
1722
  # @return [Boolean]
1685
1723
  attr_accessor :reconciling
1686
1724
  alias_method :reconciling?, :reconciling
1687
1725
 
1688
- # Number of seconds that a workstation can run until it is automatically shut
1689
- # down. We recommend that workstations be shut down daily to reduce costs and so
1690
- # that security updates can be applied upon restart. The `idleTimeout` and `
1691
- # runningTimeout` parameters are independent of each other. Note that the `
1692
- # runningTimeout` parameter shuts down VMs after the specified time, regardless
1693
- # of whether or not the VMs are idle. Provide duration terminated by `s` for
1694
- # seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A
1695
- # value of `0` indicates that workstations using this configuration should never
1696
- # time out. If `encryption_key` is set, it must be greater than `0` and less
1697
- # than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud
1698
- # Workstations VMs created with this configuration have no maximum running time.
1699
- # This is strongly discouraged because you incur costs and will not pick up
1700
- # security updates.
1726
+ # Optional. Number of seconds that a workstation can run until it is
1727
+ # automatically shut down. We recommend that workstations be shut down daily to
1728
+ # reduce costs and so that security updates can be applied upon restart. The
1729
+ # idle_timeout and running_timeout fields are independent of each other. Note
1730
+ # that the running_timeout field shuts down VMs after the specified time,
1731
+ # regardless of whether or not the VMs are idle. Provide duration terminated by `
1732
+ # s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12
1733
+ # hours). A value of `"0s"` indicates that workstations using this configuration
1734
+ # should never time out. If encryption_key is set, it must be greater than `"0s"`
1735
+ # and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates
1736
+ # that Cloud Workstations VMs created with this configuration have no maximum
1737
+ # running time. This is strongly discouraged because you incur costs and will
1738
+ # not pick up security updates.
1701
1739
  # Corresponds to the JSON property `runningTimeout`
1702
1740
  # @return [String]
1703
1741
  attr_accessor :running_timeout
1704
1742
 
1705
- # Output only. A system-assigned unique identifier for this resource.
1743
+ # Output only. A system-assigned unique identifier for this workstation
1744
+ # configuration.
1706
1745
  # Corresponds to the JSON property `uid`
1707
1746
  # @return [String]
1708
1747
  attr_accessor :uid
1709
1748
 
1710
- # Output only. Time when this resource was most recently updated.
1749
+ # Output only. Time when this workstation configuration was most recently
1750
+ # updated.
1711
1751
  # Corresponds to the JSON property `updateTime`
1712
1752
  # @return [String]
1713
1753
  attr_accessor :update_time
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module WorkstationsV1beta
18
18
  # Version of the google-apis-workstations_v1beta gem
19
- GEM_VERSION = "0.14.0"
19
+ GEM_VERSION = "0.15.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230619"
25
+ REVISION = "20230802"
26
26
  end
27
27
  end
28
28
  end
@@ -198,8 +198,8 @@ module Google
198
198
  # Required. Parent resource name.
199
199
  # @param [Google::Apis::WorkstationsV1beta::WorkstationCluster] workstation_cluster_object
200
200
  # @param [Boolean] validate_only
201
- # If set, validate the request and preview the review, but do not actually apply
202
- # it.
201
+ # Optional. If set, validate the request and preview the review, but do not
202
+ # actually apply it.
203
203
  # @param [String] workstation_cluster_id
204
204
  # Required. ID to use for the workstation cluster.
205
205
  # @param [String] fields
@@ -237,14 +237,15 @@ module Google
237
237
  # @param [String] name
238
238
  # Required. Name of the workstation cluster to delete.
239
239
  # @param [String] etag
240
- # If set, the request will be rejected if the latest version of the workstation
241
- # cluster on the server does not have this ETag.
240
+ # Optional. If set, the request will be rejected if the latest version of the
241
+ # workstation cluster on the server does not have this ETag.
242
242
  # @param [Boolean] force
243
- # If set, any workstation configurations and workstations in the workstation
244
- # cluster are also deleted. Otherwise, the request only works if the workstation
245
- # cluster has no configurations or workstations.
243
+ # Optional. If set, any workstation configurations and workstations in the
244
+ # workstation cluster are also deleted. Otherwise, the request only works if the
245
+ # workstation cluster has no configurations or workstations.
246
246
  # @param [Boolean] validate_only
247
- # If set, validate the request and preview the review, but do not apply it.
247
+ # Optional. If set, validate the request and preview the review, but do not
248
+ # apply it.
248
249
  # @param [String] fields
249
250
  # Selector specifying which fields to include in a partial response.
250
251
  # @param [String] quota_user
@@ -309,9 +310,9 @@ module Google
309
310
  # @param [String] parent
310
311
  # Required. Parent resource name.
311
312
  # @param [Fixnum] page_size
312
- # Maximum number of items to return.
313
+ # Optional. Maximum number of items to return.
313
314
  # @param [String] page_token
314
- # next_page_token value returned from a previous List request, if any.
315
+ # Optional. next_page_token value returned from a previous List request, if any.
315
316
  # @param [String] fields
316
317
  # Selector specifying which fields to include in a partial response.
317
318
  # @param [String] quota_user
@@ -343,17 +344,17 @@ module Google
343
344
 
344
345
  # Updates an existing workstation cluster.
345
346
  # @param [String] name
346
- # Full name of this resource.
347
+ # Full name of this workstation cluster.
347
348
  # @param [Google::Apis::WorkstationsV1beta::WorkstationCluster] workstation_cluster_object
348
349
  # @param [Boolean] allow_missing
349
- # If set, and the workstation cluster is not found, a new workstation cluster
350
- # will be created. In this situation, update_mask is ignored.
350
+ # Optional. If set, and the workstation cluster is not found, a new workstation
351
+ # cluster will be created. In this situation, update_mask is ignored.
351
352
  # @param [String] update_mask
352
353
  # Required. Mask that specifies which fields in the workstation cluster should
353
354
  # be updated.
354
355
  # @param [Boolean] validate_only
355
- # If set, validate the request and preview the review, but do not actually apply
356
- # it.
356
+ # Optional. If set, validate the request and preview the review, but do not
357
+ # actually apply it.
357
358
  # @param [String] fields
358
359
  # Selector specifying which fields to include in a partial response.
359
360
  # @param [String] quota_user
@@ -391,8 +392,8 @@ module Google
391
392
  # Required. Parent resource name.
392
393
  # @param [Google::Apis::WorkstationsV1beta::WorkstationConfig] workstation_config_object
393
394
  # @param [Boolean] validate_only
394
- # If set, validate the request and preview the review, but do not actually apply
395
- # it.
395
+ # Optional. If set, validate the request and preview the review, but do not
396
+ # actually apply it.
396
397
  # @param [String] workstation_config_id
397
398
  # Required. ID to use for the workstation configuration.
398
399
  # @param [String] fields
@@ -430,15 +431,15 @@ module Google
430
431
  # @param [String] name
431
432
  # Required. Name of the workstation configuration to delete.
432
433
  # @param [String] etag
433
- # If set, the request is rejected if the latest version of the workstation
434
- # configuration on the server does not have this ETag.
434
+ # Optional. If set, the request is rejected if the latest version of the
435
+ # workstation configuration on the server does not have this ETag.
435
436
  # @param [Boolean] force
436
- # If set, any workstations in the workstation configuration are also deleted.
437
- # Otherwise, the request works only if the workstation configuration has no
438
- # workstations.
437
+ # Optional. If set, any workstations in the workstation configuration are also
438
+ # deleted. Otherwise, the request works only if the workstation configuration
439
+ # has no workstations.
439
440
  # @param [Boolean] validate_only
440
- # If set, validate the request and preview the review, but do not actually apply
441
- # it.
441
+ # Optional. If set, validate the request and preview the review, but do not
442
+ # actually apply it.
442
443
  # @param [String] fields
443
444
  # Selector specifying which fields to include in a partial response.
444
445
  # @param [String] quota_user
@@ -548,9 +549,9 @@ module Google
548
549
  # @param [String] parent
549
550
  # Required. Parent resource name.
550
551
  # @param [Fixnum] page_size
551
- # Maximum number of items to return.
552
+ # Optional. Maximum number of items to return.
552
553
  # @param [String] page_token
553
- # next_page_token value returned from a previous List request, if any.
554
+ # Optional. next_page_token value returned from a previous List request, if any.
554
555
  # @param [String] fields
555
556
  # Selector specifying which fields to include in a partial response.
556
557
  # @param [String] quota_user
@@ -585,9 +586,9 @@ module Google
585
586
  # @param [String] parent
586
587
  # Required. Parent resource name.
587
588
  # @param [Fixnum] page_size
588
- # Maximum number of items to return.
589
+ # Optional. Maximum number of items to return.
589
590
  # @param [String] page_token
590
- # next_page_token value returned from a previous List request, if any.
591
+ # Optional. next_page_token value returned from a previous List request, if any.
591
592
  # @param [String] fields
592
593
  # Selector specifying which fields to include in a partial response.
593
594
  # @param [String] quota_user
@@ -619,17 +620,18 @@ module Google
619
620
 
620
621
  # Updates an existing workstation configuration.
621
622
  # @param [String] name
622
- # Full name of this resource.
623
+ # Full name of this workstation configuration.
623
624
  # @param [Google::Apis::WorkstationsV1beta::WorkstationConfig] workstation_config_object
624
625
  # @param [Boolean] allow_missing
625
- # If set and the workstation configuration is not found, a new workstation
626
- # configuration will be created. In this situation, update_mask is ignored.
626
+ # Optional. If set and the workstation configuration is not found, a new
627
+ # workstation configuration will be created. In this situation, update_mask is
628
+ # ignored.
627
629
  # @param [String] update_mask
628
630
  # Required. Mask specifying which fields in the workstation configuration should
629
631
  # be updated.
630
632
  # @param [Boolean] validate_only
631
- # If set, validate the request and preview the review, but do not actually apply
632
- # it.
633
+ # Optional. If set, validate the request and preview the review, but do not
634
+ # actually apply it.
633
635
  # @param [String] fields
634
636
  # Selector specifying which fields to include in a partial response.
635
637
  # @param [String] quota_user
@@ -743,8 +745,8 @@ module Google
743
745
  # Required. Parent resource name.
744
746
  # @param [Google::Apis::WorkstationsV1beta::Workstation] workstation_object
745
747
  # @param [Boolean] validate_only
746
- # If set, validate the request and preview the review, but do not actually apply
747
- # it.
748
+ # Optional. If set, validate the request and preview the review, but do not
749
+ # actually apply it.
748
750
  # @param [String] workstation_id
749
751
  # Required. ID to use for the workstation.
750
752
  # @param [String] fields
@@ -782,11 +784,11 @@ module Google
782
784
  # @param [String] name
783
785
  # Required. Name of the workstation to delete.
784
786
  # @param [String] etag
785
- # If set, the request will be rejected if the latest version of the workstation
786
- # on the server does not have this ETag.
787
+ # Optional. If set, the request will be rejected if the latest version of the
788
+ # workstation on the server does not have this ETag.
787
789
  # @param [Boolean] validate_only
788
- # If set, validate the request and preview the review, but do not actually apply
789
- # it.
790
+ # Optional. If set, validate the request and preview the review, but do not
791
+ # actually apply it.
790
792
  # @param [String] fields
791
793
  # Selector specifying which fields to include in a partial response.
792
794
  # @param [String] quota_user
@@ -930,9 +932,9 @@ module Google
930
932
  # @param [String] parent
931
933
  # Required. Parent resource name.
932
934
  # @param [Fixnum] page_size
933
- # Maximum number of items to return.
935
+ # Optional. Maximum number of items to return.
934
936
  # @param [String] page_token
935
- # next_page_token value returned from a previous List request, if any.
937
+ # Optional. next_page_token value returned from a previous List request, if any.
936
938
  # @param [String] fields
937
939
  # Selector specifying which fields to include in a partial response.
938
940
  # @param [String] quota_user
@@ -967,9 +969,9 @@ module Google
967
969
  # @param [String] parent
968
970
  # Required. Parent resource name.
969
971
  # @param [Fixnum] page_size
970
- # Maximum number of items to return.
972
+ # Optional. Maximum number of items to return.
971
973
  # @param [String] page_token
972
- # next_page_token value returned from a previous List request, if any.
974
+ # Optional. next_page_token value returned from a previous List request, if any.
973
975
  # @param [String] fields
974
976
  # Selector specifying which fields to include in a partial response.
975
977
  # @param [String] quota_user
@@ -1001,17 +1003,18 @@ module Google
1001
1003
 
1002
1004
  # Updates an existing workstation.
1003
1005
  # @param [String] name
1004
- # Full name of this resource.
1006
+ # Full name of this workstation.
1005
1007
  # @param [Google::Apis::WorkstationsV1beta::Workstation] workstation_object
1006
1008
  # @param [Boolean] allow_missing
1007
- # If set and the workstation configuration is not found, a new workstation
1008
- # configuration is created. In this situation, update_mask is ignored.
1009
+ # Optional. If set and the workstation configuration is not found, a new
1010
+ # workstation configuration is created. In this situation, update_mask is
1011
+ # ignored.
1009
1012
  # @param [String] update_mask
1010
1013
  # Required. Mask specifying which fields in the workstation configuration should
1011
1014
  # be updated.
1012
1015
  # @param [Boolean] validate_only
1013
- # If set, validate the request and preview the review, but do not actually apply
1014
- # it.
1016
+ # Optional. If set, validate the request and preview the review, but do not
1017
+ # actually apply it.
1015
1018
  # @param [String] fields
1016
1019
  # Selector specifying which fields to include in a partial response.
1017
1020
  # @param [String] quota_user
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-workstations_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.14.0
4
+ version: 0.15.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-25 00:00:00.000000000 Z
11
+ date: 2023-08-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workstations_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-workstations_v1beta/v0.14.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-workstations_v1beta/v0.15.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workstations_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []