Class: Google::Apis::CloudbuildV1::WorkerPool

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

Overview

Configuration for a WorkerPool. Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool. If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Private 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 private pools, see Private pools overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.



4558
4559
4560
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4558

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


4506
4507
4508
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4506

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) 


4511
4512
4513
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4511

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) 


4516
4517
4518
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4516

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) 


4522
4523
4524
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4522

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) 


4528
4529
4530
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4528

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) 


4536
4537
4538
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4536

def name
  @name
end

#private_pool_v1_config ⇒ Google::Apis::CloudbuildV1::PrivatePoolV1Config

Configuration for a V1 PrivatePool. Corresponds to the JSON property privatePoolV1Config

Returns:



4541
4542
4543
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4541

def private_pool_v1_config
  @private_pool_v1_config
end

#state ⇒ String

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

Returns:

  • (String) 


4546
4547
4548
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4546

def state
  @state
end

#uid ⇒ String

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

Returns:

  • (String) 


4551
4552
4553
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4551

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) 


4556
4557
4558
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4556

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 4563

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)
  @private_pool_v1_config = args[:private_pool_v1_config] if args.key?(:private_pool_v1_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)
end