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.



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

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


1435
1436
1437
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1435

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:



1440
1441
1442
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1440

def conditions
  @conditions
end

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

A Docker container. Corresponds to the JSON property container

Returns:



1445
1446
1447
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1445

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


1450
1451
1452
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1450

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) 


1457
1458
1459
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1457

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


1463
1464
1465
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1463

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

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

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

Returns:



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

def encryption_key
  @encryption_key
end

#etag ⇒ String

Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


1480
1481
1482
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1480

def etag
  @etag
end

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

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

Returns:



1485
1486
1487
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1485

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) 


1492
1493
1494
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1492

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


1498
1499
1500
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1498

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1503
1504
1505
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1503

def name
  @name
end

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

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

Returns:



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

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) 


1514
1515
1516
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1514

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


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

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) 


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

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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1540

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