Class: Google::Apis::CloudbuildV1alpha1::WorkerPool

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

Overview

Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.



2002
2003
2004
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 2002

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


1949
1950
1951
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1949

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) 


1954
1955
1956
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1954

def delete_time
  @delete_time
end

#name ⇒ String

User-defined name of the WorkerPool. Corresponds to the JSON property name

Returns:

  • (String) 


1959
1960
1961
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1959

def name
  @name
end

#project_id ⇒ String

The project ID of the GCP project for which the WorkerPool is created. Corresponds to the JSON property projectId

Returns:

  • (String) 


1964
1965
1966
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1964

def project_id
  @project_id
end

#regions ⇒ Array<String>

List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region. Corresponds to the JSON property regions

Returns:

  • (Array<String>) 


1972
1973
1974
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1972

def regions
  @regions
end

#service_account_email ⇒ String

Output only. The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level. Corresponds to the JSON property serviceAccountEmail

Returns:

  • (String) 


1979
1980
1981
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1979

def 
  @service_account_email
end

#status ⇒ String

Output only. WorkerPool Status. Corresponds to the JSON property status

Returns:

  • (String) 


1984
1985
1986
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1984

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


1989
1990
1991
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1989

def update_time
  @update_time
end

#worker_config ⇒ Google::Apis::CloudbuildV1alpha1::WorkerConfig

WorkerConfig defines the configuration to be used for a creating workers in the pool. Corresponds to the JSON property workerConfig

Returns:



1995
1996
1997
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 1995

def worker_config
  @worker_config
end

#worker_count ⇒ Fixnum

Total number of workers to be created across all requested regions. Corresponds to the JSON property workerCount

Returns:

  • (Fixnum) 


2000
2001
2002
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 2000

def worker_count
  @worker_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
 
# File 'lib/google/apis/cloudbuild_v1alpha1/classes.rb', line 2007

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @name = args[:name] if args.key?(:name)
  @project_id = args[:project_id] if args.key?(:project_id)
  @regions = args[:regions] if args.key?(:regions)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @status = args[:status] if args.key?(:status)
  @update_time = args[:update_time] if args.key?(:update_time)
  @worker_config = args[:worker_config] if args.key?(:worker_config)
  @worker_count = args[:worker_count] if args.key?(:worker_count)
end