Google Cloud Build V1 Client - Class CreateWorkerPoolRequest (0.5.1)

Reference documentation and code samples for the Google Cloud Build V1 Client class CreateWorkerPoolRequest.

Request to create a new WorkerPool.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource where this worker pool will be created. Format: projects/{project}/locations/{location}.

↳ worker_pool Google\Cloud\Build\V1\WorkerPool

Required. WorkerPool resource to create.

↳ worker_pool_id string

Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.

↳ validate_only bool

If set, validate the request and preview the response, but do not actually post it.

getParent

Required. The parent resource where this worker pool will be created.

Format: projects/{project}/locations/{location}.

Returns
TypeDescription
string

setParent

Required. The parent resource where this worker pool will be created.

Format: projects/{project}/locations/{location}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWorkerPool

Required. WorkerPool resource to create.

Returns
TypeDescription
Google\Cloud\Build\V1\WorkerPool|null

hasWorkerPool

clearWorkerPool

setWorkerPool

Required. WorkerPool resource to create.

Parameter
NameDescription
var Google\Cloud\Build\V1\WorkerPool
Returns
TypeDescription
$this

getWorkerPoolId

Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name.

This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.

Returns
TypeDescription
string

setWorkerPoolId

Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name.

This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

If set, validate the request and preview the response, but do not actually post it.

Returns
TypeDescription
bool

setValidateOnly

If set, validate the request and preview the response, but do not actually post it.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this