Class: Google::Apis::WorkstationsV1::WorkstationCluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workstations_v1/classes.rb,
lib/google/apis/workstations_v1/representations.rb,
lib/google/apis/workstations_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkstationCluster

Returns a new instance of WorkstationCluster.



1698
1699
1700
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1698

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. Client-specified annotations. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1600
1601
1602
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1600

def annotations
  @annotations
end

#conditions ⇒ Array<Google::Apis::WorkstationsV1::Status>

Output only. Status conditions describing the workstation cluster's current state. Corresponds to the JSON property conditions

Returns:



1606
1607
1608
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1606

def conditions
  @conditions
end

#control_plane_ip ⇒ 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. Corresponds to the JSON property controlPlaneIp

Returns:

  • (String) 


1614
1615
1616
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1614

def control_plane_ip
  @control_plane_ip
end

#create_time ⇒ String

Output only. Time when this workstation cluster was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1619
1620
1621
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1619

def create_time
  @create_time
end

#degraded ⇒ Boolean Also known as: degraded?

Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. Corresponds to the JSON property degraded

Returns:

  • (Boolean) 


1626
1627
1628
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1626

def degraded
  @degraded
end

#delete_time ⇒ String

Output only. Time when this workstation cluster was soft-deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1632
1633
1634
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1632

def delete_time
  @delete_time
end

#display_name ⇒ String

Optional. Human-readable name for this workstation cluster. Corresponds to the JSON property displayName

Returns:

  • (String) 


1637
1638
1639
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1637

def display_name
  @display_name
end

#domain_config ⇒ Google::Apis::WorkstationsV1::DomainConfig

Configuration options for a custom domain. Corresponds to the JSON property domainConfig

Returns:



1642
1643
1644
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1642

def domain_config
  @domain_config
end

#etag ⇒ 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. Corresponds to the JSON property etag

Returns:

  • (String) 


1649
1650
1651
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1649

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1656
1657
1658
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1656

def labels
  @labels
end

#name ⇒ String

Identifier. Full name of this workstation cluster. Corresponds to the JSON property name

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1661

def name
  @name
end

#network ⇒ String

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. Corresponds to the JSON property network

Returns:

  • (String) 


1667
1668
1669
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1667

def network
  @network
end

#private_cluster_config ⇒ Google::Apis::WorkstationsV1::PrivateClusterConfig

Configuration options for private workstation clusters. Corresponds to the JSON property privateClusterConfig

Returns:



1672
1673
1674
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1672

def private_cluster_config
  @private_cluster_config
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


1678
1679
1680
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1678

def reconciling
  @reconciling
end

#subnetwork ⇒ 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. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


1686
1687
1688
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1686

def subnetwork
  @subnetwork
end

#uid ⇒ String

Output only. A system-assigned unique identifier for this workstation cluster. Corresponds to the JSON property uid

Returns:

  • (String) 


1691
1692
1693
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1691

def uid
  @uid
end

#update_time ⇒ String

Output only. Time when this workstation cluster was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1696
1697
1698
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1696

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1703

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @conditions = args[:conditions] if args.key?(:conditions)
  @control_plane_ip = args[:control_plane_ip] if args.key?(:control_plane_ip)
  @create_time = args[:create_time] if args.key?(:create_time)
  @degraded = args[:degraded] if args.key?(:degraded)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @domain_config = args[:domain_config] if args.key?(:domain_config)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end