public static final class WorkstationConfig.Builder extends GeneratedMessageV3.Builder<WorkstationConfig.Builder> 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.v1.WorkstationConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkstationConfig.BuilderImplements
WorkstationConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllConditions(Iterable<? extends Status> values)
public WorkstationConfig.Builder addAllConditions(Iterable<? extends Status> values)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.rpc.Status> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addAllPersistentDirectories(Iterable<? extends WorkstationConfig.PersistentDirectory> values)
public WorkstationConfig.Builder addAllPersistentDirectories(Iterable<? extends WorkstationConfig.PersistentDirectory> values)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addAllReadinessChecks(Iterable<? extends WorkstationConfig.ReadinessCheck> values)
public WorkstationConfig.Builder addAllReadinessChecks(Iterable<? extends WorkstationConfig.ReadinessCheck> values)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.workstations.v1.WorkstationConfig.ReadinessCheck> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addAllReplicaZones(Iterable<String> values)
public WorkstationConfig.Builder addAllReplicaZones(Iterable<String> values) 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 |
values | Iterable<String>The replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
addConditions(Status value)
public WorkstationConfig.Builder addConditions(Status value)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addConditions(Status.Builder builderForValue)
public WorkstationConfig.Builder addConditions(Status.Builder builderForValue)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addConditions(int index, Status value)
public WorkstationConfig.Builder addConditions(int index, Status value)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addConditions(int index, Status.Builder builderForValue)
public WorkstationConfig.Builder addConditions(int index, Status.Builder builderForValue)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addConditionsBuilder()
public Status.Builder addConditionsBuilder()Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status.Builder | |
addConditionsBuilder(int index)
public Status.Builder addConditionsBuilder(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.Builder | |
addPersistentDirectories(WorkstationConfig.PersistentDirectory value)
public WorkstationConfig.Builder addPersistentDirectories(WorkstationConfig.PersistentDirectory value)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.PersistentDirectory |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addPersistentDirectories(WorkstationConfig.PersistentDirectory.Builder builderForValue)
public WorkstationConfig.Builder addPersistentDirectories(WorkstationConfig.PersistentDirectory.Builder builderForValue)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkstationConfig.PersistentDirectory.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addPersistentDirectories(int index, WorkstationConfig.PersistentDirectory value)
public WorkstationConfig.Builder addPersistentDirectories(int index, WorkstationConfig.PersistentDirectory value)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | WorkstationConfig.PersistentDirectory |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addPersistentDirectories(int index, WorkstationConfig.PersistentDirectory.Builder builderForValue)
public WorkstationConfig.Builder addPersistentDirectories(int index, WorkstationConfig.PersistentDirectory.Builder builderForValue)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | WorkstationConfig.PersistentDirectory.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addPersistentDirectoriesBuilder()
public WorkstationConfig.PersistentDirectory.Builder addPersistentDirectoriesBuilder()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectory.Builder | |
addPersistentDirectoriesBuilder(int index)
public WorkstationConfig.PersistentDirectory.Builder addPersistentDirectoriesBuilder(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectory.Builder | |
addReadinessChecks(WorkstationConfig.ReadinessCheck value)
public WorkstationConfig.Builder addReadinessChecks(WorkstationConfig.ReadinessCheck value)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.ReadinessCheck |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addReadinessChecks(WorkstationConfig.ReadinessCheck.Builder builderForValue)
public WorkstationConfig.Builder addReadinessChecks(WorkstationConfig.ReadinessCheck.Builder builderForValue)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkstationConfig.ReadinessCheck.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addReadinessChecks(int index, WorkstationConfig.ReadinessCheck value)
public WorkstationConfig.Builder addReadinessChecks(int index, WorkstationConfig.ReadinessCheck value)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | WorkstationConfig.ReadinessCheck |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addReadinessChecks(int index, WorkstationConfig.ReadinessCheck.Builder builderForValue)
public WorkstationConfig.Builder addReadinessChecks(int index, WorkstationConfig.ReadinessCheck.Builder builderForValue)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | WorkstationConfig.ReadinessCheck.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addReadinessChecksBuilder()
public WorkstationConfig.ReadinessCheck.Builder addReadinessChecksBuilder()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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheck.Builder | |
addReadinessChecksBuilder(int index)
public WorkstationConfig.ReadinessCheck.Builder addReadinessChecksBuilder(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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheck.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
addReplicaZones(String value)
public WorkstationConfig.Builder addReplicaZones(String value) 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 |
value | StringThe replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
addReplicaZonesBytes(ByteString value)
public WorkstationConfig.Builder addReplicaZonesBytes(ByteString value) 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 |
value | ByteStringThe bytes of the replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
build()
public WorkstationConfig build()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig | |
buildPartial()
public WorkstationConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig | |
clear()
public WorkstationConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearAnnotations()
public WorkstationConfig.Builder clearAnnotations()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearConditions()
public WorkstationConfig.Builder clearConditions()Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearContainer()
public WorkstationConfig.Builder clearContainer()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearCreateTime()
public WorkstationConfig.Builder clearCreateTime()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearDegraded()
public WorkstationConfig.Builder clearDegraded()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 |
WorkstationConfig.Builder | This builder for chaining. |
clearDeleteTime()
public WorkstationConfig.Builder clearDeleteTime()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 |
WorkstationConfig.Builder | |
clearDisplayName()
public WorkstationConfig.Builder clearDisplayName()Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
clearEncryptionKey()
public WorkstationConfig.Builder clearEncryptionKey()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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearEtag()
public WorkstationConfig.Builder clearEtag()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 |
WorkstationConfig.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public WorkstationConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearHost()
public WorkstationConfig.Builder clearHost()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearIdleTimeout()
public WorkstationConfig.Builder clearIdleTimeout()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 |
WorkstationConfig.Builder | |
clearLabels()
public WorkstationConfig.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearName()
public WorkstationConfig.Builder clearName()Full name of this workstation configuration.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WorkstationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearPersistentDirectories()
public WorkstationConfig.Builder clearPersistentDirectories()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearReadinessChecks()
public WorkstationConfig.Builder clearReadinessChecks()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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
clearReconciling()
public WorkstationConfig.Builder clearReconciling()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 |
WorkstationConfig.Builder | This builder for chaining. |
clearReplicaZones()
public WorkstationConfig.Builder clearReplicaZones() 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 |
WorkstationConfig.Builder | This builder for chaining. |
clearRunningTimeout()
public WorkstationConfig.Builder clearRunningTimeout()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 |
WorkstationConfig.Builder | |
clearUid()
public WorkstationConfig.Builder clearUid()Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
clearUpdateTime()
public WorkstationConfig.Builder clearUpdateTime()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 |
WorkstationConfig.Builder | |
clone()
public WorkstationConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
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 | |
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 | |
getConditionsBuilder(int index)
public Status.Builder getConditionsBuilder(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.Builder | |
getConditionsBuilderList()
public List<Status.Builder> getConditionsBuilderList()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.Builder> | |
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.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Container | The container. |
getContainerBuilder()
public WorkstationConfig.Container.Builder getContainerBuilder()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Container.Builder | |
getContainerOrBuilder()
public WorkstationConfig.ContainerOrBuilder getContainerOrBuilder()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
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. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()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 |
Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | The encryptionKey. |
getEncryptionKeyBuilder()
public WorkstationConfig.CustomerEncryptionKey.Builder getEncryptionKeyBuilder()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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKeyOrBuilder | |
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.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host | The host. |
getHostBuilder()
public WorkstationConfig.Host.Builder getHostBuilder()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.Builder | |
getHostOrBuilder()
public WorkstationConfig.HostOrBuilder getHostOrBuilder()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.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. |
getIdleTimeoutBuilder()
public Duration.Builder getIdleTimeoutBuilder()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 |
Builder | |
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 | |
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,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. |
getPersistentDirectories(int index)
public WorkstationConfig.PersistentDirectory getPersistentDirectories(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectory | |
getPersistentDirectoriesBuilder(int index)
public WorkstationConfig.PersistentDirectory.Builder getPersistentDirectoriesBuilder(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.PersistentDirectory.Builder | |
getPersistentDirectoriesBuilderList()
public List<WorkstationConfig.PersistentDirectory.Builder> getPersistentDirectoriesBuilderList()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getPersistentDirectoriesCount()
public int getPersistentDirectoriesCount()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.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.v1.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.v1.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.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1.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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheck | |
getReadinessChecksBuilder(int index)
public WorkstationConfig.ReadinessCheck.Builder getReadinessChecksBuilder(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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.ReadinessCheck.Builder | |
getReadinessChecksBuilderList()
public List<WorkstationConfig.ReadinessCheck.Builder> getReadinessChecksBuilderList()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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
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.v1.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.v1.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.v1.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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1.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. |
getRunningTimeoutBuilder()
public Duration.Builder getRunningTimeoutBuilder()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 |
Builder | |
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 | |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder | |
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.v1.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.v1.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.v1.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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeContainer(WorkstationConfig.Container value)
public WorkstationConfig.Builder mergeContainer(WorkstationConfig.Container value)Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.Container |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeCreateTime(Timestamp value)
public WorkstationConfig.Builder mergeCreateTime(Timestamp value)Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeDeleteTime(Timestamp value)
public WorkstationConfig.Builder mergeDeleteTime(Timestamp value)Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeEncryptionKey(WorkstationConfig.CustomerEncryptionKey value)
public WorkstationConfig.Builder mergeEncryptionKey(WorkstationConfig.CustomerEncryptionKey value)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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeFrom(WorkstationConfig other)
public WorkstationConfig.Builder mergeFrom(WorkstationConfig other)| Parameter | |
|---|---|
| Name | Description |
other | WorkstationConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkstationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public WorkstationConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeHost(WorkstationConfig.Host value)
public WorkstationConfig.Builder mergeHost(WorkstationConfig.Host value)Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.Host |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeIdleTimeout(Duration value)
public WorkstationConfig.Builder mergeIdleTimeout(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeRunningTimeout(Duration value)
public WorkstationConfig.Builder mergeRunningTimeout(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
mergeUpdateTime(Timestamp value)
public WorkstationConfig.Builder mergeUpdateTime(Timestamp value)Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
putAllAnnotations(Map<String,String> values)
public WorkstationConfig.Builder putAllAnnotations(Map<String,String> values)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
putAllLabels(Map<String,String> values)
public WorkstationConfig.Builder putAllLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
putAnnotations(String key, String value)
public WorkstationConfig.Builder putAnnotations(String key, String value)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
putLabels(String key, String value)
public WorkstationConfig.Builder putLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
removeAnnotations(String key)
public WorkstationConfig.Builder removeAnnotations(String key)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
removeConditions(int index)
public WorkstationConfig.Builder removeConditions(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 |
WorkstationConfig.Builder | |
removeLabels(String key)
public WorkstationConfig.Builder removeLabels(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 |
WorkstationConfig.Builder | |
removePersistentDirectories(int index)
public WorkstationConfig.Builder removePersistentDirectories(int index)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
removeReadinessChecks(int index)
public WorkstationConfig.Builder removeReadinessChecks(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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setConditions(int index, Status value)
public WorkstationConfig.Builder setConditions(int index, Status value)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setConditions(int index, Status.Builder builderForValue)
public WorkstationConfig.Builder setConditions(int index, Status.Builder builderForValue)Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setContainer(WorkstationConfig.Container value)
public WorkstationConfig.Builder setContainer(WorkstationConfig.Container value)Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.Container |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setContainer(WorkstationConfig.Container.Builder builderForValue)
public WorkstationConfig.Builder setContainer(WorkstationConfig.Container.Builder builderForValue)Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkstationConfig.Container.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setCreateTime(Timestamp value)
public WorkstationConfig.Builder setCreateTime(Timestamp value)Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public WorkstationConfig.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setDegraded(boolean value)
public WorkstationConfig.Builder setDegraded(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe degraded to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setDeleteTime(Timestamp value)
public WorkstationConfig.Builder setDeleteTime(Timestamp value)Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setDeleteTime(Timestamp.Builder builderForValue)
public WorkstationConfig.Builder setDeleteTime(Timestamp.Builder builderForValue)Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setDisplayName(String value)
public WorkstationConfig.Builder setDisplayName(String value)Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public WorkstationConfig.Builder setDisplayNameBytes(ByteString value)Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setEncryptionKey(WorkstationConfig.CustomerEncryptionKey value)
public WorkstationConfig.Builder setEncryptionKey(WorkstationConfig.CustomerEncryptionKey value)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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setEncryptionKey(WorkstationConfig.CustomerEncryptionKey.Builder builderForValue)
public WorkstationConfig.Builder setEncryptionKey(WorkstationConfig.CustomerEncryptionKey.Builder builderForValue)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.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkstationConfig.CustomerEncryptionKey.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setEtag(String value)
public WorkstationConfig.Builder setEtag(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public WorkstationConfig.Builder setEtagBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setHost(WorkstationConfig.Host value)
public WorkstationConfig.Builder setHost(WorkstationConfig.Host value)Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | WorkstationConfig.Host |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setHost(WorkstationConfig.Host.Builder builderForValue)
public WorkstationConfig.Builder setHost(WorkstationConfig.Host.Builder builderForValue)Optional. Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | WorkstationConfig.Host.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setIdleTimeout(Duration value)
public WorkstationConfig.Builder setIdleTimeout(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setIdleTimeout(Duration.Builder builderForValue)
public WorkstationConfig.Builder setIdleTimeout(Duration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setName(String value)
public WorkstationConfig.Builder setName(String value)Full name of this workstation configuration.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public WorkstationConfig.Builder setNameBytes(ByteString value)Full name of this workstation configuration.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setPersistentDirectories(int index, WorkstationConfig.PersistentDirectory value)
public WorkstationConfig.Builder setPersistentDirectories(int index, WorkstationConfig.PersistentDirectory value)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | WorkstationConfig.PersistentDirectory |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setPersistentDirectories(int index, WorkstationConfig.PersistentDirectory.Builder builderForValue)
public WorkstationConfig.Builder setPersistentDirectories(int index, WorkstationConfig.PersistentDirectory.Builder builderForValue)Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | WorkstationConfig.PersistentDirectory.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setReadinessChecks(int index, WorkstationConfig.ReadinessCheck value)
public WorkstationConfig.Builder setReadinessChecks(int index, WorkstationConfig.ReadinessCheck value)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | WorkstationConfig.ReadinessCheck |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setReadinessChecks(int index, WorkstationConfig.ReadinessCheck.Builder builderForValue)
public WorkstationConfig.Builder setReadinessChecks(int index, WorkstationConfig.ReadinessCheck.Builder builderForValue)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.v1.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | WorkstationConfig.ReadinessCheck.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setReconciling(boolean value)
public WorkstationConfig.Builder setReconciling(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe reconciling to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WorkstationConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setReplicaZones(int index, String value)
public WorkstationConfig.Builder setReplicaZones(int index, String value) 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];
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe replicaZones to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setRunningTimeout(Duration value)
public WorkstationConfig.Builder setRunningTimeout(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setRunningTimeout(Duration.Builder builderForValue)
public WorkstationConfig.Builder setRunningTimeout(Duration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setUid(String value)
public WorkstationConfig.Builder setUid(String value)Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public WorkstationConfig.Builder setUidBytes(ByteString value)Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setUpdateTime(Timestamp value)
public WorkstationConfig.Builder setUpdateTime(Timestamp value)Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public WorkstationConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Builder | |