Class: Google::Apis::WorkstationsV1beta::WorkstationConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workstations_v1beta/classes.rb,
lib/google/apis/workstations_v1beta/representations.rb,
lib/google/apis/workstations_v1beta/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.



1857
1858
1859
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1857

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


1707
1708
1709
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1707

def annotations
  @annotations
end

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

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

Returns:



1712
1713
1714
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1712

def conditions
  @conditions
end

#container ⇒ Google::Apis::WorkstationsV1beta::Container

A Docker container. Corresponds to the JSON property container

Returns:



1717
1718
1719
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1717

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1722
1723
1724
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1722

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) 


1728
1729
1730
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1728

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) 


1734
1735
1736
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1734

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) 


1739
1740
1741
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1739

def display_name
  @display_name
end

#enable_audit_agent ⇒ Boolean Also known as: enable_audit_agent?

Optional. Whether to enable Linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets. write permission on the project. Operating system audit logging is distinct from Cloud Audit Logs. Corresponds to the JSON property enableAuditAgent

Returns:

  • (Boolean) 


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

def enable_audit_agent
  @enable_audit_agent
end

#encryption_key ⇒ Google::Apis::WorkstationsV1beta::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:



1758
1759
1760
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1758

def encryption_key
  @encryption_key
end

#ephemeral_directories ⇒ Array<Google::Apis::WorkstationsV1beta::EphemeralDirectory>

Optional. Ephemeral directories which won't persist across workstation sessions. Corresponds to the JSON property ephemeralDirectories

Returns:



1764
1765
1766
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1764

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


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

def etag
  @etag
end

#host ⇒ Google::Apis::WorkstationsV1beta::Host

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

Returns:



1776
1777
1778
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1776

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) 


1786
1787
1788
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1786

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


1793
1794
1795
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1793

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1798
1799
1800
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1798

def name
  @name
end

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

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

Returns:



1803
1804
1805
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1803

def persistent_directories
  @persistent_directories
end

#readiness_checks ⇒ Array<Google::Apis::WorkstationsV1beta::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:



1810
1811
1812
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1810

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) 


1816
1817
1818
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1816

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


1826
1827
1828
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1826

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) 


1843
1844
1845
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1843

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) 


1849
1850
1851
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1849

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) 


1855
1856
1857
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1855

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1862

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)
  @enable_audit_agent = args[:enable_audit_agent] if args.key?(:enable_audit_agent)
  @encryption_key = args[:encryption_key] if args.key?(:encryption_key)
  @ephemeral_directories = args[:ephemeral_directories] if args.key?(:ephemeral_directories)
  @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