Class Workstation.Builder (0.81.0)

public static final class Workstation.Builder extends GeneratedMessage.Builder<Workstation.Builder> implements WorkstationOrBuilder

A single instance of a developer workstation with its own persistent storage.

Protobuf type google.cloud.workstations.v1beta.Workstation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllBoostConfigs(Iterable<? extends Workstation.WorkstationBoostConfig> values)

public Workstation.Builder addAllBoostConfigs(Iterable<? extends Workstation.WorkstationBoostConfig> values)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig>
Returns
Type Description
Workstation.Builder

addAllConditions(Iterable<? extends Status> values)

public Workstation.Builder addAllConditions(Iterable<? extends Status> values)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.rpc.Status>
Returns
Type Description
Workstation.Builder

addAllPersistentDirectories(Iterable<? extends Workstation.WorkstationPersistentDirectory> values)

public Workstation.Builder addAllPersistentDirectories(Iterable<? extends Workstation.WorkstationPersistentDirectory> values)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory>
Returns
Type Description
Workstation.Builder

addBoostConfigs(Workstation.WorkstationBoostConfig value)

public Workstation.Builder addBoostConfigs(Workstation.WorkstationBoostConfig value)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Workstation.WorkstationBoostConfig
Returns
Type Description
Workstation.Builder

addBoostConfigs(Workstation.WorkstationBoostConfig.Builder builderForValue)

public Workstation.Builder addBoostConfigs(Workstation.WorkstationBoostConfig.Builder builderForValue)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Workstation.WorkstationBoostConfig.Builder
Returns
Type Description
Workstation.Builder

addBoostConfigs(int index, Workstation.WorkstationBoostConfig value)

public Workstation.Builder addBoostConfigs(int index, Workstation.WorkstationBoostConfig value)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Workstation.WorkstationBoostConfig
Returns
Type Description
Workstation.Builder

addBoostConfigs(int index, Workstation.WorkstationBoostConfig.Builder builderForValue)

public Workstation.Builder addBoostConfigs(int index, Workstation.WorkstationBoostConfig.Builder builderForValue)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Workstation.WorkstationBoostConfig.Builder
Returns
Type Description
Workstation.Builder

addBoostConfigsBuilder()

public Workstation.WorkstationBoostConfig.Builder addBoostConfigsBuilder()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.WorkstationBoostConfig.Builder

addBoostConfigsBuilder(int index)

public Workstation.WorkstationBoostConfig.Builder addBoostConfigsBuilder(int index)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationBoostConfig.Builder

addConditions(Status value)

public Workstation.Builder addConditions(Status value)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Workstation.Builder

addConditions(Status.Builder builderForValue)

public Workstation.Builder addConditions(Status.Builder builderForValue)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Workstation.Builder

addConditions(int index, Status value)

public Workstation.Builder addConditions(int index, Status value)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
Workstation.Builder

addConditions(int index, Status.Builder builderForValue)

public Workstation.Builder addConditions(int index, Status.Builder builderForValue)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Workstation.Builder

addConditionsBuilder()

public Status.Builder addConditionsBuilder()

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status.Builder

addPersistentDirectories(Workstation.WorkstationPersistentDirectory value)

public Workstation.Builder addPersistentDirectories(Workstation.WorkstationPersistentDirectory value)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Workstation.WorkstationPersistentDirectory
Returns
Type Description
Workstation.Builder

addPersistentDirectories(Workstation.WorkstationPersistentDirectory.Builder builderForValue)

public Workstation.Builder addPersistentDirectories(Workstation.WorkstationPersistentDirectory.Builder builderForValue)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Workstation.WorkstationPersistentDirectory.Builder
Returns
Type Description
Workstation.Builder

addPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory value)

public Workstation.Builder addPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory value)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Workstation.WorkstationPersistentDirectory
Returns
Type Description
Workstation.Builder

addPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory.Builder builderForValue)

public Workstation.Builder addPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory.Builder builderForValue)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Workstation.WorkstationPersistentDirectory.Builder
Returns
Type Description
Workstation.Builder

addPersistentDirectoriesBuilder()

public Workstation.WorkstationPersistentDirectory.Builder addPersistentDirectoriesBuilder()

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workstation.WorkstationPersistentDirectory.Builder

addPersistentDirectoriesBuilder(int index)

public Workstation.WorkstationPersistentDirectory.Builder addPersistentDirectoriesBuilder(int index)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationPersistentDirectory.Builder

build()

public Workstation build()
Returns
Type Description
Workstation

buildPartial()

public Workstation buildPartial()
Returns
Type Description
Workstation

clear()

