Class: Google::Apis::RunV2::GoogleCloudRunV2WorkerPool

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/run_v2/classes.rb,
lib/google/apis/run_v2/representations.rb,
lib/google/apis/run_v2/representations.rb

Overview

WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRunV2WorkerPool

Returns a new instance of GoogleCloudRunV2WorkerPool.



4481
4482
4483
 
# File 'lib/google/apis/run_v2/classes.rb', line 4481

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


4273
4274
4275
 
# File 'lib/google/apis/run_v2/classes.rb', line 4273

def annotations
  @annotations
end

#binary_authorization ⇒ Google::Apis::RunV2::GoogleCloudRunV2BinaryAuthorization

Settings for Binary Authorization feature. Corresponds to the JSON property binaryAuthorization

Returns:



4278
4279
4280
 
# File 'lib/google/apis/run_v2/classes.rb', line 4278

def binary_authorization
  @binary_authorization
end

#client ⇒ String

Arbitrary identifier for the API client. Corresponds to the JSON property client

Returns:

  • (String) 


4283
4284
4285
 
# File 'lib/google/apis/run_v2/classes.rb', line 4283

def client
  @client
end

#client_version ⇒ String

Arbitrary version identifier for the API client. Corresponds to the JSON property clientVersion

Returns:

  • (String) 


4288
4289
4290
 
# File 'lib/google/apis/run_v2/classes.rb', line 4288

def client_version
  @client_version
end

#conditions ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2Condition>

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property conditions

Returns:



4296
4297
4298
 
# File 'lib/google/apis/run_v2/classes.rb', line 4296

def conditions
  @conditions
end

#create_time ⇒ String

Output only. The creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


4301
4302
4303
 
# File 'lib/google/apis/run_v2/classes.rb', line 4301

def create_time
  @create_time
end

#creator ⇒ String

Output only. Email address of the authenticated creator. Corresponds to the JSON property creator

Returns:

  • (String) 


4306
4307
4308
 
# File 'lib/google/apis/run_v2/classes.rb', line 4306

def creator
  @creator
end

#custom_audiences ⇒ Array<String>

Deprecated: Not supported, and ignored by Cloud Run. Corresponds to the JSON property customAudiences

Returns:

  • (Array<String>) 


4311
4312
4313
 
# File 'lib/google/apis/run_v2/classes.rb', line 4311

def custom_audiences
  @custom_audiences
end

#delete_time ⇒ String

Output only. The deletion time. It is only populated as a response to a Delete request. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


4317
4318
4319
 
# File 'lib/google/apis/run_v2/classes.rb', line 4317

def delete_time
  @delete_time
end

#description ⇒ String

User-provided description of the WorkerPool. This field currently has a 512- character limit. Corresponds to the JSON property description

Returns:

  • (String) 


4323
4324
4325
 
# File 'lib/google/apis/run_v2/classes.rb', line 4323

def description
  @description
end

#etag ⇒ String

Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. Corresponds to the JSON property etag

Returns:

  • (String) 


4329
4330
4331
 
# File 'lib/google/apis/run_v2/classes.rb', line 4329

def etag
  @etag
end

#expire_time ⇒ String

Output only. For a deleted resource, the time after which it will be permamently deleted. Corresponds to the JSON property expireTime

Returns:

  • (String) 


4335
4336
4337
 
# File 'lib/google/apis/run_v2/classes.rb', line 4335

def expire_time
  @expire_time
end

#generation ⇒ Fixnum

Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer. Corresponds to the JSON property generation

Returns:

  • (Fixnum) 


4343
4344
4345
 
# File 'lib/google/apis/run_v2/classes.rb', line 4343

def generation
  @generation
end

#instance_split_statuses ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2InstanceSplitStatus>

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property instanceSplitStatuses

Returns:



4350
4351
4352
 
# File 'lib/google/apis/run_v2/classes.rb', line 4350

def instance_split_statuses
  @instance_split_statuses
end

#instance_splits ⇒ Array<Google::Apis::RunV2::GoogleCloudRunV2InstanceSplit>

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision. Corresponds to the JSON property instanceSplits

Returns:



4357
4358
4359
 
# File 'lib/google/apis/run_v2/classes.rb', line 4357

def instance_splits
  @instance_splits
end

#labels ⇒ Hash<String,String>

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud. google.com/resource-manager/docs/creating-managing-labels or https://cloud. google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev , or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4370
4371
4372
 
# File 'lib/google/apis/run_v2/classes.rb', line 4370

def labels
  @labels
end

#last_modifier ⇒ String

Output only. Email address of the last authenticated modifier. Corresponds to the JSON property lastModifier

Returns:

  • (String) 


4375
4376
4377
 
# File 'lib/google/apis/run_v2/classes.rb', line 4375

def last_modifier
  @last_modifier
end

