public sealed class WorkerPool : IMessage<WorkerPool>, IEquatable<WorkerPool>, IDeepCloneable<WorkerPool>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Build v1 API 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 WorkerPools 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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-19 UTC."],[[["\u003cp\u003eThe latest version of the Cloud Build v1 API class WorkerPool is 2.15.0, with links to documentation for versions dating back to 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003eWorkerPool is a class that represents the configuration for a worker pool within the Cloud Build service, allowing for builds that require private network access.\u003c/p\u003e\n"],["\u003cp\u003ePrivate WorkerPools allow your builds to access resources on a private network, including on-prem resources connected to a VPC network.\u003c/p\u003e\n"],["\u003cp\u003eThe WorkerPool class implements interfaces like IMessage, IEquatable, IDeepCloneable, and IBufferMessage, and inherits members from the object class.\u003c/p\u003e\n"],["\u003cp\u003eThe WorkerPool class includes various properties such as Annotations, CreateTime, DeleteTime, DisplayName, Etag, Name, and State, providing comprehensive information and control over the worker pool's configuration and status.\u003c/p\u003e\n"]]],[],null,["# Cloud Build v1 API - Class WorkerPool (2.16.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.16.0 (latest)](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.15.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.14.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.13.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.12.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.11.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.10.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.9.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.8.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.7.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.6.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.5.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.4.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.3.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.2.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.1.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/2.0.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/1.4.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/1.3.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/1.2.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/1.1.0/Google.Cloud.CloudBuild.V1.WorkerPool)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/1.0.0/Google.Cloud.CloudBuild.V1.WorkerPool) \n\n public sealed class WorkerPool : IMessage\u003cWorkerPool\u003e, IEquatable\u003cWorkerPool\u003e, IDeepCloneable\u003cWorkerPool\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Build v1 API class WorkerPool.\n\nConfiguration for a `WorkerPool`.\n\nCloud Build owns and maintains a pool of workers for general use and have no\naccess to a project's private network. By default, builds submitted to\nCloud Build will use a worker from this pool.\n\nIf your build needs access to resources on a private network,\ncreate and use a `WorkerPool` to run your builds. Private `WorkerPool`s give\nyour builds access to any single VPC network that you\nadminister, including any on-prem resources connected to that VPC\nnetwork. For an overview of private pools, see\n[Private pools\noverview](https://cloud.google.com/build/docs/private-pools/private-pools-overview). \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e WorkerPool \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[WorkerPool](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPool), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[WorkerPool](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPool), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[WorkerPool](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPool), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.CloudBuild.V1](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.CloudBuild.V1.dll\n\nConstructors\n------------\n\n### WorkerPool()\n\n public WorkerPool()\n\n### WorkerPool(WorkerPool)\n\n public WorkerPool(WorkerPool other)\n\nProperties\n----------\n\n### Annotations\n\n public MapField\u003cstring, string\u003e Annotations { get; }\n\nUser specified annotations. See \u003chttps://google.aip.dev/128#annotations\u003e\nfor more details such as format and size limitations.\n\n### ConfigCase\n\n public WorkerPool.ConfigOneofCase ConfigCase { get; }\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. Time at which the request to create the `WorkerPool` was\nreceived.\n\n### DeleteTime\n\n public Timestamp DeleteTime { get; set; }\n\nOutput only. Time at which the request to delete the `WorkerPool` was\nreceived.\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nA user-specified, human-readable name for the `WorkerPool`. If provided,\nthis value must be 1-63 characters.\n\n### Etag\n\n public string Etag { get; set; }\n\nOutput only. Checksum computed by the server. May be sent on update and\ndelete requests to ensure that the client has an up-to-date value before\nproceeding.\n\n### Name\n\n public string Name { get; set; }\n\nOutput only. The resource name of the `WorkerPool`, with format\n`projects/{project}/locations/{location}/workerPools/{worker_pool}`.\nThe value of `{worker_pool}` is provided by `worker_pool_id` in\n`CreateWorkerPool` request and the value of `{location}` is determined by\nthe endpoint accessed.\n\n### PrivatePoolV1Config\n\n public PrivatePoolV1Config PrivatePoolV1Config { get; set; }\n\nLegacy Private Pool configuration.\n\n### State\n\n public WorkerPool.Types.State State { get; set; }\n\nOutput only. `WorkerPool` state.\n\n### Uid\n\n public string Uid { get; set; }\n\nOutput only. A unique identifier for the `WorkerPool`.\n\n### UpdateTime\n\n public Timestamp UpdateTime { get; set; }\n\nOutput only. Time at which the request to update the `WorkerPool` was\nreceived.\n\n### WorkerPoolName\n\n public WorkerPoolName WorkerPoolName { get; set; }\n\n[WorkerPoolName](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPoolName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.CloudBuild.V1/latest/Google.Cloud.CloudBuild.V1.WorkerPool#Google_Cloud_CloudBuild_V1_WorkerPool_Name) resource name property."]]
