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 set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkstationConfig

Returns a new instance of WorkstationConfig.



1577
1578
1579
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1577

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Client-specified annotations. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1468
1469
1470
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1468

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:



1473
1474
1475
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1473

def conditions
  @conditions
end

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

A Docker container. Corresponds to the JSON property container

Returns:



1478
1479
1480
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1478

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1483
1484
1485
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1483

def create_time
  @create_time
end

#degraded ⇒ Boolean Also known as: degraded?

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

Returns:

  • (Boolean) 


1490
1491
1492
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1490

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


1496
1497
1498
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1496

def delete_time
  @delete_time
end

#display_name ⇒ String

Human-readable name for this resource. Corresponds to the JSON property displayName

Returns:

  • (String) 


1501
1502
1503
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1501

def display_name
  @display_name
end

#enable_audit_agent ⇒ Boolean Also known as: enable_audit_agent?

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) 


1509
1510
1511
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1509

def enable_audit_agent
  @enable_audit_agent
end

#encryption_key ⇒ Google::Apis::WorkstationsV1beta::CustomerEncryptionKey

A customer-managed encryption key for the Compute Engine resources of this workstation configuration. Corresponds to the JSON property encryptionKey

Returns:



1516
1517
1518
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1516

def encryption_key
  @encryption_key
end

#etag ⇒ String

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) 


1522
1523
1524
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1522

def etag
  @etag
end

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

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

Returns:



1527
1528
1529
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1527

def host
  @host
end

#idle_timeout ⇒ String

How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. Corresponds to the JSON property idleTimeout

Returns:

  • (String) 


1534
1535
1536
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1534

def idle_timeout
  @idle_timeout
end

#labels ⇒ Hash<String,String>

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1540
1541
1542
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1540

def labels
  @labels
end

#name ⇒ String

Full name of this resource. Corresponds to the JSON property name

Returns:

  • (String) 


1545
1546
1547
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1545

def name
  @name
end

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

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

Returns:



1550
1551
1552
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1550

def persistent_directories
  @persistent_directories
end

#reconciling ⇒ Boolean Also known as: reconciling?

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

Returns:

  • (Boolean) 


1556
1557
1558
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1556

def reconciling
  @reconciling
end

#running_timeout ⇒ String

How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. Corresponds to the JSON property runningTimeout

Returns:

  • (String) 


1565
1566
1567
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1565

def running_timeout
  @running_timeout
end

#uid ⇒ String

Output only. A system-assigned unique identified for this resource. Corresponds to the JSON property uid

Returns:

  • (String) 


1570
1571
1572
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1570

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1575
1576
1577
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1575

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1582

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