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 <https://cloud.google.com/build/docs/private-pools/private-pools-overview>__.
str
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
str
A user-specified, human-readable name for the
WorkerPool. If provided, this value must be 1-63
characters.
uid
str
Output only. A unique identifier for the WorkerPool.
annotations
MutableMapping[str, str]
User specified annotations. See
https://google.aip.dev/128#annotations for more
details such as format and size limitations.
create_time
google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which the request to create the
WorkerPool was received.
update_time
google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which the request to update the
WorkerPool was received.
delete_time
google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which the request to delete the
WorkerPool was received.
str
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class WorkerPool (3.31.3)\n\nVersion latestkeyboard_arrow_down\n\n- [3.31.3 (latest)](/python/docs/reference/cloudbuild/latest/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.31.2](/python/docs/reference/cloudbuild/3.31.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.30.0](/python/docs/reference/cloudbuild/3.30.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.29.0](/python/docs/reference/cloudbuild/3.29.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.28.0](/python/docs/reference/cloudbuild/3.28.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.27.1](/python/docs/reference/cloudbuild/3.27.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.26.0](/python/docs/reference/cloudbuild/3.26.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.25.0](/python/docs/reference/cloudbuild/3.25.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.24.2](/python/docs/reference/cloudbuild/3.24.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.23.3](/python/docs/reference/cloudbuild/3.23.3/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.22.0](/python/docs/reference/cloudbuild/3.22.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.21.0](/python/docs/reference/cloudbuild/3.21.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.20.1](/python/docs/reference/cloudbuild/3.20.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.19.0](/python/docs/reference/cloudbuild/3.19.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.18.0](/python/docs/reference/cloudbuild/3.18.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.17.1](/python/docs/reference/cloudbuild/3.17.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.16.0](/python/docs/reference/cloudbuild/3.16.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.15.0](/python/docs/reference/cloudbuild/3.15.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.14.0](/python/docs/reference/cloudbuild/3.14.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.13.0](/python/docs/reference/cloudbuild/3.13.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.12.0](/python/docs/reference/cloudbuild/3.12.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.11.1](/python/docs/reference/cloudbuild/3.11.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.10.0](/python/docs/reference/cloudbuild/3.10.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.9.3](/python/docs/reference/cloudbuild/3.9.3/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.8.3](/python/docs/reference/cloudbuild/3.8.3/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.7.1](/python/docs/reference/cloudbuild/3.7.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.6.0](/python/docs/reference/cloudbuild/3.6.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.5.2](/python/docs/reference/cloudbuild/3.5.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.4.0](/python/docs/reference/cloudbuild/3.4.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.3.2](/python/docs/reference/cloudbuild/3.3.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.2.1](/python/docs/reference/cloudbuild/3.2.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.1.1](/python/docs/reference/cloudbuild/3.1.1/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [3.0.2](/python/docs/reference/cloudbuild/3.0.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [2.0.2](/python/docs/reference/cloudbuild/2.0.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [1.1.2](/python/docs/reference/cloudbuild/1.1.2/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [1.0.0](/python/docs/reference/cloudbuild/1.0.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool)\n- [0.1.0](/python/docs/reference/cloudbuild/0.1.0/google.cloud.devtools.cloudbuild_v1.types.WorkerPool) \n\n WorkerPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfiguration for a `WorkerPool`.\n\nCloud Build owns and maintains a pool of workers for general use and\nhave no access to a project's private network. By default, builds\nsubmitted to Cloud Build will use a worker from this pool.\n\nIf your build needs access to resources on a private network, create\nand use a `WorkerPool` to run your builds. Private\n`WorkerPool`\\\\ s give your builds access to any single VPC network\nthat you administer, including any on-prem resources connected to\nthat VPC network. For an overview of private pools, see `Private\npools\noverview \u003chttps://cloud.google.com/build/docs/private-pools/private-pools-overview\u003e`__.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### AnnotationsEntry\n\n AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message.\n\n### State\n\n State(value)\n\nState of the `WorkerPool`."]]