WorkstationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations.
Attributes
Name | Description |
name |
str
Full name of this resource. |
display_name |
str
Human-readable name for this resource. |
uid |
str
Output only. A system-assigned unique identified for this resource. |
reconciling |
bool
Output only. Indicates whether this resource is currently being updated to match its intended state. |
annotations |
MutableMapping[str, str]
Client-specified annotations. |
labels |
MutableMapping[str, str]
Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this resource was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this resource was most recently updated. |
delete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this resource was soft-deleted. |
etag |
str
Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. |
idle_timeout |
google.protobuf.duration_pb2.Duration
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. |
running_timeout |
google.protobuf.duration_pb2.Duration
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. |
host |
google.cloud.workstations_v1beta.types.WorkstationConfig.Host
Runtime host for the workstation. |
persistent_directories |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.PersistentDirectory]
Directories to persist across workstation sessions. |
container |
google.cloud.workstations_v1beta.types.WorkstationConfig.Container
Container that will be run for each workstation using this configuration when that workstation is started. |
encryption_key |
google.cloud.workstations_v1beta.types.WorkstationConfig.CustomerEncryptionKey
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. |
degraded |
bool
Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the conditions
field.
|
conditions |
MutableSequence[google.rpc.status_pb2.Status]
Output only. Status conditions describing the current resource state. |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
Container
Container(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A Docker container.
CustomerEncryptionKey
CustomerEncryptionKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A customer-managed encryption key for the Compute Engine resources of this workstation configuration.
Host
Host(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Runtime host for a workstation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
PersistentDirectory
PersistentDirectory(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A directory to persist across workstation sessions.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields