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.



1717
1718
1719
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1717

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


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

def annotations
  @annotations
end

#create_time ⇒ String

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

Returns:

  • (String) 


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

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) 


1642
1643
1644
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1642

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


1647
1648
1649
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1647

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


1653
1654
1655
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1653

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) 


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

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) 


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

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) 


1675
1676
1677
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1675

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


1682
1683
1684
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1682

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1687
1688
1689
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1687

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) 


1693
1694
1695
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1693

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) 


1700
1701
1702
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1700

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1705
1706
1707
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1705

def state
  @state
end

#uid ⇒ String

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

Returns:

  • (String) 


1710
1711
1712
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1710

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) 


1715
1716
1717
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1715

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
 
# File 'lib/google/apis/workstations_v1/classes.rb', line 1722

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