Class: Google::Apis::CloudbuildV1beta1::WorkerPool

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

Overview

Configuration for a WorkerPool to run the builds. Workers provide a build environment where Cloud Build runs your builds. Cloud Build owns and maintains a pool of workers for general use. By default, when you submit a build, Cloud Build uses one of the workers from this pool. Builds that run in the default worker pool have access to the public internet. If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Custom WorkerPools give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of custom worker pools, see Custom workers overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.



2513
2514
2515
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2513

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


2456
2457
2458
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2456

def annotations
  @annotations
end

#create_time ⇒ String

Output only. Time at which the request to create the WorkerPool was received. Corresponds to the JSON property createTime

Returns:

  • (String) 


2461
2462
2463
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2461

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. Time at which the request to delete the WorkerPool was received. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


2466
2467
2468
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2466

def delete_time
  @delete_time
end

#display_name ⇒ String

A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


2472
2473
2474
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2472

def display_name
  @display_name
end

#etag ⇒ String

Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


2478
2479
2480
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2478

def etag
  @etag
end

#name ⇒ String

Output only. The resource name of the WorkerPool, with format projects/ project/locations/location/workerPools/worker_pool. The value of worker_poolis provided by `worker_pool_id` in `CreateWorkerPool` request and the value oflocation`is determined by the endpoint accessed. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2486
2487
2488
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2486

def name
  @name
end

#network_config ⇒ Google::Apis::CloudbuildV1beta1::NetworkConfig

Network describes the network configuration for a WorkerPool. Corresponds to the JSON property networkConfig

Returns:



2491
2492
2493
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2491

def network_config
  @network_config
end

#state ⇒ String

Output only. WorkerPool state. Corresponds to the JSON property state

Returns:

  • (String) 


2496
2497
2498
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2496

def state
  @state
end

#uid ⇒ String

Output only. A unique identifier for the WorkerPool. Corresponds to the JSON property uid

Returns:

  • (String) 


2501
2502
2503
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2501

def uid
  @uid
end

#update_time ⇒ String

Output only. Time at which the request to update the WorkerPool was received. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2506
2507
2508
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2506

def update_time
  @update_time
end

#worker_config ⇒ Google::Apis::CloudbuildV1beta1::WorkerConfig

Defines the configuration to be used for creating workers in the pool. Corresponds to the JSON property workerConfig

Returns:



2511
2512
2513
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2511

def worker_config
  @worker_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
 
# File 'lib/google/apis/cloudbuild_v1beta1/classes.rb', line 2518

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)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @state = args[:state] if args.key?(:state)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @worker_config = args[:worker_config] if args.key?(:worker_config)
end