public Workstation.Builder clear()
Returns
Type Description
Workstation.Builder
Overrides

clearAnnotations()

public Workstation.Builder clearAnnotations()
Returns
Type Description
Workstation.Builder

clearBoostConfigs()

public Workstation.Builder clearBoostConfigs()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearConditions()

public Workstation.Builder clearConditions()

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearCreateTime()

public Workstation.Builder clearCreateTime()

Output only. Time when this workstation was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearDegraded()

public Workstation.Builder clearDegraded()

Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation.

bool degraded = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearDeleteTime()

public Workstation.Builder clearDeleteTime()

Output only. Time when this workstation was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearDisplayName()

public Workstation.Builder clearDisplayName()

Optional. Human-readable name for this workstation.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearEnv()

public Workstation.Builder clearEnv()
Returns
Type Description
Workstation.Builder

clearEtag()

public Workstation.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
Workstation.Builder

This builder for chaining.

clearHost()

public Workstation.Builder clearHost()

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearKmsKey()

public Workstation.Builder clearKmsKey()

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearLabels()

public Workstation.Builder clearLabels()
Returns
Type Description
Workstation.Builder

clearName()

public Workstation.Builder clearName()

Identifier. Full name of this workstation.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearPersistentDirectories()

public Workstation.Builder clearPersistentDirectories()

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workstation.Builder

clearReconciling()

public Workstation.Builder clearReconciling()

Output only. Indicates whether this workstation is currently being updated to match its intended state.

bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearRuntimeHost()

public Workstation.Builder clearRuntimeHost()

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearSatisfiesPzi()

public Workstation.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearSatisfiesPzs()

public Workstation.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearSourceWorkstation()

public Workstation.Builder clearSourceWorkstation()

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

string source_workstation = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearStartTime()

public Workstation.Builder clearStartTime()

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

clearState()

public Workstation.Builder clearState()

Output only. Current state of the workstation.

.google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearUid()

public Workstation.Builder clearUid()

Output only. A system-assigned unique identifier for this workstation.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
Workstation.Builder

This builder for chaining.

clearUpdateTime()

public Workstation.Builder clearUpdateTime()

Output only. Time when this workstation was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.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

containsEnv(String key)

public boolean containsEnv(String key)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.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 and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.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

getBoostConfigs(int index)

public Workstation.WorkstationBoostConfig getBoostConfigs(int index)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationBoostConfig

getBoostConfigsBuilder(int index)

public Workstation.WorkstationBoostConfig.Builder getBoostConfigsBuilder(int index)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationBoostConfig.Builder

getBoostConfigsBuilderList()

public List<Workstation.WorkstationBoostConfig.Builder> getBoostConfigsBuilderList()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getBoostConfigsCount()

public int getBoostConfigsCount()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getBoostConfigsList()

public List<Workstation.WorkstationBoostConfig> getBoostConfigsList()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<WorkstationBoostConfig>

getBoostConfigsOrBuilder(int index)

public Workstation.WorkstationBoostConfigOrBuilder getBoostConfigsOrBuilder(int index)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationBoostConfigOrBuilder

getBoostConfigsOrBuilderList()

public List<? extends Workstation.WorkstationBoostConfigOrBuilder> getBoostConfigsOrBuilderList()

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfigOrBuilder>

getConditions(int index)

public Status getConditions(int index)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getConditionsList()

public List<Status> getConditionsList()

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.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 workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when this workstation 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 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 was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Workstation getDefaultInstanceForType()
Returns
Type Description
Workstation

getDegraded()

public boolean getDegraded()

Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation.

bool degraded = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The degraded.

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Time when this workstation 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 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 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
Overrides

getDisplayName()

public String getDisplayName()

Optional. Human-readable name for this workstation.

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.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEnv() (deprecated)

public Map<String,String> getEnv()

Use #getEnvMap() instead.

Returns
Type Description
Map<String,String>

getEnvCount()

public int getEnvCount()

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEnvMap()

public Map<String,String> getEnvMap()

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getEnvOrDefault(String key, String defaultValue)

public String getEnvOrDefault(String key, String defaultValue)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvOrThrow(String key)

public String getEnvOrThrow(String key)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

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 String getHost()

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The host.

getHostBytes()

public ByteString getHostBytes()

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for host.

getKmsKey()

public String getKmsKey()

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKey.

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 and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.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 and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.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 and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.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>

getMutableEnv() (deprecated)

public Map<String,String> getMutableEnv()

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()

Identifier. Full name of this workstation.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Full name of this workstation.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPersistentDirectories(int index)

public Workstation.WorkstationPersistentDirectory getPersistentDirectories(int index)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationPersistentDirectory

