Class: Google::Apis::WorkstationsV1::Workstation

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 single instance of a developer workstation with its own persistent storage.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Workstation

Returns a new instance of Workstation.



1668
1669
1670
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1668

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


1583
1584
1585
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1583

def annotations
  @annotations
end

#create_time ⇒ String

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

Returns:

  • (String) 


1588
1589
1590
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1588

def create_time
  @create_time
end

#delete_time ⇒ String

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

Returns:

  • (String) 


1593
1594
1595
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1593

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


1598
1599
1600
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1598

def display_name
  @display_name
end

#env ⇒ Hash<String,String>

Optional. Environment variables passed to the workstation container's entrypoint. Corresponds to the JSON property env

Returns:

  • (Hash<String,String>) 


1604
1605
1606
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1604

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


1611
1612
1613
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1611

def etag
  @etag
end

#host ⇒ String

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format port`-`host. Corresponds to the JSON property host

Returns:

  • (String) 


1619
1620
1621
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1619

def host
  @host
end

#kms_key ⇒ String

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*. Corresponds to the JSON property kmsKey

Returns:

  • (String) 


1626
1627
1628
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1626

def kms_key
  @kms_key
end

#labels ⇒ Hash<String,String>

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1633
1634
1635
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1633

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1638
1639
1640
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1638

def name
  @name
end

#reconciling ⇒ Boolean Also known as: reconciling?

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

Returns:

  • (Boolean) 


1644
1645
1646
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1644

def reconciling
  @reconciling
end

#start_time ⇒ String

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. Corresponds to the JSON property startTime

Returns:

  • (String) 


1651
1652
1653
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1651

def start_time
  @start_time
end

#state ⇒ String

Output only. Current state of the workstation. Corresponds to the JSON property state

Returns:

  • (String) 


1656
1657
1658
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1656

def state
  @state
end

#uid ⇒ String

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

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1661

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1666
1667
1668
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1666

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1673

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @env = args[:env] if args.key?(:env)
  @etag = args[:etag] if args.key?(:etag)
  @host = args[:host] if args.key?(:host)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end