Class: Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory

Inherits:

Object

Object
Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/workstations/v1/workstations.rb

Overview

A directory to persist across workstation sessions.

Defined Under Namespace

Classes: GceRegionalPersistentDisk

Instance Attribute Summary collapse

#gce_pd ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk
A PersistentDirectory backed by a Compute Engine persistent disk.
#mount_path ⇒ ::String
Optional.

Instance Attribute Details

#gce_pd ⇒ `::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk`

Returns A PersistentDirectory backed by a Compute Engine persistent disk.

Returns:

(::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk) —
A PersistentDirectory backed by a Compute Engine persistent disk.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 435

class PersistentDirectory
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A PersistentDirectory backed by a Compute Engine regional persistent
  # disk. The
  # {::Google::Cloud::Workstations::V1::WorkstationConfig#persistent_directories persistent_directories}
  # 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.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. The GB capacity of a persistent home directory for each
  #     workstation created with this configuration. Must be empty if
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk#source_snapshot source_snapshot}
  #     is set.
  #
  #     Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`.
  #     Defaults to `200`. If less than `200` GB, the
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk#disk_type disk_type}
  #     must be
  #     `"pd-balanced"` or `"pd-ssd"`.
  # @!attribute [rw] fs_type
  #   @return [::String]
  #     Optional. Type of file system that the disk should be formatted with.
  #     The workstation image must support this file system type. Must be empty
  #     if
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk#source_snapshot source_snapshot}
  #     is set. Defaults to `"ext4"`.
  # @!attribute [rw] disk_type
  #   @return [::String]
  #     Optional. The [type of the persistent
  #     disk](https://cloud.google.com/compute/docs/disks#disk-types) for the
  #     home directory. Defaults to `"pd-standard"`.
  # @!attribute [rw] source_snapshot
  #   @return [::String]
  #     Optional. Name of the snapshot to use as the source for the disk. If
  #     set,
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk#size_gb size_gb}
  #     and
  #     {::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk#fs_type fs_type}
  #     must be empty.
  # @!attribute [rw] reclaim_policy
  #   @return [::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk::ReclaimPolicy]
  #     Optional. Whether the persistent disk should be deleted when the
  #     workstation is deleted. Valid values are `DELETE` and `RETAIN`.
  #     Defaults to `DELETE`.
  class GceRegionalPersistentDisk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Value representing what should happen to the disk after the workstation
    # is deleted.
    module ReclaimPolicy
      # Do not use.
      RECLAIM_POLICY_UNSPECIFIED = 0

      # Delete the persistent disk when deleting the workstation.
      DELETE = 1

      # Keep the persistent disk when deleting the workstation.
      # An administrator must manually delete the disk.
      RETAIN = 2
    end
  end
end

#mount_path ⇒ `::String`

Returns Optional. Location of this directory in the running workstation.