public final class WorkstationConfig extends GeneratedMessageV3 implements WorkstationConfigOrBuilderA workstation configuration resource in the Cloud Workstations API.
Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.
Protobuf type google.cloud.workstations.v1beta.WorkstationConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WorkstationConfigImplements
WorkstationConfigOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONTAINER_FIELD_NUMBER
public static final int CONTAINER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DEGRADED_FIELD_NUMBER
public static final int DEGRADED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENABLE_AUDIT_AGENT_FIELD_NUMBER
public static final int ENABLE_AUDIT_AGENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENCRYPTION_KEY_FIELD_NUMBER
public static final int ENCRYPTION_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EPHEMERAL_DIRECTORIES_FIELD_NUMBER
public static final int EPHEMERAL_DIRECTORIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IDLE_TIMEOUT_FIELD_NUMBER
public static final int IDLE_TIMEOUT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PERSISTENT_DIRECTORIES_FIELD_NUMBER
public static final int PERSISTENT_DIRECTORIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
READINESS_CHECKS_FIELD_NUMBER
public static final int READINESS_CHECKS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REPLICA_ZONES_FIELD_NUMBER
public static final int REPLICA_ZONES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RUNNING_TIMEOUT_FIELD_NUMBER
public static final int RUNNING_TIMEOUT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static WorkstationConfig getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static WorkstationConfig.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder |
|
newBuilder(WorkstationConfig prototype)
public static WorkstationConfig.Builder newBuilder(WorkstationConfig prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
WorkstationConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder |
|
parseDelimitedFrom(InputStream input)
public static WorkstationConfig parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static WorkstationConfig parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static WorkstationConfig parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static WorkstationConfig parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static WorkstationConfig parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static WorkstationConfig parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<WorkstationConfig> parser()| Returns | |
|---|---|
| Type | Description |
Parser<WorkstationConfig> |
|
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsLabels(String key)
public boolean containsLabels(String key)Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
public int getAnnotationsCount()Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getConditions(int index)
public Status getConditions(int index)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
|
getConditionsCount()
public int getConditionsCount()Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getConditionsList()
public List<Status> getConditionsList()Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<com.google.rpc.Status> |
|
getConditionsOrBuilder(int index)
public StatusOrBuilder getConditionsOrBuilder(int index)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getConditionsOrBuilderList()
public List<? extends StatusOrBuilder> getConditionsOrBuilderList()Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.rpc.StatusOrBuilder> |
|
getContainer()
public WorkstationConfig.Container getContainer()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Container |
The container. |
getContainerOrBuilder()
public WorkstationConfig.ContainerOrBuilder getContainerOrBuilder()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ContainerOrBuilder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public WorkstationConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig |
|
getDegraded()
public boolean getDegraded()Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
bool degraded = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The degraded. |
getDeleteTime()
public Timestamp getDeleteTime()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public String getDisplayName()Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEnableAuditAgent()
public boolean getEnableAuditAgent() Optional. Whether to enable Linux auditd logging on the workstation. When
enabled, a service account must also be specified that has
logging.buckets.write permission on the project. Operating system audit
logging is distinct from Cloud Audit
Logs.
bool enable_audit_agent = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableAuditAgent. |
getEncryptionKey()
public WorkstationConfig.CustomerEncryptionKey getEncryptionKey()Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK).
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 might be lost.
If the encryption key is revoked, the workstation session automatically stops within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey |
The encryptionKey. |
getEncryptionKeyOrBuilder()
public WorkstationConfig.CustomerEncryptionKeyOrBuilder getEncryptionKeyOrBuilder()Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK).
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 might be lost.
If the encryption key is revoked, the workstation session automatically stops within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKeyOrBuilder |
|
getEphemeralDirectories(int index)
public WorkstationConfig.EphemeralDirectory getEphemeralDirectories(int index)Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.EphemeralDirectory |
|
getEphemeralDirectoriesCount()
public int getEphemeralDirectoriesCount()Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getEphemeralDirectoriesList()
public List<WorkstationConfig.EphemeralDirectory> getEphemeralDirectoriesList()Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<EphemeralDirectory> |
|
getEphemeralDirectoriesOrBuilder(int index)
public WorkstationConfig.EphemeralDirectoryOrBuilder getEphemeralDirectoriesOrBuilder(int index)Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.EphemeralDirectoryOrBuilder |
|
getEphemeralDirectoriesOrBuilderList()
public List<? extends WorkstationConfig.EphemeralDirectoryOrBuilder> getEphemeralDirectoriesOrBuilderList()Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectoryOrBuilder> |
|
getEtag()
public String getEtag()Optional. 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.
string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public ByteString getEtagBytes()Optional. 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.
string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getHost()
public WorkstationConfig.Host getHost()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host |
The host. |
getHostOrBuilder()
public WorkstationConfig.HostOrBuilder getHostOrBuilder()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.HostOrBuilder |
|
getIdleTimeout()
public Duration getIdleTimeout()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic.
A value of "0s" indicates that Cloud Workstations VMs created with this
configuration should never time out due to idleness.
Provide
duration
terminated by s for seconds—for example, "7200s" (2 hours).
The default is "1200s" (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The idleTimeout. |
getIdleTimeoutOrBuilder()
public DurationOrBuilder getIdleTimeoutOrBuilder()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic.
A value of "0s" indicates that Cloud Workstations VMs created with this
configuration should never time out due to idleness.
Provide
duration
terminated by s for seconds—for example, "7200s" (2 hours).
The default is "1200s" (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public String getName()Full name of this workstation configuration.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Full name of this workstation configuration.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<WorkstationConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<WorkstationConfig> |
|
getPersistentDirectories(int index)
public WorkstationConfig.PersistentDirectory getPersistentDirectories(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectory |
|
getPersistentDirectoriesCount()
public int getPersistentDirectoriesCount()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getPersistentDirectoriesList()
public List<WorkstationConfig.PersistentDirectory> getPersistentDirectoriesList()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<PersistentDirectory> |
|
getPersistentDirectoriesOrBuilder(int index)
public WorkstationConfig.PersistentDirectoryOrBuilder getPersistentDirectoriesOrBuilder(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectoryOrBuilder |
|
getPersistentDirectoriesOrBuilderList()
public List<? extends WorkstationConfig.PersistentDirectoryOrBuilder> getPersistentDirectoriesOrBuilderList()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectoryOrBuilder> |
|
getReadinessChecks(int index)
public WorkstationConfig.ReadinessCheck getReadinessChecks(int index)Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheck |
|
getReadinessChecksCount()
public int getReadinessChecksCount()Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getReadinessChecksList()
public List<WorkstationConfig.ReadinessCheck> getReadinessChecksList()Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<ReadinessCheck> |
|
getReadinessChecksOrBuilder(int index)
public WorkstationConfig.ReadinessCheckOrBuilder getReadinessChecksOrBuilder(int index)Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheckOrBuilder |
|
getReadinessChecksOrBuilderList()
public List<? extends WorkstationConfig.ReadinessCheckOrBuilder> getReadinessChecksOrBuilderList()Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheckOrBuilder> |
|
getReconciling()
public boolean getReconciling()Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.
bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The reconciling. |
getReplicaZones(int index)
public String getReplicaZones(int index) Optional. Immutable. Specifies the zones used to replicate the VM and disk
resources within the region. If set, exactly two zones within the
workstation cluster's region must be specified—for example,
['us-central1-a', 'us-central1-f']. If this field is empty, two default
zones within the region are used.
Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The replicaZones at the given index. |
getReplicaZonesBytes(int index)
public ByteString getReplicaZonesBytes(int index) Optional. Immutable. Specifies the zones used to replicate the VM and disk
resources within the region. If set, exactly two zones within the
workstation cluster's region must be specified—for example,
['us-central1-a', 'us-central1-f']. If this field is empty, two default
zones within the region are used.
Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the replicaZones at the given index. |
getReplicaZonesCount()
public int getReplicaZonesCount() Optional. Immutable. Specifies the zones used to replicate the VM and disk
resources within the region. If set, exactly two zones within the
workstation cluster's region must be specified—for example,
['us-central1-a', 'us-central1-f']. If this field is empty, two default
zones within the region are used.
Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int |
The count of replicaZones. |
getReplicaZonesList()
public ProtocolStringList getReplicaZonesList() Optional. Immutable. Specifies the zones used to replicate the VM and disk
resources within the region. If set, exactly two zones within the
workstation cluster's region must be specified—for example,
['us-central1-a', 'us-central1-f']. If this field is empty, two default
zones within the region are used.
Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the replicaZones. |
getRunningTimeout()
public Duration getRunningTimeout()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle.
Provide duration terminated by s for seconds—for example, "54000s"
(15 hours). Defaults to "43200s" (12 hours). A value of "0s" indicates
that workstations using this configuration should never time out. If
encryption_key
is set, it must be greater than "0s" and less than
"86400s" (24 hours).
Warning: A value of "0s" indicates that Cloud Workstations VMs created
with this configuration have no maximum running time. This is strongly
discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The runningTimeout. |
getRunningTimeoutOrBuilder()
public DurationOrBuilder getRunningTimeoutOrBuilder()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle.
Provide duration terminated by s for seconds—for example, "54000s"
(15 hours). Defaults to "43200s" (12 hours). A value of "0s" indicates
that workstations using this configuration should never time out. If
encryption_key
is set, it must be greater than "0s" and less than
"86400s" (24 hours).
Warning: A value of "0s" indicates that Cloud Workstations VMs created
with this configuration have no maximum running time. This is strongly
discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getUid()
public String getUid()Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The uid. |
getUidBytes()
public ByteString getUidBytes()Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasContainer()
public boolean hasContainer()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the container field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDeleteTime()
public boolean hasDeleteTime()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deleteTime field is set. |
hasEncryptionKey()
public boolean hasEncryptionKey()Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK).
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 might be lost.
If the encryption key is revoked, the workstation session automatically stops within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionKey field is set. |
hasHost()
public boolean hasHost()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the host field is set. |
hasIdleTimeout()
public boolean hasIdleTimeout()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic.
A value of "0s" indicates that Cloud Workstations VMs created with this
configuration should never time out due to idleness.
Provide
duration
terminated by s for seconds—for example, "7200s" (2 hours).
The default is "1200s" (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the idleTimeout field is set. |
hasRunningTimeout()
public boolean hasRunningTimeout()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle.
Provide duration terminated by s for seconds—for example, "54000s"
(15 hours). Defaults to "43200s" (12 hours). A value of "0s" indicates
that workstations using this configuration should never time out. If
encryption_key
is set, it must be greater than "0s" and less than
"86400s" (24 hours).
Warning: A value of "0s" indicates that Cloud Workstations VMs created
with this configuration have no maximum running time. This is strongly
discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the runningTimeout field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public WorkstationConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkstationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public WorkstationConfig.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|