Cloud Workstations v1 API - Class WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk (1.5.0) 

public sealed class WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk : IMessage<WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk>, IEquatable<WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk>, IDeepCloneable<WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Workstations v1 API class WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk.

A Persistent Directory backed by a Compute Engine regional persistent disk. The [persistent_directories][google.cloud.workstations.v1.WorkstationConfig.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.

Inheritance

object > WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk

Namespace

Google.Cloud.Workstations.V1

Assembly

Google.Cloud.Workstations.V1.dll

Constructors

GceRegionalPersistentDisk()

public GceRegionalPersistentDisk()

GceRegionalPersistentDisk(GceRegionalPersistentDisk)

public GceRegionalPersistentDisk(WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk other)
Parameter
Name Description
other WorkstationConfigTypesPersistentDirectoryTypesGceRegionalPersistentDisk

Properties

ArchiveTimeout

public Duration ArchiveTimeout { get; set; }

Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot.

A value of "0s" indicates that the disk will never be archived.

Property Value
Type Description
Duration

DiskType

public string DiskType { get; set; }

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

Property Value
Type Description
string

FsType

public string FsType { get; set; }

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][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.source_snapshot] is set. Defaults to "ext4".

Property Value
Type Description
string

MaxSizeGb

public int MaxSizeGb { get; set; }

Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to unlimited if not set.

Property Value
Type Description
int

ReclaimPolicy

public WorkstationConfig.Types.PersistentDirectory.Types.GceRegionalPersistentDisk.Types.ReclaimPolicy ReclaimPolicy { get; set; }

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

Property Value
Type Description
WorkstationConfigTypesPersistentDirectoryTypesGceRegionalPersistentDiskTypesReclaimPolicy

SizeGb

public int SizeGb { get; set; }

Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if [source_snapshot][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.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][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.disk_type] must be "pd-balanced" or "pd-ssd".

Property Value
Type Description
int

SourceSnapshot

public string SourceSnapshot { get; set; }

Optional. Name of the snapshot to use as the source for the disk. If set, [size_gb][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.size_gb] and [fs_type][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.fs_type] must be empty. Must be formatted as ext4 file system with no partitions.

Property Value
Type Description
string