Class: Google::Apis::WorkstationsV1::WorkstationConfig

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 configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkstationConfig

Returns a new instance of WorkstationConfig.



1802
1803
1804
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1802

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>) 


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

def annotations
  @annotations
end

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

Output only. Status conditions describing the current resource state. Corresponds to the JSON property conditions

Returns:



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

def conditions
  @conditions
end

#container ⇒ Google::Apis::WorkstationsV1::Container

A Docker container. Corresponds to the JSON property container

Returns:



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

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1683
1684
1685
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1683

def create_time
  @create_time
end

#degraded ⇒ Boolean Also known as: degraded?

Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field. Corresponds to the JSON property degraded

Returns:

  • (Boolean) 


1689
1690
1691
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1689

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


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

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


1700
1701
1702
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1700

def display_name
  @display_name
end

#encryption_key ⇒ Google::Apis::WorkstationsV1::CustomerEncryptionKey

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices. Corresponds to the JSON property encryptionKey

Returns:



1709
1710
1711
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1709

def encryption_key
  @encryption_key
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) 


1716
1717
1718
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1716

def etag
  @etag
end

#host ⇒ Google::Apis::WorkstationsV1::Host

Runtime host for a workstation. Corresponds to the JSON property host

Returns:



1721
1722
1723
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1721

def host
  @host
end

#idle_timeout ⇒ String

Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of "0s" indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide duration terminated by s for seconds— for example, "7200s" (2 hours). The default is "1200s" (20 minutes). Corresponds to the JSON property idleTimeout

Returns:

  • (String) 


1731
1732
1733
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1731

def idle_timeout
  @idle_timeout
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1738
1739
1740
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1738

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1743
1744
1745
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1743

def name
  @name
end

#persistent_directories ⇒ Array<Google::Apis::WorkstationsV1::PersistentDirectory>

Optional. Directories to persist across workstation sessions. Corresponds to the JSON property persistentDirectories

Returns:



1748
1749
1750
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1748

def persistent_directories
  @persistent_directories
end

#readiness_checks ⇒ Array<Google::Apis::WorkstationsV1::ReadinessCheck>

Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. Corresponds to the JSON property readinessChecks

Returns:



1755
1756
1757
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1755

def readiness_checks
  @readiness_checks
end

#reconciling ⇒ Boolean Also known as: reconciling?

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

Returns:

  • (Boolean) 


1761
1762
1763
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1761

def reconciling
  @reconciling
end

#replica_zones ⇒ Array<String>

Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, ['us-central1-a', 'us- central1-f']. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. Corresponds to the JSON property replicaZones

Returns:

  • (Array<String>) 


1771
1772
1773
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1771

def replica_zones
  @replica_zones
end

#running_timeout ⇒ String

Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by s for seconds—for example, "54000s" (15 hours). Defaults to "43200s" (12 hours). A value of "0s" indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than "0s" and less than "86400s" (24 hours). Warning: A value of "0s" indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. Corresponds to the JSON property runningTimeout

Returns:

  • (String) 


1788
1789
1790
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1788

def running_timeout
  @running_timeout
end

#uid ⇒ String

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

Returns:

  • (String) 


1794
1795
1796
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1794

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1800
1801
1802
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1800

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1807

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @conditions = args[:conditions] if args.key?(:conditions)
  @container = args[:container] if args.key?(:container)
  @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)
  @encryption_key = args[:encryption_key] if args.key?(:encryption_key)
  @etag = args[:etag] if args.key?(:etag)
  @host = args[:host] if args.key?(:host)
  @idle_timeout = args[:idle_timeout] if args.key?(:idle_timeout)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @persistent_directories = args[:persistent_directories] if args.key?(:persistent_directories)
  @readiness_checks = args[:readiness_checks] if args.key?(:readiness_checks)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @replica_zones = args[:replica_zones] if args.key?(:replica_zones)
  @running_timeout = args[:running_timeout] if args.key?(:running_timeout)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end