Cloud Workstations V1 API - Class Google::Cloud::Workstations::V1::WorkstationCluster (v1.6.0)

Reference documentation and code samples for the Cloud Workstations V1 API class Google::Cloud::Workstations::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Client-specified annotations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Client-specified annotations.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Client-specified annotations.

#conditions

def conditions() -> ::Array<::Google::Rpc::Status>
Returns
  • (::Array<::Google::Rpc::Status>) — Output only. Status conditions describing the workstation cluster's current state.

#control_plane_ip

def control_plane_ip() -> ::String
Returns
  • (::String) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#degraded

def degraded() -> ::Boolean
Returns
  • (::Boolean) — 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.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Human-readable name for this workstation cluster.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Human-readable name for this workstation cluster.
Returns
  • (::String) — Optional. Human-readable name for this workstation cluster.

#domain_config

def domain_config() -> ::Google::Cloud::Workstations::V1::WorkstationCluster::DomainConfig
Returns

#domain_config=

def domain_config=(value) -> ::Google::Cloud::Workstations::V1::WorkstationCluster::DomainConfig
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#gateway_config

def gateway_config() -> ::Google::Cloud::Workstations::V1::WorkstationCluster::GatewayConfig
Returns

#gateway_config=

def gateway_config=(value) -> ::Google::Cloud::Workstations::V1::WorkstationCluster::GatewayConfig
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Full name of this workstation cluster.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Full name of this workstation cluster.
Returns
  • (::String) — Identifier. Full name of this workstation cluster.

#network

def network() -> ::String
Returns
  • (::String) — Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
Returns
  • (::String) — Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

#private_cluster_config

def private_cluster_config() -> ::Google::Cloud::Workstations::V1::WorkstationCluster::PrivateClusterConfig
Returns

#private_cluster_config=

def private_cluster_config=(value) -> ::Google::Cloud::Workstations::V1::WorkstationCluster::PrivateClusterConfig
Parameter
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.

#subnetwork

def subnetwork() -> ::String
Returns
  • (::String) — 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.

#subnetwork=

def subnetwork=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#tags

def tags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

#tags=

def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. A system-assigned unique identifier for this workstation cluster.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#workstation_authorization_url

def workstation_authorization_url() -> ::String
Returns
  • (::String) — 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.

#workstation_authorization_url=

def workstation_authorization_url=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#workstation_launch_url

def workstation_launch_url() -> ::String
Returns
  • (::String) — 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.

#workstation_launch_url=

def workstation_launch_url=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.