google-apis-workstations_v1beta 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19a2a0b3b8e0f3a6b807f5d635944a3a584c42b806a6faf511f87e408ebc37a6
-  data.tar.gz: 6f8c2506c8ae564098ccd96e01445822eb6a1fca4bbe6855b26e2a91a8e32b18
+  metadata.gz: ddbba4de95302002642d5362ab163b19cfdcd5c96657d964229d535e88c054d0
+  data.tar.gz: ee46f81d156dcee82288a2b640410fa69828bb3cfd958959d97600e5164993fb
 SHA512:
-  metadata.gz: 13d56442d066357387966f0c8b41de0eaad66e3cf22fe5126946a9a7e4056664c730ef3732d291463226bceaf0b9bb6008ba4248974e10065094eadf5a103f66
-  data.tar.gz: 3f213cbc33eae3b7a142ddb865cb5adcd2a4a4e103e87c1550f7300438f3646b462093840707f202677164136361335a5173cf72c76d21cbf5ff39eda123ab13
+  metadata.gz: d95610de59b50657b96b25a6e03f0697fed370db0919cec403b183dc15c76cec669ee51bfb349df970f00547e465cd4a7f29a9d4fb2d712d07dded162d74d80d
+  data.tar.gz: 1e5e14c38159172823eefa9abbce3894a545cc8f093d57fdbe0469b1f6edf8338b8cad7dd0718d0c5df3d77ae758b23abf87eb2b4f94f224b24112818ceb5c81

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-workstations_v1beta
 
+### v0.13.0 (2023-06-11)
+
+* Regenerated from discovery document revision 20230531
+
+### v0.12.0 (2023-05-21)
+
+* Regenerated from discovery document revision 20230510
+
 ### v0.11.0 (2023-05-07)
 
 * Regenerated from discovery document revision 20230501

data/lib/google/apis/workstations_v1beta/classes.rb

@@ -227,8 +227,14 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :env
       
-        # 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
         # Corresponds to the JSON property `image`
         # @return [String]
         attr_accessor :image
@@ -258,13 +264,17 @@ module Google
         end
       end
       
-      # A customer-managed encryption key for the Compute Engine resources of this
-      # workstation configuration.
+      # A customer-managed encryption key (CMEK) for the Compute Engine resources of
+      # the associated workstation configuration. Specify the name of your Cloud KMS
+      # encryption key and the default service account. We recommend that you use a
+      # separate service account and follow [Cloud KMS best practices](https://cloud.
+      # google.com/kms/docs/separation-of-duties).
       class CustomerEncryptionKey
         include Google::Apis::Core::Hashable
       
         # Immutable. The name of the Google Cloud KMS encryption key. For example, `
         # projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`.
+        # The key must be in the same region as the workstation configuration.
         # Corresponds to the JSON property `kmsKey`
         # @return [String]
         attr_accessor :kms_key
@@ -373,7 +383,8 @@ module Google
         # @return [Array<Google::Apis::WorkstationsV1beta::Accelerator>]
         attr_accessor :accelerators
       
-        # 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.
         # Corresponds to the JSON property `bootDiskSizeGb`
         # @return [Fixnum]
         attr_accessor :boot_disk_size_gb
@@ -383,18 +394,27 @@ module Google
         # @return [Google::Apis::WorkstationsV1beta::GceConfidentialInstanceConfig]
         attr_accessor :confidential_instance_config
       
-        # 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).
         # Corresponds to the JSON property `disablePublicIpAddresses`
         # @return [Boolean]
         attr_accessor :disable_public_ip_addresses
         alias_method :disable_public_ip_addresses?, :disable_public_ip_addresses
       
-        # 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).
         # Corresponds to the JSON property `machineType`
         # @return [String]
         attr_accessor :machine_type
       
-        # 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.
         # Corresponds to the JSON property `poolSize`
         # @return [Fixnum]
         attr_accessor :pool_size
@@ -405,10 +425,17 @@ module Google
         # @return [Fixnum]
         attr_accessor :pooled_instances
       
-        # 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.
         # Corresponds to the JSON property `serviceAccount`
         # @return [String]
         attr_accessor :service_account
@@ -418,7 +445,11 @@ module Google
         # @return [Google::Apis::WorkstationsV1beta::GceShieldedInstanceConfig]
         attr_accessor :shielded_instance_config
       
-        # 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).
         # Corresponds to the JSON property `tags`
         # @return [Array<String>]
         attr_accessor :tags
@@ -442,30 +473,39 @@ module Google
         end
       end
       
-      # A PersistentDirectory backed by a Compute Engine regional persistent disk.
+      # A PersistentDirectory backed by a Compute Engine regional persistent disk. The
+      # `persistentDirectories[]` field is repeated, but it may contain only one entry.
+      # It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/
+      # persistent-disks) that mounts to the workstation VM at `/home` when the
+      # session starts and detaches when the session ends. If this field is empty,
+      # workstations created with this configuration do not have a persistent home
+      # directory.
       class GceRegionalPersistentDisk
         include Google::Apis::Core::Hashable
       
