Class WorkerPool (2.0.0)

public sealed class WorkerPool : IMessage<WorkerPool>, IEquatable<WorkerPool>, IDeepCloneable<WorkerPool>, IBufferMessage, IMessage

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.

Inheritance

Object > WorkerPool

Implements

IMessage<WorkerPool>, IEquatable<WorkerPool>, IDeepCloneable<WorkerPool>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

WorkerPool()

public WorkerPool()

WorkerPool(WorkerPool)

public WorkerPool(WorkerPool other)

Parameter
Name	Description
`other`	`WorkerPool`

Properties

Annotations

public MapField<string, string> Annotations { get; }

User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Property Value
Type	Description
`MapField<String, String>`

ConfigCase

public WorkerPool.ConfigOneofCase ConfigCase { get; }

Property Value
Type	Description
`WorkerPool.ConfigOneofCase`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time at which the request to create the WorkerPool was received.

Property Value
Type	Description
`Timestamp`

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. Time at which the request to delete the WorkerPool was received.

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

Property Value
Type	Description
`String`

Etag

public string Etag { get; set; }

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.

Property Value
Type	Description
`String`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`String`

PrivatePoolV1Config

public PrivatePoolV1Config PrivatePoolV1Config { get; set; }

Private Pool using a v1 configuration.

Property Value
Type	Description
`PrivatePoolV1Config`

State

public WorkerPool.Types.State State { get; set; }

Output only. WorkerPool state.

Property Value
Type	Description
`WorkerPool.Types.State`

Uid

public string Uid { get; set; }

Output only. A unique identifier for the WorkerPool.

Property Value
Type	Description
`String`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time at which the request to update the WorkerPool was received.

Property Value
Type	Description
`Timestamp`

WorkerPoolName

public WorkerPoolName WorkerPoolName { get; set; }

WorkerPoolName-typed view over the Name resource name property.

Property Value
Type	Description
`WorkerPoolName`