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.



1543
1544
1545
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1543

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


1443
1444
1445
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1443

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:



1448
1449
1450
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1448

def conditions
  @conditions
end

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

A Docker container. Corresponds to the JSON property container

Returns:



1453
1454
1455
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1453

def container
  @container
end

#create_time ⇒ String

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

Returns:

  • (String) 


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

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) 


1465
1466
1467
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1465

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


1471
1472
1473
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1471

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


1476
1477
1478
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1476

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:



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

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) 


1488
1489
1490
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1488

def etag
  @etag
end

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

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

Returns:



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

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) 


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

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


1506
1507
1508
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1506

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1511
1512
1513
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1511

def name
  @name
end

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

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

Returns:



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

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) 


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

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) 


1531
1532
1533
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1531

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) 


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

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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 1548

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