-        # 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`.
         # Corresponds to the JSON property `diskType`
         # @return [String]
         attr_accessor :disk_type
       
         # 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.
+        # set. Defaults to `ext4`.
         # Corresponds to the JSON property `fsType`
         # @return [String]
         attr_accessor :fs_type
       
-        # 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`.
         # Corresponds to the JSON property `reclaimPolicy`
         # @return [String]
         attr_accessor :reclaim_policy
       
-        # 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`.
         # Corresponds to the JSON property `sizeGb`
         # @return [Fixnum]
         attr_accessor :size_gb
@@ -923,7 +963,13 @@ module Google
       class PersistentDirectory
         include Google::Apis::Core::Hashable
       
-        # A PersistentDirectory backed by a Compute Engine regional persistent disk.
+        # A PersistentDirectory backed by a Compute Engine regional persistent disk. The
+        # `persistentDirectories[]` field is repeated, but it may contain only one entry.
+        # It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/
+        # persistent-disks) that mounts to the workstation VM at `/home` when the
+        # session starts and detaches when the session ends. If this field is empty,
+        # workstations created with this configuration do not have a persistent home
+        # directory.
         # Corresponds to the JSON property `gcePd`
         # @return [Google::Apis::WorkstationsV1beta::GceRegionalPersistentDisk]
         attr_accessor :gce_pd
@@ -1365,7 +1411,7 @@ module Google
         # @return [String]
         attr_accessor :state
       
-        # Output only. A system-assigned unique identified for this resource.
+        # Output only. A system-assigned unique identifier for this resource.
         # Corresponds to the JSON property `uid`
         # @return [String]
         attr_accessor :uid
@@ -1485,7 +1531,7 @@ module Google
         # @return [String]
         attr_accessor :subnetwork
       
-        # Output only. A system-assigned unique identified for this resource.
+        # Output only. A system-assigned unique identifier for this resource.
         # Corresponds to the JSON property `uid`
         # @return [String]
         attr_accessor :uid
@@ -1520,7 +1566,7 @@ module Google
         end
       end
       
-      # A set of configuration options describing how a workstation will be run.
+      # A set of configuration options that describe how a workstation runs.
       # Workstation configurations are intended to be shared across multiple
       # workstations.
       class WorkstationConfig
@@ -1564,8 +1610,8 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # Whether to enable linux auditd logging on the workstation. When enabled, a
-        # service account must also be specified that has logging.buckets.write
+        # 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).
         # Corresponds to the JSON property `enableAuditAgent`
@@ -1573,8 +1619,11 @@ module Google
         attr_accessor :enable_audit_agent
         alias_method :enable_audit_agent?, :enable_audit_agent
       
-        # A customer-managed encryption key for the Compute Engine resources of this
-        # workstation configuration.
+        # A customer-managed encryption key (CMEK) for the Compute Engine resources of
+        # the associated workstation configuration. Specify the name of your Cloud KMS
+        # encryption key and the default service account. We recommend that you use a
+        # separate service account and follow [Cloud KMS best practices](https://cloud.
+        # google.com/kms/docs/separation-of-duties).
         # Corresponds to the JSON property `encryptionKey`
         # @return [Google::Apis::WorkstationsV1beta::CustomerEncryptionKey]
         attr_accessor :encryption_key
@@ -1590,9 +1639,12 @@ module Google
         # @return [Google::Apis::WorkstationsV1beta::Host]
         attr_accessor :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).
         # Corresponds to the JSON property `idleTimeout`
         # @return [String]
         attr_accessor :idle_timeout
@@ -1627,15 +1679,24 @@ module Google
         attr_accessor :reconciling
         alias_method :reconciling?, :reconciling
       
-        # 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.
         # Corresponds to the JSON property `runningTimeout`
         # @return [String]
         attr_accessor :running_timeout
       
-        # Output only. A system-assigned unique identified for this resource.
+        # Output only. A system-assigned unique identifier for this resource.
         # Corresponds to the JSON property `uid`
         # @return [String]
         attr_accessor :uid

data/lib/google/apis/workstations_v1beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module WorkstationsV1beta
       # Version of the google-apis-workstations_v1beta gem
-      GEM_VERSION = "0.11.0"
+      GEM_VERSION = "0.13.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230501"
+      REVISION = "20230531"
     end
   end
 end

data/lib/google/apis/workstations_v1beta/service.rb

@@ -22,7 +22,7 @@ module Google
     module WorkstationsV1beta
       # Cloud Workstations API
       #
-      # 
+      # Allows administrators to create managed developer environments in the cloud.
       #
       # @example
       #    require 'google/apis/workstations_v1beta'

data/lib/google/apis/workstations_v1beta.rb

@@ -21,7 +21,7 @@ module Google
   module Apis
     # Cloud Workstations API
     #
-    # 
+    # Allows administrators to create managed developer environments in the cloud.
     #
     # @see https://cloud.google.com/workstations
     module WorkstationsV1beta

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-workstations_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-14 00:00:00.000000000 Z
+date: 2023-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workstations_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-workstations_v1beta/v0.11.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-workstations_v1beta/v0.13.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workstations_v1beta
 post_install_message: 
 rdoc_options: []