Class WorkerPool
Configuration for a WorkerPool to run the builds. Workers provide a build environment where Cloud Build runs
your builds. Cloud Build owns and maintains a pool of workers for general use. By default, when you submit a
build, Cloud Build uses one of the workers from this pool. Builds that run in the default worker pool have
access to the public internet. If your build needs access to resources on a private network, create and use a
WorkerPool to run your builds. Custom 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 custom worker
pools, see Custom workers
overview.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.CloudBuild.v1beta1.Data
Assembly: Google.Apis.CloudBuild.v1beta1.dll
Syntax
public class WorkerPool : IDirectResponseSchema
Properties
Annotations
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.String> |
CreateTime
Output only. Time at which the request to create the WorkerPool was received.
Declaration
[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
DeleteTime
Output only. Time at which the request to delete the WorkerPool was received.
Declaration
[JsonProperty("deleteTime")]
public virtual object DeleteTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
DisplayName
A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ETag
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.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NetworkConfig
Network configuration for the WorkerPool.
Declaration
[JsonProperty("networkConfig")]
public virtual NetworkConfig NetworkConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| NetworkConfig |
State
Output only. WorkerPool state.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Uid
Output only. A unique identifier for the WorkerPool.
Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
UpdateTime
Output only. Time at which the request to update the WorkerPool was received.
Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object |
WorkerConfig
Worker configuration for the WorkerPool.
Declaration
[JsonProperty("workerConfig")]
public virtual WorkerConfig WorkerConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| WorkerConfig |