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.



2056
2057
2058
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2056

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

Instance Attribute Details

#allowed_ports ⇒ Array<Google::Apis::WorkstationsV1::PortRange>

Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. Corresponds to the JSON property allowedPorts

Returns:



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

def allowed_ports
  @allowed_ports
end

#annotations ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1892
1893
1894
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1892

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:



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

def conditions
  @conditions
end

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

A Docker container. Corresponds to the JSON property container

Returns:



1902
1903
1904
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1902

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1907
1908
1909
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1907

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) 


1913
1914
1915
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1913

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) 


1919
1920
1921
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1919

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) 


1928
1929
1930
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1928

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) 


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

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 roles/logging. logWriter and roles/monitoring.metricWriter on the project. Operating system audit logging is distinct from Cloud Audit Logs and Container output logging. Operating system audit logs are available in the Cloud Logging console by querying: resource.type="gce_instance" log_name:"/ logs/linux-auditd" Corresponds to the JSON property enableAuditAgent

Returns:

  • (Boolean) 


1947
1948
1949
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1947

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:



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

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:



1963
1964
1965
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1963

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) 


1970
1971
1972
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1970

def etag
  @etag
end

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

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

Returns:



1975
1976
1977
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1975

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) 


1985
1986
1987
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1985

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


1992
1993
1994
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1992

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


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

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:



2002
2003
2004
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2002

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:



2009
2010
2011
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2009

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) 


2015
2016
2017
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2015

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


2025
2026
2027
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2025

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) 


2042
2043
2044
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2042

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) 


2048
2049
2050
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2048

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) 


2054
2055
2056
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2054

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 2061

def update!(**args)
  @allowed_ports = args[:allowed_ports] if args.key?(:allowed_ports)
  @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