public sealed class WorkstationConfig : IMessage<WorkstationConfig>, IEquatable<WorkstationConfig>, IDeepCloneable<WorkstationConfig>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Workstations v1 API class WorkstationConfig.
A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations.
Implements
IMessageWorkstationConfig, IEquatableWorkstationConfig, IDeepCloneableWorkstationConfig, IBufferMessage, IMessageNamespace
Google.Cloud.Workstations.V1Assembly
Google.Cloud.Workstations.V1.dll
Constructors
WorkstationConfig()
public WorkstationConfig()WorkstationConfig(WorkstationConfig)
public WorkstationConfig(WorkstationConfig other)| Parameter | |
|---|---|
| Name | Description |
other | WorkstationConfig |
Properties
Annotations
public MapField<string, string> Annotations { get; }Client-specified annotations.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Conditions
public RepeatedField<Status> Conditions { get; }Output only. Status conditions describing the current resource state.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldStatus | |
Container
public WorkstationConfig.Types.Container Container { get; set; }Container that will be run for each workstation using this configuration when that workstation is started.
| Property Value | |
|---|---|
| Type | Description |
WorkstationConfigTypesContainer | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time when this resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Degraded
public bool Degraded { get; set; }Output only. Whether this resource is degraded, in which case it may
require user action to restore full functionality. See also the
conditions field.
| Property Value | |
|---|---|
| Type | Description |
bool | |
DeleteTime
public Timestamp DeleteTime { get; set; }Output only. Time when this resource was soft-deleted.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
DisplayName
public string DisplayName { get; set; }Human-readable name for this resource.
| Property Value | |
|---|---|
| Type | Description |
string | |
EncryptionKey
public WorkstationConfig.Types.CustomerEncryptionKey EncryptionKey { get; set; }Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key.
If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.
If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.
If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours.
Immutable after the workstation configuration is created.
| Property Value | |
|---|---|
| Type | Description |
WorkstationConfigTypesCustomerEncryptionKey | |
Etag
public string Etag { get; set; }Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
| Property Value | |
|---|---|
| Type | Description |
string | |
Host
public WorkstationConfig.Types.Host Host { get; set; }Runtime host for the workstation.
| Property Value | |
|---|---|
| Type | Description |
WorkstationConfigTypesHost | |
IdleTimeout
public Duration IdleTimeout { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
Labels
public MapField<string, string> Labels { get; }Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Name
public string Name { get; set; }Full name of this resource.
| Property Value | |
|---|---|
| Type | Description |
string | |
PersistentDirectories
public RepeatedField<WorkstationConfig.Types.PersistentDirectory> PersistentDirectories { get; }Directories to persist across workstation sessions.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldWorkstationConfigTypesPersistentDirectory | |
Reconciling
public bool Reconciling { get; set; }Output only. Indicates whether this resource is currently being updated to match its intended state.
| Property Value | |
|---|---|
| Type | Description |
bool | |
RunningTimeout
public Duration RunningTimeout { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
Uid
public string Uid { get; set; }Output only. A system-assigned unique identified for this resource.
| Property Value | |
|---|---|
| Type | Description |
string | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Time when this resource was most recently updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
WorkstationConfigName
public WorkstationConfigName WorkstationConfigName { get; set; }WorkstationConfigName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
WorkstationConfigName | |