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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workstations/v1/workstations.rb

Overview

A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a persistent disk 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.

Defined Under Namespace

Modules: ReclaimPolicy

Instance Attribute Summary collapse

Instance Attribute Details

#disk_type ⇒ ::String

Returns Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".

Returns:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 486

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

#fs_type ⇒ ::String

Returns 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 source_snapshot is set. Defaults to "ext4".

Returns:

  • (::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 source_snapshot is set. Defaults to "ext4".



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 486

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

#reclaim_policy ⇒ ::Google::Cloud::Workstations::V1::WorkstationConfig::PersistentDirectory::GceRegionalPersistentDisk::ReclaimPolicy

Returns Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.

Returns:



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 486

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

#size_gb ⇒ ::Integer

Returns Optional. 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 disk_type must be "pd-balanced" or "pd-ssd".

Returns:

  • (::Integer) —

    Optional. 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 disk_type must be "pd-balanced" or "pd-ssd".



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 486

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

#source_snapshot ⇒ ::String

Returns Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

Returns:

  • (::String) —

    Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 486

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