#latest_created_revision ⇒ String

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property latestCreatedRevision

Returns:

  • (String) 


4381
4382
4383
 
# File 'lib/google/apis/run_v2/classes.rb', line 4381

def latest_created_revision
  @latest_created_revision
end

#latest_ready_revision ⇒ String

Output only. Name of the latest revision that is serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run. Corresponds to the JSON property latestReadyRevision

Returns:

  • (String) 


4388
4389
4390
 
# File 'lib/google/apis/run_v2/classes.rb', line 4388

def latest_ready_revision
  @latest_ready_revision
end

#launch_stage ⇒ String

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Corresponds to the JSON property launchStage

Returns:

  • (String) 


4399
4400
4401
 
# File 'lib/google/apis/run_v2/classes.rb', line 4399

def launch_stage
  @launch_stage
end

#name ⇒ String

The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/project/locations/ location/workerPools/worker_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


4407
4408
4409
 
# File 'lib/google/apis/run_v2/classes.rb', line 4407

def name
  @name
end

#observed_generation ⇒ Fixnum

Output only. The generation of this WorkerPool currently serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer. Corresponds to the JSON property observedGeneration

Returns:

  • (Fixnum) 


4416
4417
4418
 
# File 'lib/google/apis/run_v2/classes.rb', line 4416

def observed_generation
  @observed_generation
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, instance_split_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: instance_splits and instance_split_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, instance_split_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in terminal_condition and conditions. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


4438
4439
4440
 
# File 'lib/google/apis/run_v2/classes.rb', line 4438

def reconciling
  @reconciling
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


4444
4445
4446
 
# File 'lib/google/apis/run_v2/classes.rb', line 4444

def satisfies_pzs
  @satisfies_pzs
end

#scaling ⇒ Google::Apis::RunV2::GoogleCloudRunV2WorkerPoolScaling

Worker pool scaling settings. Corresponds to the JSON property scaling

Returns:



4450
4451
4452
 
# File 'lib/google/apis/run_v2/classes.rb', line 4450

def scaling
  @scaling
end

#template ⇒ Google::Apis::RunV2::GoogleCloudRunV2WorkerPoolRevisionTemplate

WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. Corresponds to the JSON property template

Returns:



4456
4457
4458
 
# File 'lib/google/apis/run_v2/classes.rb', line 4456

def template
  @template
end

#terminal_condition ⇒ Google::Apis::RunV2::GoogleCloudRunV2Condition

Defines a status condition for a resource. Corresponds to the JSON property terminalCondition

Returns:



4461
4462
4463
 
# File 'lib/google/apis/run_v2/classes.rb', line 4461

def terminal_condition
  @terminal_condition
end

#threat_detection_enabled ⇒ Boolean Also known as: threat_detection_enabled?

Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. Corresponds to the JSON property threatDetectionEnabled

Returns:

  • (Boolean) 


4467
4468
4469
 
# File 'lib/google/apis/run_v2/classes.rb', line 4467

def threat_detection_enabled
  @threat_detection_enabled
end

#uid ⇒ String

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. Corresponds to the JSON property uid

Returns:

  • (String) 


4474
4475
4476
 
# File 'lib/google/apis/run_v2/classes.rb', line 4474

def uid
  @uid
end

#update_time ⇒ String

Output only. The last-modified time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4479
4480
4481
 
# File 'lib/google/apis/run_v2/classes.rb', line 4479

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
 
# File 'lib/google/apis/run_v2/classes.rb', line 4486

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @binary_authorization = args[:binary_authorization] if args.key?(:binary_authorization)
  @client = args[:client] if args.key?(:client)
  @client_version = args[:client_version] if args.key?(:client_version)
  @conditions = args[:conditions] if args.key?(:conditions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator = args[:creator] if args.key?(:creator)
  @custom_audiences = args[:custom_audiences] if args.key?(:custom_audiences)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @generation = args[:generation] if args.key?(:generation)
  @instance_split_statuses = args[:instance_split_statuses] if args.key?(:instance_split_statuses)
  @instance_splits = args[:instance_splits] if args.key?(:instance_splits)
  @labels = args[:labels] if args.key?(:labels)
  @last_modifier = args[:last_modifier] if args.key?(:last_modifier)
  @latest_created_revision = args[:latest_created_revision] if args.key?(:latest_created_revision)
  @latest_ready_revision = args[:latest_ready_revision] if args.key?(:latest_ready_revision)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @name = args[:name] if args.key?(:name)
  @observed_generation = args[:observed_generation] if args.key?(:observed_generation)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @scaling = args[:scaling] if args.key?(:scaling)
  @template = args[:template] if args.key?(:template)
  @terminal_condition = args[:terminal_condition] if args.key?(:terminal_condition)
  @threat_detection_enabled = args[:threat_detection_enabled] if args.key?(:threat_detection_enabled)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end