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.



1997
1998
1999
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1997

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


1837
1838
1839
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1837

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:



1842
1843
1844
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1842

def conditions
  @conditions
end

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

A Docker container. Corresponds to the JSON property container

Returns:



1847
1848
1849
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1847

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1852
1853
1854
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1852

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) 


1858
1859
1860
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1858

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) 


1864
1865
1866
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1864

def delete_time
  @delete_time
end

#disable_tcp_connections ⇒ Boolean Also known as: disable_tcp_connections?

Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. Corresponds to the JSON property disableTcpConnections

Returns:

  • (Boolean) 


1873
1874
1875
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1873

def disable_tcp_connections
  @disable_tcp_connections
end

#display_name ⇒ String

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

Returns:

  • (String) 


1879
1880
1881
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1879

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) 


1888
1889
1890
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1888

def enable_audit_agent
  @enable_audit_agent
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:



1898
1899
1900
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1898

def encryption_key
  @encryption_key
end

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

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

Returns:



1904
1905
1906
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1904

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) 


1911
1912
1913
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1911

def etag
  @etag
end

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

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

Returns:



1916
1917
1918
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1916

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) 


1926
1927
1928
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1926

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


1933
1934
1935
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1933

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1938
1939
1940
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1938

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:



1943
1944
1945
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1943

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:



1950
1951
1952
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1950

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) 


1956
1957
1958
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1956

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


1966
1967
1968
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1966

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) 


1983
1984
1985
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1983

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) 


1989
1990
1991
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1989

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) 


1995
1996
1997
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1995

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2002

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