Resource: 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.
JSON representation |
---|
{ "name": string, "displayName": string, "uid": string, "annotations": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the |
displayName |
A user-specified, human-readable name for the |
uid |
Output only. A unique identifier for the |
annotations |
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. An object containing a list of |
createTime |
Output only. Time at which the request to create the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Time at which the request to update the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. Time at which the request to delete the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. |
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. |
Union field config . Configuration for the WorkerPool . config can be only one of the following: |
|
privatePoolV1Config |
Legacy Private Pool configuration. |
State
State of the WorkerPool
.
Enums | |
---|---|
STATE_UNSPECIFIED |
State of the WorkerPool is unknown. |
CREATING |
WorkerPool is being created. |
RUNNING |
WorkerPool is running. |
DELETING |
WorkerPool is being deleted: cancelling builds and draining workers. |
DELETED |
WorkerPool is deleted. |
UPDATING |
WorkerPool is being updated; new builds cannot be run. |
PrivatePoolV1Config
Configuration for a V1 PrivatePool
.
JSON representation |
---|
{ "workerConfig": { object ( |
Fields | |
---|---|
workerConfig |
Machine configuration for the workers in the pool. |
networkConfig |
Network configuration for the pool. |
WorkerConfig
Defines the configuration to be used for creating workers in the pool.
JSON representation |
---|
{ "machineType": string, "diskSizeGb": string } |
Fields | |
---|---|
machineType |
Optional. Machine type of a worker, such as |
diskSizeGb |
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If |
NetworkConfig
Defines the network configuration for the pool.
JSON representation |
---|
{
"peeredNetwork": string,
"egressOption": enum ( |
Fields | |
---|---|
peeredNetwork |
Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to |
egressOption |
Option to configure network egress for the workers. |
peeredNetworkIpRange |
Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. |
EgressOption
Defines the egress option for the pool.
Enums | |
---|---|
EGRESS_OPTION_UNSPECIFIED |
If set, defaults to PUBLIC_EGRESS. |
NO_PUBLIC_EGRESS |
If set, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. |
PUBLIC_EGRESS |
If set, workers are created with a public address which allows for public internet egress. |
Methods |
|
---|---|
|
Creates a WorkerPool . |
|
Deletes a WorkerPool . |
|
Returns details of a WorkerPool . |
|
Lists WorkerPool s. |
|
Updates a WorkerPool . |