Class: Google::Apis::WorkstationsV1beta::Workstation

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



2167
2168
2169
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2167

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


2035
2036
2037
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2035

def annotations
  @annotations
end

#boost_configs ⇒ Array<Google::Apis::WorkstationsV1beta::WorkstationBoostConfig>

Output only. List of available boost configuration IDs that this workstation can be boosted up to. Corresponds to the JSON property boostConfigs

Returns:



2041
2042
2043
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2041

def boost_configs
  @boost_configs
end

#conditions ⇒ Array<Google::Apis::WorkstationsV1beta::Status>

Output only. Status conditions describing the workstation's current state. Corresponds to the JSON property conditions

Returns:



2046
2047
2048
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2046

def conditions
  @conditions
end

#create_time ⇒ String

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

Returns:

  • (String) 


2051
2052
2053
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2051

def create_time
  @create_time
end

#degraded ⇒ Boolean Also known as: degraded?

Output only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the workstation. Corresponds to the JSON property degraded

Returns:

  • (Boolean) 


2058
2059
2060
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2058

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


2064
2065
2066
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2064

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


2069
2070
2071
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2069

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


2075
2076
2077
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2075

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) 


2082
2083
2084
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2082

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) 


2090
2091
2092
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2090

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) 


2097
2098
2099
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2097

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


2104
2105
2106
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2104

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


2109
2110
2111
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2109

def name
  @name
end

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

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

Returns:



2114
2115
2116
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2114

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


2120
2121
2122
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2120

def reconciling
  @reconciling
end

#runtime_host ⇒ Google::Apis::WorkstationsV1beta::RuntimeHost

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

Returns:



2126
2127
2128
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2126

def runtime_host
  @runtime_host
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


2131
2132
2133
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2131

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2137
2138
2139
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2137

def satisfies_pzs
  @satisfies_pzs
end

#source_workstation ⇒ String

Optional. The source workstation from which this workstation's persistent directories were cloned on creation. Corresponds to the JSON property sourceWorkstation

Returns:

  • (String) 


2144
2145
2146
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2144

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


2150
2151
2152
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2150

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


2155
2156
2157
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2155

def state
  @state
end

#uid ⇒ String

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

Returns:

  • (String) 


2160
2161
2162
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2160

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) 


2165
2166
2167
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2165

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2172

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @boost_configs = args[:boost_configs] if args.key?(:boost_configs)
  @conditions = args[:conditions] if args.key?(:conditions)
  @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)
  @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)
  @persistent_directories = args[:persistent_directories] if args.key?(:persistent_directories)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @runtime_host = args[:runtime_host] if args.key?(:runtime_host)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @source_workstation = args[:source_workstation] if args.key?(:source_workstation)
  @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