public final class WorkstationCluster extends GeneratedMessageV3 implements WorkstationClusterOrBuilder
A workstation cluster resource in the Cloud Workstations API.
Defines a group of workstations in a particular region and the
VPC network they're attached to.
Protobuf type google.cloud.workstations.v1beta.WorkstationCluster
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONTROL_PLANE_IP_FIELD_NUMBER
public static final int CONTROL_PLANE_IP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEGRADED_FIELD_NUMBER
public static final int DEGRADED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
public static final int PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static WorkstationCluster getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WorkstationCluster.Builder newBuilder()
newBuilder(WorkstationCluster prototype)
public static WorkstationCluster.Builder newBuilder(WorkstationCluster prototype)
public static WorkstationCluster parseDelimitedFrom(InputStream input)
public static WorkstationCluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WorkstationCluster parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkstationCluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WorkstationCluster parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationCluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationCluster parseFrom(CodedInputStream input)
public static WorkstationCluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationCluster parseFrom(InputStream input)
public static WorkstationCluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WorkstationCluster parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkstationCluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WorkstationCluster> parser()
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
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];
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];
| Returns |
| Type |
Description |
String |
|
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getConditions(int index)
public Status getConditions(int index)
Output only. Status conditions describing the 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 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 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 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 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 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 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 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public WorkstationCluster getDefaultInstanceForType()
getDegraded()
public 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 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 TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Time when this workstation cluster was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDisplayName()
public 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 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()
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.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public 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 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];
getLabelsOrDefault(String key, String defaultValue)
public 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];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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()
Full name of this workstation cluster.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Full name of this workstation cluster.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getNetwork()
public 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 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.
|
getParserForType()
public Parser<WorkstationCluster> getParserForType()
Overrides
getPrivateClusterConfig()
public WorkstationCluster.PrivateClusterConfig getPrivateClusterConfig()
Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getPrivateClusterConfigOrBuilder()
public WorkstationCluster.PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()
Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getReconciling()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSubnetwork()
public 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 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()
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 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 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 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];
hasCreateTime()
public 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 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 boolean hasPrivateClusterConfig()
Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the privateClusterConfig field is set.
|
hasUpdateTime()
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WorkstationCluster.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkstationCluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public WorkstationCluster.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
