Reference documentation and code samples for the Google Cloud Build V1 Client class WorkerPool.
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 WorkerPool
s 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
.
Generated from protobuf message google.devtools.cloudbuild.v1.WorkerPool
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the WorkerPool
, with format projects/{project}/locations/{location}/workerPools/{worker_pool}
. The value of {worker_pool}
is provided by worker_pool_id
in CreateWorkerPool
request and the value of {location}
is determined by the endpoint accessed.
↳ display_name
string
A user-specified, human-readable name for the WorkerPool
. If provided, this value must be 1-63 characters.
↳ uid
string
Output only. A unique identifier for the WorkerPool
.
↳ annotations
array| Google\Protobuf\Internal\MapField
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
↳ 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.
↳ state
int
Output only. WorkerPool
state.
↳ private_pool_v1_config
↳ 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.
getName
Output only. The resource name of the WorkerPool
, with format projects/{project}/locations/{location}/workerPools/{worker_pool}
.
The value of {worker_pool}
is provided by worker_pool_id
in CreateWorkerPool
request and the value of {location}
is determined by
the endpoint accessed.
string
setName
Output only. The resource name of the WorkerPool
, with format projects/{project}/locations/{location}/workerPools/{worker_pool}
.
The value of {worker_pool}
is provided by worker_pool_id
in CreateWorkerPool
request and the value of {location}
is determined by
the endpoint accessed.
var
string
$this
getDisplayName
A user-specified, human-readable name for the WorkerPool
. If provided,
this value must be 1-63 characters.
string
setDisplayName
A user-specified, human-readable name for the WorkerPool
. If provided,
this value must be 1-63 characters.
var
string
$this
getUid
Output only. A unique identifier for the WorkerPool
.
string
setUid
Output only. A unique identifier for the WorkerPool
.
var
string
$this
getAnnotations
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
setAnnotations
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
$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
getState
Output only. WorkerPool
state.
int
setState
Output only. WorkerPool
state.
var
int
$this
getPrivatePoolV1Config
Legacy Private Pool configuration.
hasPrivatePoolV1Config
setPrivatePoolV1Config
Legacy Private Pool configuration.
$this
getEtag
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.
string
setEtag
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.
var
string
$this
getConfig
string
