Class WorkstationCluster (0.24.0)

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.v1.WorkstationCluster

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CONDITIONS_FIELD_NUMBER

public static final int CONDITIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CONTROL_PLANE_IP_FIELD_NUMBER

public static final int CONTROL_PLANE_IP_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DEGRADED_FIELD_NUMBER

public static final int DEGRADED_FIELD_NUMBER
Field Value
TypeDescription
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER

public static final int PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WorkstationCluster getDefaultInstance()
Returns
TypeDescription
WorkstationCluster

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static WorkstationCluster.Builder newBuilder()
Returns
TypeDescription
WorkstationCluster.Builder

newBuilder(WorkstationCluster prototype)

public static WorkstationCluster.Builder newBuilder(WorkstationCluster prototype)
Parameter
NameDescription
prototypeWorkstationCluster
Returns
TypeDescription
WorkstationCluster.Builder

parseDelimitedFrom(InputStream input)

public static WorkstationCluster parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WorkstationCluster parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkstationCluster parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkstationCluster parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WorkstationCluster parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WorkstationCluster parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkstationCluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkstationCluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WorkstationCluster> parser()
Returns
TypeDescription
Parser<WorkstationCluster>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. Client-specified annotations.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. Client-specified annotations.

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

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Optional. Client-specified annotations.

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

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Optional. Client-specified annotations.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public WorkstationCluster getDefaultInstanceForType()
Returns
TypeDescription
WorkstationCluster

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
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

getDisplayName()

public String getDisplayName()

Optional. Human-readable name for this workstation cluster.

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

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

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
TypeDescription
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];

Returns
TypeDescription
Map<String,String>

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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Full name of this workstation cluster.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Full name of this workstation cluster.

string name = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for network.

getParserForType()

public Parser<WorkstationCluster> getParserForType()
Returns
TypeDescription
Parser<WorkstationCluster>
Overrides

getPrivateClusterConfig()

public 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
TypeDescription
WorkstationCluster.PrivateClusterConfig

The privateClusterConfig.

getPrivateClusterConfigOrBuilder()

public 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
TypeDescription
WorkstationCluster.PrivateClusterConfigOrBuilder

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
TypeDescription
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for subnetwork.

getUid()

public String getUid()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

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
TypeDescription
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
TypeDescription
boolean

Whether the deleteTime field is set.

hasPrivateClusterConfig()

public boolean hasPrivateClusterConfig()

Optional. Configuration for private workstation cluster.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public WorkstationCluster.Builder newBuilderForType()
Returns
TypeDescription
WorkstationCluster.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkstationCluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WorkstationCluster.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public WorkstationCluster.Builder toBuilder()
Returns
TypeDescription
WorkstationCluster.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException