Interface WorkstationClusterOrBuilder (0.21.0)

Version 0.21.0

• 0.41.0 (latest)
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 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 WorkstationClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract boolean containsLabels(String key)

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

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Client-specified annotations.

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

Returns
Type	Description
int

getAnnotationsMap()

public abstract 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 abstract 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 abstract 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 abstract Status getConditions(int index)

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

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

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

Returns
Type	Description
int

getConditionsList()

public abstract List<Status> getConditionsList()

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

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

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

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

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

getControlPlaneIp()

public abstract String getControlPlaneIp()

Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.

string control_plane_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The controlPlaneIp.

getControlPlaneIpBytes()

public abstract ByteString getControlPlaneIpBytes()

Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.

string control_plane_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for controlPlaneIp.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when this workstation cluster 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 workstation cluster 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 workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.

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

Returns
Type	Description
boolean	The degraded.

getDeleteTime()

public abstract Timestamp getDeleteTime()

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

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

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. Human-readable name for this workstation cluster.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Human-readable name for this workstation cluster.

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

Returns
Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract 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 abstract 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.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

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

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

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

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Full name of this workstation cluster.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Full name of this workstation cluster.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

public abstract String getNetwork()

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

string network = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

string network = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for network.

getPrivateClusterConfig()

public abstract WorkstationCluster.PrivateClusterConfig getPrivateClusterConfig()

Optional. Configuration for private workstation cluster.

.google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
WorkstationCluster.PrivateClusterConfig	The privateClusterConfig.

getPrivateClusterConfigOrBuilder()

public abstract WorkstationCluster.PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()

Optional. Configuration for private workstation cluster.

.google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
WorkstationCluster.PrivateClusterConfigOrBuilder

getReconciling()

public abstract boolean getReconciling()

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

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

Returns
Type	Description
boolean	The reconciling.

getSubnetwork()

public abstract String getSubnetwork()

Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

string subnetwork = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The subnetwork.

getSubnetworkBytes()

public abstract ByteString getSubnetworkBytes()

Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

string subnetwork = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for subnetwork.

getUid()

public abstract String getUid()

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

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 identifier for this workstation cluster.

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 workstation cluster 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 workstation cluster was most recently updated.

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

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

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

hasPrivateClusterConfig()

public abstract boolean hasPrivateClusterConfig()

Optional. Configuration for private workstation cluster.

.google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the privateClusterConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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