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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudbuild_v1alpha1/classes.rb,
generated/google/apis/cloudbuild_v1alpha1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.



1162
1163
1164
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1162

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) 


1106
1107
1108
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1106

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) 


1112
1113
1114
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1112

def delete_time
  @delete_time
end

#name ⇒ String

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

Returns:

  • (String) 


1117
1118
1119
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1117

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) 


1122
1123
1124
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1122

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


1131
1132
1133
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1131

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) 


1138
1139
1140
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1138

def 
  @service_account_email
end

#status ⇒ String

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

Returns:

  • (String) 


1143
1144
1145
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1143

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) 


1149
1150
1151
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1149

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:



1155
1156
1157
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1155

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) 


1160
1161
1162
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1160

def worker_count
  @worker_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'generated/google/apis/cloudbuild_v1alpha1/classes.rb', line 1167

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