Reference documentation and code samples for the Google Cloud Deploy V1 Client class PrivatePool.
Execution using a private Cloud Build pool.
Generated from protobuf message google.cloud.deploy.v1.PrivatePool
Namespace
Google \ Cloud \ Deploy \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ worker_pool
string
Required. Resource name of the Cloud Build worker pool to use. The format is projects/{project}/locations/{location}/workerPools/{pool}.
↳ service_account
string
Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.
↳ artifact_storage
string
Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.
getWorkerPool
Required. Resource name of the Cloud Build worker pool to use. The format
is projects/{project}/locations/{location}/workerPools/{pool}.
Returns
Type
Description
string
setWorkerPool
Required. Resource name of the Cloud Build worker pool to use. The format
is projects/{project}/locations/{location}/workerPools/{pool}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getServiceAccount
Optional. Google service account to use for execution. If unspecified,
the project execution service account
(<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.
Returns
Type
Description
string
setServiceAccount
Optional. Google service account to use for execution. If unspecified,
the project execution service account
(<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getArtifactStorage
Optional. Cloud Storage location where execution outputs should be stored.
This can either be a bucket ("gs://my-bucket") or a path within a bucket
("gs://my-bucket/my-dir").
If unspecified, a default bucket located in the same region will be used.
Returns
Type
Description
string
setArtifactStorage
Optional. Cloud Storage location where execution outputs should be stored.
This can either be a bucket ("gs://my-bucket") or a path within a bucket
("gs://my-bucket/my-dir").
If unspecified, a default bucket located in the same region will be used.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class PrivatePool (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.PrivatePool)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.PrivatePool)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.PrivatePool)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.PrivatePool)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.PrivatePool)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.PrivatePool)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.PrivatePool)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.PrivatePool)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.PrivatePool)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.PrivatePool)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.PrivatePool)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.PrivatePool)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.PrivatePool)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.PrivatePool)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.PrivatePool)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.PrivatePool)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.PrivatePool)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.PrivatePool)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.PrivatePool)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.PrivatePool)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.PrivatePool)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.PrivatePool)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.PrivatePool)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.PrivatePool) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class PrivatePool.\n\nExecution using a private Cloud Build pool.\n\nGenerated from protobuf message `google.cloud.deploy.v1.PrivatePool`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getWorkerPool\n\nRequired. Resource name of the Cloud Build worker pool to use. The format\nis `projects/{project}/locations/{location}/workerPools/{pool}`.\n\n### setWorkerPool\n\nRequired. Resource name of the Cloud Build worker pool to use. The format\nis `projects/{project}/locations/{location}/workerPools/{pool}`.\n\n### getServiceAccount\n\nOptional. Google service account to use for execution. If unspecified,\nthe project execution service account\n(\\\u003cPROJECT_NUMBER\\\u003e-compute@developer.gserviceaccount.com) will be used.\n\n### setServiceAccount\n\nOptional. Google service account to use for execution. If unspecified,\nthe project execution service account\n(\\\u003cPROJECT_NUMBER\\\u003e-compute@developer.gserviceaccount.com) will be used.\n\n### getArtifactStorage\n\nOptional. Cloud Storage location where execution outputs should be stored.\n\nThis can either be a bucket (\"gs://my-bucket\") or a path within a bucket\n(\"gs://my-bucket/my-dir\").\nIf unspecified, a default bucket located in the same region will be used.\n\n### setArtifactStorage\n\nOptional. Cloud Storage location where execution outputs should be stored.\n\nThis can either be a bucket (\"gs://my-bucket\") or a path within a bucket\n(\"gs://my-bucket/my-dir\").\nIf unspecified, a default bucket located in the same region will be used."]]