public sealed class WorkstationCluster : IMessage<WorkstationCluster>, IEquatable<WorkstationCluster>, IDeepCloneable<WorkstationCluster>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Workstations v1 API class WorkstationCluster.
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.
Implements
IMessageWorkstationCluster, IEquatableWorkstationCluster, IDeepCloneableWorkstationCluster, IBufferMessage, IMessageNamespace
Google.Cloud.Workstations.V1Assembly
Google.Cloud.Workstations.V1.dll
Constructors
WorkstationCluster()
public WorkstationCluster()WorkstationCluster(WorkstationCluster)
public WorkstationCluster(WorkstationCluster other)| Parameter | |
|---|---|
| Name | Description |
other |
WorkstationCluster |
Properties
Annotations
public MapField<string, string> Annotations { get; }Optional. Client-specified annotations.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Conditions
public RepeatedField<Status> Conditions { get; }Output only. Status conditions describing the workstation cluster's current state.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldStatus |
|
ControlPlaneIp
public string ControlPlaneIp { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time when this workstation cluster was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Degraded
public bool Degraded { get; set; }Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The [conditions][google.cloud.workstations.v1.WorkstationCluster.conditions] field contains detailed information about the status of the cluster.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DeleteTime
public Timestamp DeleteTime { get; set; }Output only. Time when this workstation cluster was soft-deleted.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DisplayName
public string DisplayName { get; set; }Optional. Human-readable name for this workstation cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DomainConfig
public WorkstationCluster.Types.DomainConfig DomainConfig { get; set; }Optional. Configuration options for a custom domain.
| Property Value | |
|---|---|
| Type | Description |
WorkstationClusterTypesDomainConfig |
|
Etag
public string Etag { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
GatewayConfig
public WorkstationCluster.Types.GatewayConfig GatewayConfig { get; set; }Optional. Configuration options for Cluster HTTP Gateway.
| Property Value | |
|---|---|
| Type | Description |
WorkstationClusterTypesGatewayConfig |
|
Labels
public MapField<string, string> Labels { get; }Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }Identifier. Full name of this workstation cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Network
public string Network { get; set; }Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PrivateClusterConfig
public WorkstationCluster.Types.PrivateClusterConfig PrivateClusterConfig { get; set; }Optional. Configuration for private workstation cluster.
| Property Value | |
|---|---|
| Type | Description |
WorkstationClusterTypesPrivateClusterConfig |
|
Reconciling
public bool Reconciling { get; set; }Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Subnetwork
public string Subnetwork { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Tags
public MapField<string, string> Tags { get; }Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Uid
public string Uid { get; set; }Output only. A system-assigned unique identifier for this workstation cluster.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Time when this workstation cluster was most recently updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
WorkstationAuthorizationUrl
public string WorkstationAuthorizationUrl { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
WorkstationClusterName
public WorkstationClusterName WorkstationClusterName { get; set; }WorkstationClusterName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
WorkstationClusterName |
|
WorkstationLaunchUrl
public string WorkstationLaunchUrl { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|