getPersistentDirectoriesBuilder(int index)

public Workstation.WorkstationPersistentDirectory.Builder getPersistentDirectoriesBuilder(int index)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationPersistentDirectory.Builder

getPersistentDirectoriesBuilderList()

public List<Workstation.WorkstationPersistentDirectory.Builder> getPersistentDirectoriesBuilderList()

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.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.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPersistentDirectoriesList()

public List<Workstation.WorkstationPersistentDirectory> getPersistentDirectoriesList()

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<WorkstationPersistentDirectory>

getPersistentDirectoriesOrBuilder(int index)

public Workstation.WorkstationPersistentDirectoryOrBuilder getPersistentDirectoriesOrBuilder(int index)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Workstation.WorkstationPersistentDirectoryOrBuilder

getPersistentDirectoriesOrBuilderList()

public List<? extends Workstation.WorkstationPersistentDirectoryOrBuilder> getPersistentDirectoriesOrBuilderList()

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectoryOrBuilder>

getReconciling()

public boolean getReconciling()

Output only. Indicates whether this workstation is currently being updated to match its intended state.

bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getRuntimeHost()

public Workstation.RuntimeHost getRuntimeHost()

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.RuntimeHost

The runtimeHost.

getRuntimeHostBuilder()

public Workstation.RuntimeHost.Builder getRuntimeHostBuilder()

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.RuntimeHost.Builder

getRuntimeHostOrBuilder()

public Workstation.RuntimeHostOrBuilder getRuntimeHostOrBuilder()

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.RuntimeHostOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSourceWorkstation()

public String getSourceWorkstation()

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

string source_workstation = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sourceWorkstation.

getSourceWorkstationBytes()

public ByteString getSourceWorkstationBytes()

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

string source_workstation = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sourceWorkstation.

getStartTime()

public Timestamp getStartTime()

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public Workstation.State getState()

Output only. Current state of the workstation.

.google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workstation.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the workstation.

.google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. A system-assigned unique identifier for this workstation.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A system-assigned unique identifier for this workstation.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when this workstation 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 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 was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when this workstation 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 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.

hasRuntimeHost()

public boolean hasRuntimeHost()

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the runtimeHost field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when this workstation 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Workstation.Builder mergeCreateTime(Timestamp value)

Output only. Time when this workstation was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

mergeDeleteTime(Timestamp value)

public Workstation.Builder mergeDeleteTime(Timestamp value)

Output only. Time when this workstation was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

mergeFrom(Workstation other)

public Workstation.Builder mergeFrom(Workstation other)
Parameter
Name Description
other Workstation
Returns
Type Description
Workstation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Workstation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workstation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Workstation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Workstation.Builder
Overrides

mergeRuntimeHost(Workstation.RuntimeHost value)

public Workstation.Builder mergeRuntimeHost(Workstation.RuntimeHost value)

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Workstation.RuntimeHost
Returns
Type Description
Workstation.Builder

mergeStartTime(Timestamp value)

public Workstation.Builder mergeStartTime(Timestamp value)

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

mergeUpdateTime(Timestamp value)

public Workstation.Builder mergeUpdateTime(Timestamp value)

Output only. Time when this workstation was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

putAllAnnotations(Map<String,String> values)

public Workstation.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
Workstation.Builder

putAllEnv(Map<String,String> values)

public Workstation.Builder putAllEnv(Map<String,String> values)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Workstation.Builder

putAllLabels(Map<String,String> values)

public Workstation.Builder putAllLabels(Map<String,String> values)

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Workstation.Builder

putAnnotations(String key, String value)

public Workstation.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
Workstation.Builder

putEnv(String key, String value)

public Workstation.Builder putEnv(String key, String value)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Workstation.Builder

putLabels(String key, String value)

public Workstation.Builder putLabels(String key, String value)

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Workstation.Builder

removeAnnotations(String key)

public Workstation.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
Workstation.Builder

removeBoostConfigs(int index)

public Workstation.Builder removeBoostConfigs(int index)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.Builder

removeConditions(int index)

public Workstation.Builder removeConditions(int index)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Workstation.Builder

removeEnv(String key)

public Workstation.Builder removeEnv(String key)

Optional. Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Workstation.Builder

removeLabels(String key)

public Workstation.Builder removeLabels(String key)

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Workstation.Builder

removePersistentDirectories(int index)

public Workstation.Builder removePersistentDirectories(int index)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Workstation.Builder

setBoostConfigs(int index, Workstation.WorkstationBoostConfig value)

public Workstation.Builder setBoostConfigs(int index, Workstation.WorkstationBoostConfig value)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Workstation.WorkstationBoostConfig
Returns
Type Description
Workstation.Builder

