public static final class WorkstationCluster.Builder extends GeneratedMessage.Builder<WorkstationCluster.Builder> implements WorkstationClusterOrBuilderA 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > WorkstationCluster.BuilderImplements
WorkstationClusterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllConditions(Iterable<? extends Status> values)
public WorkstationCluster.Builder addAllConditions(Iterable<? extends Status> values)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 |
values |
Iterable<? extends com.google.rpc.Status> |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
addConditions(Status value)
public WorkstationCluster.Builder addConditions(Status value)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 |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
addConditions(Status.Builder builderForValue)
public WorkstationCluster.Builder addConditions(Status.Builder builderForValue)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 |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
addConditions(int index, Status value)
public WorkstationCluster.Builder addConditions(int index, Status value)Output only. Status conditions describing the workstation cluster's current state.
repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
addConditions(int index, Status.Builder builderForValue)
public WorkstationCluster.Builder addConditions(int index, Status.Builder builderForValue)Output only. Status conditions describing the workstation cluster's current state.
repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
addConditionsBuilder()
public Status.Builder addConditionsBuilder()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 |
com.google.rpc.Status.Builder |
|
addConditionsBuilder(int index)
public Status.Builder addConditionsBuilder(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.Builder |
|
build()
public WorkstationCluster build()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster |
|
buildPartial()
public WorkstationCluster buildPartial()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster |
|
clear()
public WorkstationCluster.Builder clear()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
clearAnnotations()
public WorkstationCluster.Builder clearAnnotations()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
clearConditions()
public WorkstationCluster.Builder clearConditions()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 |
WorkstationCluster.Builder |
|
clearControlPlaneIp()
public WorkstationCluster.Builder clearControlPlaneIp()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearCreateTime()
public WorkstationCluster.Builder clearCreateTime()Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
clearDegraded()
public WorkstationCluster.Builder clearDegraded()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearDeleteTime()
public WorkstationCluster.Builder clearDeleteTime()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 |
WorkstationCluster.Builder |
|
clearDisplayName()
public WorkstationCluster.Builder clearDisplayName()Optional. Human-readable name for this workstation cluster.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
clearDomainConfig()
public WorkstationCluster.Builder clearDomainConfig()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.Builder |
|
clearEtag()
public WorkstationCluster.Builder clearEtag()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearGatewayConfig()
public WorkstationCluster.Builder clearGatewayConfig()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.Builder |
|
clearLabels()
public WorkstationCluster.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
clearName()
public WorkstationCluster.Builder clearName()Identifier. Full name of this workstation cluster.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
clearNetwork()
public WorkstationCluster.Builder clearNetwork()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearPrivateClusterConfig()
public WorkstationCluster.Builder clearPrivateClusterConfig()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.Builder |
|
clearReconciling()
public WorkstationCluster.Builder clearReconciling()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearSatisfiesPzi()
public WorkstationCluster.Builder clearSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
clearSatisfiesPzs()
public WorkstationCluster.Builder clearSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
clearSubnetwork()
public WorkstationCluster.Builder clearSubnetwork()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearTags()
public WorkstationCluster.Builder clearTags()| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
clearUid()
public WorkstationCluster.Builder clearUid()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearUpdateTime()
public WorkstationCluster.Builder clearUpdateTime()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 |
WorkstationCluster.Builder |
|
clearWorkstationAuthorizationUrl()
public WorkstationCluster.Builder clearWorkstationAuthorizationUrl()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 |
WorkstationCluster.Builder |
This builder for chaining. |
clearWorkstationLaunchUrl()
public WorkstationCluster.Builder clearWorkstationLaunchUrl()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 |
WorkstationCluster.Builder |
This builder for chaining. |
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 |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsTags(String key)
public 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 Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| 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 |
|
getConditionsBuilder(int index)
public Status.Builder getConditionsBuilder(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.Builder |
|
getConditionsBuilderList()
public List<Status.Builder> getConditionsBuilderList()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.Builder> |
|
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public WorkstationCluster getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
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. 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 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. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()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 |
Builder |
|
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getDomainConfig()
public 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. |
getDomainConfigBuilder()
public WorkstationCluster.DomainConfig.Builder getDomainConfigBuilder()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.Builder |
|
getDomainConfigOrBuilder()
public 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 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 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 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. |
getGatewayConfigBuilder()
public WorkstationCluster.GatewayConfig.Builder getGatewayConfigBuilder()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.Builder |
|
getGatewayConfigOrBuilder()
public 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 Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| 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 |
|
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableTags() (deprecated)
public Map<String,String> getMutableTags()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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. |
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];
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.PrivateClusterConfig |
The privateClusterConfig. |
getPrivateClusterConfigBuilder()
public WorkstationCluster.PrivateClusterConfig.Builder getPrivateClusterConfigBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
The reconciling. |
getSatisfiesPzi()
public 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 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 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. |
getTags() (deprecated)
public Map<String,String> getTags()Use #getTagsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getTagsCount()
public 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 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 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 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 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getWorkstationAuthorizationUrl()
public 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 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 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 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 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. |
hasDomainConfig()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public WorkstationCluster.Builder mergeCreateTime(Timestamp value)Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeDeleteTime(Timestamp value)
public WorkstationCluster.Builder mergeDeleteTime(Timestamp value)Output only. Time when this workstation cluster was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeDomainConfig(WorkstationCluster.DomainConfig value)
public WorkstationCluster.Builder mergeDomainConfig(WorkstationCluster.DomainConfig value)Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.DomainConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeFrom(WorkstationCluster other)
public WorkstationCluster.Builder mergeFrom(WorkstationCluster other)| Parameter | |
|---|---|
| Name | Description |
other |
WorkstationCluster |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkstationCluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public WorkstationCluster.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeGatewayConfig(WorkstationCluster.GatewayConfig value)
public WorkstationCluster.Builder mergeGatewayConfig(WorkstationCluster.GatewayConfig value)Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.GatewayConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergePrivateClusterConfig(WorkstationCluster.PrivateClusterConfig value)
public WorkstationCluster.Builder mergePrivateClusterConfig(WorkstationCluster.PrivateClusterConfig value)Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.PrivateClusterConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
mergeUpdateTime(Timestamp value)
public WorkstationCluster.Builder mergeUpdateTime(Timestamp value)Output only. Time when this workstation cluster was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putAllAnnotations(Map<String,String> values)
public WorkstationCluster.Builder putAllAnnotations(Map<String,String> values)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putAllLabels(Map<String,String> values)
public WorkstationCluster.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putAllTags(Map<String,String> values)
public WorkstationCluster.Builder putAllTags(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putAnnotations(String key, String value)
public WorkstationCluster.Builder putAnnotations(String key, String value)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putLabels(String key, String value)
public WorkstationCluster.Builder putLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
putTags(String key, String value)
public WorkstationCluster.Builder putTags(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
removeAnnotations(String key)
public WorkstationCluster.Builder removeAnnotations(String key)Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
removeConditions(int index)
public WorkstationCluster.Builder removeConditions(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 |
WorkstationCluster.Builder |
|
removeLabels(String key)
public WorkstationCluster.Builder removeLabels(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 |
WorkstationCluster.Builder |
|
removeTags(String key)
public WorkstationCluster.Builder removeTags(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 |
WorkstationCluster.Builder |
|
setConditions(int index, Status value)
public WorkstationCluster.Builder setConditions(int index, Status value)Output only. Status conditions describing the workstation cluster's current state.
repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setConditions(int index, Status.Builder builderForValue)
public WorkstationCluster.Builder setConditions(int index, Status.Builder builderForValue)Output only. Status conditions describing the workstation cluster's current state.
repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setControlPlaneIp(String value)
public WorkstationCluster.Builder setControlPlaneIp(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe controlPlaneIp to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setControlPlaneIpBytes(ByteString value)
public WorkstationCluster.Builder setControlPlaneIpBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for controlPlaneIp to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public WorkstationCluster.Builder setCreateTime(Timestamp value)Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public WorkstationCluster.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Time when this workstation cluster was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setDegraded(boolean value)
public WorkstationCluster.Builder setDegraded(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe degraded to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setDeleteTime(Timestamp value)
public WorkstationCluster.Builder setDeleteTime(Timestamp value)Output only. Time when this workstation cluster was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setDeleteTime(Timestamp.Builder builderForValue)
public WorkstationCluster.Builder setDeleteTime(Timestamp.Builder builderForValue)Output only. Time when this workstation cluster was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setDisplayName(String value)
public WorkstationCluster.Builder setDisplayName(String value)Optional. Human-readable name for this workstation cluster.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public WorkstationCluster.Builder setDisplayNameBytes(ByteString value)Optional. Human-readable name for this workstation cluster.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setDomainConfig(WorkstationCluster.DomainConfig value)
public WorkstationCluster.Builder setDomainConfig(WorkstationCluster.DomainConfig value)Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.DomainConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setDomainConfig(WorkstationCluster.DomainConfig.Builder builderForValue)
public WorkstationCluster.Builder setDomainConfig(WorkstationCluster.DomainConfig.Builder builderForValue)Optional. Configuration options for a custom domain.
.google.cloud.workstations.v1beta.WorkstationCluster.DomainConfig domain_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationCluster.DomainConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setEtag(String value)
public WorkstationCluster.Builder setEtag(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public WorkstationCluster.Builder setEtagBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setGatewayConfig(WorkstationCluster.GatewayConfig value)
public WorkstationCluster.Builder setGatewayConfig(WorkstationCluster.GatewayConfig value)Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.GatewayConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setGatewayConfig(WorkstationCluster.GatewayConfig.Builder builderForValue)
public WorkstationCluster.Builder setGatewayConfig(WorkstationCluster.GatewayConfig.Builder builderForValue)Optional. Configuration options for Cluster HTTP Gateway.
.google.cloud.workstations.v1beta.WorkstationCluster.GatewayConfig gateway_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationCluster.GatewayConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setName(String value)
public WorkstationCluster.Builder setName(String value)Identifier. Full name of this workstation cluster.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public WorkstationCluster.Builder setNameBytes(ByteString value)Identifier. Full name of this workstation cluster.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setNetwork(String value)
public WorkstationCluster.Builder setNetwork(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe network to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setNetworkBytes(ByteString value)
public WorkstationCluster.Builder setNetworkBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for network to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setPrivateClusterConfig(WorkstationCluster.PrivateClusterConfig value)
public WorkstationCluster.Builder setPrivateClusterConfig(WorkstationCluster.PrivateClusterConfig value)Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationCluster.PrivateClusterConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setPrivateClusterConfig(WorkstationCluster.PrivateClusterConfig.Builder builderForValue)
public WorkstationCluster.Builder setPrivateClusterConfig(WorkstationCluster.PrivateClusterConfig.Builder builderForValue)Optional. Configuration for private workstation cluster.
.google.cloud.workstations.v1beta.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationCluster.PrivateClusterConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setReconciling(boolean value)
public WorkstationCluster.Builder setReconciling(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe reconciling to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setSatisfiesPzi(boolean value)
public WorkstationCluster.Builder setSatisfiesPzi(boolean value)Output only. Reserved for future use.
bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe satisfiesPzi to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setSatisfiesPzs(boolean value)
public WorkstationCluster.Builder setSatisfiesPzs(boolean value)Output only. Reserved for future use.
bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe satisfiesPzs to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setSubnetwork(String value)
public WorkstationCluster.Builder setSubnetwork(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe subnetwork to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setSubnetworkBytes(ByteString value)
public WorkstationCluster.Builder setSubnetworkBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for subnetwork to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setUid(String value)
public WorkstationCluster.Builder setUid(String value)Output only. A system-assigned unique identifier for this workstation cluster.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public WorkstationCluster.Builder setUidBytes(ByteString value)Output only. A system-assigned unique identifier for this workstation cluster.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setUpdateTime(Timestamp value)
public WorkstationCluster.Builder setUpdateTime(Timestamp value)Output only. Time when this workstation cluster was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public WorkstationCluster.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Time when this workstation cluster was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
|
setWorkstationAuthorizationUrl(String value)
public WorkstationCluster.Builder setWorkstationAuthorizationUrl(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe workstationAuthorizationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setWorkstationAuthorizationUrlBytes(ByteString value)
public WorkstationCluster.Builder setWorkstationAuthorizationUrlBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for workstationAuthorizationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setWorkstationLaunchUrl(String value)
public WorkstationCluster.Builder setWorkstationLaunchUrl(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe workstationLaunchUrl to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |
setWorkstationLaunchUrlBytes(ByteString value)
public WorkstationCluster.Builder setWorkstationLaunchUrlBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for workstationLaunchUrl to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationCluster.Builder |
This builder for chaining. |