Google Cloud Build V1 Client - Class WorkerPool (0.11.0)

Reference documentation and code samples for the Google Cloud Build V1 Client 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.

Generated from protobuf message google.devtools.cloudbuild.v1.WorkerPool

Namespace

Google \ Cloud \ Build \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` 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`	`string` A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters.
`↳ uid`	`string` Output only. A unique identifier for the `WorkerPool`.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time at which the request to create the `WorkerPool` was received.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Time at which the request to update the `WorkerPool` was received.
`↳ delete_time`	`Google\Protobuf\Timestamp` Output only. Time at which the request to delete the `WorkerPool` was received.
`↳ state`	`int` Output only. `WorkerPool` state.
`↳ private_pool_v1_config`	`Google\Cloud\Build\V1\PrivatePoolV1Config` Legacy Private Pool configuration.
`↳ etag`	`string` 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.

getName

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.

Returns
Type	Description
`string`

setName

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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

Returns
Type	Description
`string`

setDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. A unique identifier for the WorkerPool.

Returns
Type	Description
`string`

setUid

Output only. A unique identifier for the WorkerPool.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAnnotations

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAnnotations

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeleteTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeleteTime

clearDeleteTime

setDeleteTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. WorkerPool state.

Returns
Type	Description
`int`

setState

Output only. WorkerPool state.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPrivatePoolV1Config

Legacy Private Pool configuration.

Returns
Type	Description
`Google\Cloud\Build\V1\PrivatePoolV1Config\|null`

hasPrivatePoolV1Config

setPrivatePoolV1Config

Legacy Private Pool configuration.

Parameter
Name	Description
`var`	`Google\Cloud\Build\V1\PrivatePoolV1Config`

Returns
Type	Description
`$this`

getEtag

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.

Returns
Type	Description
`string`

setEtag

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfig

Returns
Type	Description
`string`