Interface WorkstationConfigOrBuilder (0.10.0)

Version 0.10.0

• 0.30.0 (latest)
• 0.29.0
• 0.28.0
• 0.27.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface WorkstationConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Client-specified annotations.

map<string, string> annotations = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 18;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Client-specified annotations.

map<string, string> annotations = 5;

Returns
Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Client-specified annotations.

map<string, string> annotations = 5;

Returns
Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Client-specified annotations.

map<string, string> annotations = 5;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Client-specified annotations.

map<string, string> annotations = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getConditions(int index)

public abstract Status getConditions(int index)

Output only. Status conditions describing the current resource state.

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

Parameter
Name	Description
index	int

Returns
Type	Description
com.google.rpc.Status

getConditionsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract WorkstationConfig.Container getContainer()

Container that will be run for each workstation using this configuration when that workstation is started.

.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14;

Returns
Type	Description
WorkstationConfig.Container	The container.

getContainerOrBuilder()

public abstract WorkstationConfig.ContainerOrBuilder getContainerOrBuilder()

Container that will be run for each workstation using this configuration when that workstation is started.

.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14;

Returns
Type	Description
WorkstationConfig.ContainerOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when this resource was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this resource was created.

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

Returns
Type	Description
TimestampOrBuilder

getDegraded()

public abstract boolean getDegraded()

Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the conditions field.

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

Returns
Type	Description
boolean	The degraded.

getDeleteTime()

public abstract Timestamp getDeleteTime()

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

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

Returns
Type	Description
Timestamp	The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

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

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

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Human-readable name for this resource.

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Human-readable name for this resource.

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

getEnableAuditAgent()

public abstract boolean getEnableAuditAgent()

Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from Cloud Audit Logs.

bool enable_audit_agent = 20;

Returns
Type	Description
boolean	The enableAuditAgent.

getEncryptionKey()

public abstract WorkstationConfig.CustomerEncryptionKey getEncryptionKey()

Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key.

If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.

If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.

If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours.

Immutable after the workstation configuration is created.

.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
WorkstationConfig.CustomerEncryptionKey	The encryptionKey.

getEncryptionKeyOrBuilder()

public abstract WorkstationConfig.CustomerEncryptionKeyOrBuilder getEncryptionKeyOrBuilder()

Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key.

If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.

If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.

If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours.

Immutable after the workstation configuration is created.

.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
WorkstationConfig.CustomerEncryptionKeyOrBuilder

getEtag()

public abstract String getEtag()

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;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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;

Returns
Type	Description
ByteString	The bytes for etag.

getHost()

public abstract WorkstationConfig.Host getHost()

Runtime host for the workstation.

.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12;

Returns
Type	Description
WorkstationConfig.Host	The host.

getHostOrBuilder()

public abstract WorkstationConfig.HostOrBuilder getHostOrBuilder()

Runtime host for the workstation.

.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12;

Returns
Type	Description
WorkstationConfig.HostOrBuilder

getIdleTimeout()

public abstract Duration getIdleTimeout()

How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes.

.google.protobuf.Duration idle_timeout = 10;

Returns
Type	Description
Duration	The idleTimeout.

getIdleTimeoutOrBuilder()

public abstract DurationOrBuilder getIdleTimeoutOrBuilder()

How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes.

.google.protobuf.Duration idle_timeout = 10;

Returns
Type	Description
DurationOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 18;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 18;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 18;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 18;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Full name of this resource.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Full name of this resource.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getPersistentDirectories(int index)

public abstract WorkstationConfig.PersistentDirectory getPersistentDirectories(int index)

Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkstationConfig.PersistentDirectory

getPersistentDirectoriesCount()

public abstract int getPersistentDirectoriesCount()

Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13;

Returns
Type	Description
int

getPersistentDirectoriesList()

public abstract List<WorkstationConfig.PersistentDirectory> getPersistentDirectoriesList()

Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13;

Returns
Type	Description
List<PersistentDirectory>

getPersistentDirectoriesOrBuilder(int index)

public abstract WorkstationConfig.PersistentDirectoryOrBuilder getPersistentDirectoriesOrBuilder(int index)

Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkstationConfig.PersistentDirectoryOrBuilder

getPersistentDirectoriesOrBuilderList()

public abstract List<? extends WorkstationConfig.PersistentDirectoryOrBuilder> getPersistentDirectoriesOrBuilderList()

Directories to persist across workstation sessions.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13;

Returns
Type	Description
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectoryOrBuilder>

getReadinessChecks(int index)

public abstract WorkstationConfig.ReadinessCheck getReadinessChecks(int index)

Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkstationConfig.ReadinessCheck

getReadinessChecksCount()

public abstract int getReadinessChecksCount()

Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19;

Returns
Type	Description
int

getReadinessChecksList()

public abstract List<WorkstationConfig.ReadinessCheck> getReadinessChecksList()

Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19;

Returns
Type	Description
List<ReadinessCheck>

getReadinessChecksOrBuilder(int index)

public abstract WorkstationConfig.ReadinessCheckOrBuilder getReadinessChecksOrBuilder(int index)

Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkstationConfig.ReadinessCheckOrBuilder

getReadinessChecksOrBuilderList()

public abstract List<? extends WorkstationConfig.ReadinessCheckOrBuilder> getReadinessChecksOrBuilderList()

Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.

repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19;

Returns
Type	Description
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheckOrBuilder>

getReconciling()

public abstract boolean getReconciling()

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

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

Returns
Type	Description
boolean	The reconciling.

getRunningTimeout()

public abstract Duration getRunningTimeout()

How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours.

.google.protobuf.Duration running_timeout = 11;

Returns
Type	Description
Duration	The runningTimeout.

getRunningTimeoutOrBuilder()

public abstract DurationOrBuilder getRunningTimeoutOrBuilder()

How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours.

.google.protobuf.Duration running_timeout = 11;

Returns
Type	Description
DurationOrBuilder

getUid()

public abstract String getUid()

Output only. A system-assigned unique identified for this resource.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. A system-assigned unique identified for this resource.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type	Description
TimestampOrBuilder

hasContainer()

public abstract boolean hasContainer()

Container that will be run for each workstation using this configuration when that workstation is started.

.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14;

Returns
Type	Description
boolean	Whether the container field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time when this resource 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 abstract boolean hasDeleteTime()

Output only. Time when this resource 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 abstract boolean hasEncryptionKey()

Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key.

If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.

If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.

If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours.

Immutable after the workstation configuration is created.

.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the encryptionKey field is set.

hasHost()

public abstract boolean hasHost()

Runtime host for the workstation.

.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12;

Returns
Type	Description
boolean	Whether the host field is set.

hasIdleTimeout()

public abstract boolean hasIdleTimeout()

How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes.

.google.protobuf.Duration idle_timeout = 10;

Returns
Type	Description
boolean	Whether the idleTimeout field is set.

hasRunningTimeout()

public abstract boolean hasRunningTimeout()

How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours.

.google.protobuf.Duration running_timeout = 11;

Returns
Type	Description
boolean	Whether the runningTimeout field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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