Reference documentation and code samples for the Google Cloud Build V1 Client class WorkerPool.
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.
Generated from protobuf message google.devtools.cloudbuild.v1.WorkerPool
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
User-defined name of the WorkerPool
.
↳ project_id
string
The project ID of the GCP project for which the WorkerPool
is created.
↳ 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.
↳ worker_count
int|string
Total number of workers to be created across all requested regions.
↳ worker_config
Google\Cloud\Build\V1\WorkerConfig
Configuration to be used for a creating workers in the WorkerPool
.
↳ regions
int[]
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.
↳ create_time
Google\Protobuf\Timestamp
Output only. Time at which the request to create the WorkerPool
was received.
↳ update_time
Google\Protobuf\Timestamp
Output only. Time at which the request to update the WorkerPool
was received.
↳ delete_time
Google\Protobuf\Timestamp
Output only. Time at which the request to delete the WorkerPool
was received.
↳ status
int
Output only. WorkerPool Status.
getName
User-defined name of the WorkerPool
.
string
setName
User-defined name of the WorkerPool
.
var
string
$this
getProjectId
The project ID of the GCP project for which the WorkerPool
is created.
string
setProjectId
The project ID of the GCP project for which the WorkerPool
is created.
var
string
$this
getServiceAccountEmail
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.
string
setServiceAccountEmail
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.
var
string
$this
getWorkerCount
Total number of workers to be created across all requested regions.
int|string
setWorkerCount
Total number of workers to be created across all requested regions.
var
int|string
$this
getWorkerConfig
Configuration to be used for a creating workers in the WorkerPool
.
hasWorkerConfig
clearWorkerConfig
setWorkerConfig
Configuration to be used for a creating workers in the WorkerPool
.
$this
getRegions
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.
setRegions
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.
var
int[]
$this
getCreateTime
Output only. Time at which the request to create the WorkerPool
was
received.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the request to create the WorkerPool
was
received.
$this
getUpdateTime
Output only. Time at which the request to update the WorkerPool
was
received.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time at which the request to update the WorkerPool
was
received.
$this
getDeleteTime
Output only. Time at which the request to delete the WorkerPool
was
received.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. Time at which the request to delete the WorkerPool
was
received.
$this
getStatus
Output only. WorkerPool Status.
int
setStatus
Output only. WorkerPool Status.
var
int
$this
