Class: Google::Apis::WorkstationsV1beta::WorkstationCluster

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 workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkstationCluster

Returns a new instance of WorkstationCluster.



2324
2325
2326
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2324

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


2181
2182
2183
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2181

def annotations
  @annotations
end

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

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

Returns:



2187
2188
2189
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2187

def conditions
  @conditions
end

#control_plane_ip ⇒ String

Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. Corresponds to the JSON property controlPlaneIp

Returns:

  • (String) 


2195
2196
2197
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2195

def control_plane_ip
  @control_plane_ip
end

#create_time ⇒ String

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

Returns:

  • (String) 


2200
2201
2202
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2200

def create_time
  @create_time
end

#degraded ⇒ Boolean Also known as: degraded?

Output only. Whether this workstation cluster 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 cluster. Corresponds to the JSON property degraded

Returns:

  • (Boolean) 


2207
2208
2209
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2207

def degraded
  @degraded
end

#delete_time ⇒ String

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

Returns:

  • (String) 


2213
2214
2215
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2213

def delete_time
  @delete_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


2218
2219
2220
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2218

def display_name
  @display_name
end

#domain_config ⇒ Google::Apis::WorkstationsV1beta::DomainConfig

Configuration options for a custom domain. Corresponds to the JSON property domainConfig

Returns:



2223
2224
2225
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2223

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


2230
2231
2232
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2230

def etag
  @etag
end

#gateway_config ⇒ Google::Apis::WorkstationsV1beta::GatewayConfig

Configuration options for Cluster HTTP Gateway. Corresponds to the JSON property gatewayConfig

Returns:



2235
2236
2237
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2235

def gateway_config
  @gateway_config
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2242
2243
2244
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2242

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


2247
2248
2249
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2247

def name
  @name
end

#network ⇒ String

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. Corresponds to the JSON property network

Returns:

  • (String) 


2253
2254
2255
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2253

def network
  @network
end

#private_cluster_config ⇒ Google::Apis::WorkstationsV1beta::PrivateClusterConfig

Configuration options for private workstation clusters. Corresponds to the JSON property privateClusterConfig

Returns:



2258
2259
2260
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2258

def private_cluster_config
  @private_cluster_config
end

#reconciling ⇒ Boolean Also known as: reconciling?

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

Returns:

  • (Boolean) 


2264
2265
2266
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2264

def reconciling
  @reconciling
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


2270
2271
2272
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2270

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) 


2276
2277
2278
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2276

def satisfies_pzs
  @satisfies_pzs
end

#subnetwork ⇒ String

Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


2284
2285
2286
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2284

def subnetwork
  @subnetwork
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


2291
2292
2293
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2291

def tags
  @tags
end

#uid ⇒ String

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

Returns:

  • (String) 


2296
2297
2298
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2296

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


2301
2302
2303
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2301

def update_time
  @update_time
end

#workstation_authorization_url ⇒ String

Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded state query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using GenerateAccessToken and redirecting back to the original hostname with the token. Corresponds to the JSON property workstationAuthorizationUrl

Returns:

  • (String) 


2311
2312
2313
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2311

def workstation_authorization_url
  @workstation_authorization_url
end

#workstation_launch_url ⇒ String

Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a workstation and project query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches STATE_RUNNING, and then issuing a redirect to the workstation's host URL. Corresponds to the JSON property workstationLaunchUrl

Returns:

  • (String) 


2322
2323
2324
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2322

def workstation_launch_url
  @workstation_launch_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 2329

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @conditions = args[:conditions] if args.key?(:conditions)
  @control_plane_ip = args[:control_plane_ip] if args.key?(:control_plane_ip)
  @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)
  @domain_config = args[:domain_config] if args.key?(:domain_config)
  @etag = args[:etag] if args.key?(:etag)
  @gateway_config = args[:gateway_config] if args.key?(:gateway_config)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @tags = args[:tags] if args.key?(:tags)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @workstation_authorization_url = args[:workstation_authorization_url] if args.key?(:workstation_authorization_url)
  @workstation_launch_url = args[:workstation_launch_url] if args.key?(:workstation_launch_url)
end