public interface WorkstationClusterOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 |
|
containsTags(String key)
public abstract boolean containsTags(String key)Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 20 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.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. The conditions field contains detailed information about the status of the cluster.
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. |
getDomainConfig()
public abstract WorkstationCluster.DomainConfig getDomainConfig()Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.DomainConfig |
The domainConfig. |
getDomainConfigOrBuilder()
public abstract WorkstationCluster.DomainConfigOrBuilder getDomainConfigOrBuilder()Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.DomainConfigOrBuilder |
|
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. |
getGatewayConfig()
public abstract WorkstationCluster.GatewayConfig getGatewayConfig()Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.GatewayConfig |
The gatewayConfig. |
getGatewayConfigOrBuilder()
public abstract WorkstationCluster.GatewayConfigOrBuilder getGatewayConfigOrBuilder()Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.GatewayConfigOrBuilder |
|
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()Identifier. Full name of this workstation cluster.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Identifier. Full name of this workstation cluster.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| 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.v1beta.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.v1beta.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. |
getSatisfiesPzi()
public abstract 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 abstract boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzs. |
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. |
getTags() (deprecated)
public abstract Map<String,String> getTags()Use #getTagsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsCount()
public abstract int getTagsCount()Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 20 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getTagsMap()
public abstract Map<String,String> getTagsMap()Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 20 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsOrDefault(String key, String defaultValue)
public abstract String getTagsOrDefault(String key, String defaultValue)Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 20 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getTagsOrThrow(String key)
public abstract String getTagsOrThrow(String key)Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 20 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
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, (.google.api.field_info) = { ... }
| 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, (.google.api.field_info) = { ... }
| 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 |
|
getWorkstationAuthorizationUrl()
public abstract String getWorkstationAuthorizationUrl()Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster.
Redirects to this endpoint will send a base64 encoded state query param
containing the target workstation name and original request hostname. The
endpoint is responsible for retrieving a token using GenerateAccessToken
and redirecting back to the original hostname with the token.
string workstation_authorization_url = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The workstationAuthorizationUrl. |
getWorkstationAuthorizationUrlBytes()
public abstract ByteString getWorkstationAuthorizationUrlBytes()Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster.
Redirects to this endpoint will send a base64 encoded state query param
containing the target workstation name and original request hostname. The
endpoint is responsible for retrieving a token using GenerateAccessToken
and redirecting back to the original hostname with the token.
string workstation_authorization_url = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for workstationAuthorizationUrl. |
getWorkstationLaunchUrl()
public abstract String getWorkstationLaunchUrl()Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL.
Requests redirected to the launch endpoint will be sent with a
workstation and project query parameter containing the full workstation
resource name and project ID, respectively. The launch endpoint is
responsible for starting the workstation, polling it until it reaches
STATE_RUNNING, and then issuing a redirect to the workstation's host URL.
string workstation_launch_url = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The workstationLaunchUrl. |
getWorkstationLaunchUrlBytes()
public abstract ByteString getWorkstationLaunchUrlBytes()Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL.
Requests redirected to the launch endpoint will be sent with a
workstation and project query parameter containing the full workstation
resource name and project ID, respectively. The launch endpoint is
responsible for starting the workstation, polling it until it reaches
STATE_RUNNING, and then issuing a redirect to the workstation's host URL.
string workstation_launch_url = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for workstationLaunchUrl. |
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. |
hasDomainConfig()
public abstract boolean hasDomainConfig()Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the domainConfig field is set. |
hasGatewayConfig()
public abstract boolean hasGatewayConfig()Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gatewayConfig field is set. |
hasPrivateClusterConfig()
public abstract 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 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. |