setBoostConfigs(int index, Workstation.WorkstationBoostConfig.Builder builderForValue)

public Workstation.Builder setBoostConfigs(int index, Workstation.WorkstationBoostConfig.Builder builderForValue)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationBoostConfig boost_configs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Workstation.WorkstationBoostConfig.Builder
Returns
Type Description
Workstation.Builder

setConditions(int index, Status value)

public Workstation.Builder setConditions(int index, Status value)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
Workstation.Builder

setConditions(int index, Status.Builder builderForValue)

public Workstation.Builder setConditions(int index, Status.Builder builderForValue)

Output only. Status conditions describing the workstation's current state.

repeated .google.rpc.Status conditions = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Workstation.Builder

setCreateTime(Timestamp value)

public Workstation.Builder setCreateTime(Timestamp value)

Output only. Time when this workstation was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Workstation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when this workstation was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Workstation.Builder

setDegraded(boolean value)

public Workstation.Builder setDegraded(boolean value)

Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation.

bool degraded = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The degraded to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setDeleteTime(Timestamp value)

public Workstation.Builder setDeleteTime(Timestamp value)

Output only. Time when this workstation was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Workstation.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Time when this workstation was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Workstation.Builder

setDisplayName(String value)

public Workstation.Builder setDisplayName(String value)

Optional. Human-readable name for this workstation.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Workstation.Builder setDisplayNameBytes(ByteString value)

Optional. Human-readable name for this workstation.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setEtag(String value)

public Workstation.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 String

The etag to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Workstation.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 ByteString

The bytes for etag to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setHost(String value)

public Workstation.Builder setHost(String value)

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The host to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setHostBytes(ByteString value)

public Workstation.Builder setHostBytes(ByteString value)

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for host to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setKmsKey(String value)

public Workstation.Builder setKmsKey(String value)

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public Workstation.Builder setKmsKeyBytes(ByteString value)

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setName(String value)

public Workstation.Builder setName(String value)

Identifier. Full name of this workstation.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Workstation.Builder setNameBytes(ByteString value)

Identifier. Full name of this workstation.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory value)

public Workstation.Builder setPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory value)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Workstation.WorkstationPersistentDirectory
Returns
Type Description
Workstation.Builder

setPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory.Builder builderForValue)

public Workstation.Builder setPersistentDirectories(int index, Workstation.WorkstationPersistentDirectory.Builder builderForValue)

Optional. Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.Workstation.WorkstationPersistentDirectory persistent_directories = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Workstation.WorkstationPersistentDirectory.Builder
Returns
Type Description
Workstation.Builder

setReconciling(boolean value)

public Workstation.Builder setReconciling(boolean value)

Output only. Indicates whether this workstation is currently being updated to match its intended state.

bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The reconciling to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setRuntimeHost(Workstation.RuntimeHost value)

public Workstation.Builder setRuntimeHost(Workstation.RuntimeHost value)

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Workstation.RuntimeHost
Returns
Type Description
Workstation.Builder

setRuntimeHost(Workstation.RuntimeHost.Builder builderForValue)

public Workstation.Builder setRuntimeHost(Workstation.RuntimeHost.Builder builderForValue)

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

.google.cloud.workstations.v1beta.Workstation.RuntimeHost runtime_host = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Workstation.RuntimeHost.Builder
Returns
Type Description
Workstation.Builder

setSatisfiesPzi(boolean value)

public Workstation.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public Workstation.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setSourceWorkstation(String value)

public Workstation.Builder setSourceWorkstation(String value)

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

string source_workstation = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The sourceWorkstation to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setSourceWorkstationBytes(ByteString value)

public Workstation.Builder setSourceWorkstationBytes(ByteString value)

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

string source_workstation = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for sourceWorkstation to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setStartTime(Timestamp value)

public Workstation.Builder setStartTime(Timestamp value)

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

setStartTime(Timestamp.Builder builderForValue)

public Workstation.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

.google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Workstation.Builder

setState(Workstation.State value)

public Workstation.Builder setState(Workstation.State value)

Output only. Current state of the workstation.

.google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Workstation.State

The state to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setStateValue(int value)

public Workstation.Builder setStateValue(int value)

Output only. Current state of the workstation.

.google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setUid(String value)

public Workstation.Builder setUid(String value)

Output only. A system-assigned unique identifier for this workstation.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Workstation.Builder setUidBytes(ByteString value)

Output only. A system-assigned unique identifier for this workstation.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
Workstation.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Workstation.Builder setUpdateTime(Timestamp value)

Output only. Time when this workstation was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workstation.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Workstation.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time when this workstation was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Workstation.Builder