Google Cloud Run V2 Client - Class CreateWorkerPoolRequest (1.9.0)

Reference documentation and code samples for the Google Cloud Run V2 Client class CreateWorkerPoolRequest.

Request message for creating a WorkerPool.

Generated from protobuf message google.cloud.run.v2.CreateWorkerPoolRequest

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.

↳ worker_pool WorkerPool

Required. The WorkerPool instance to create.

↳ worker_pool_id string

Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.

↳ validate_only bool

Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

getParent

Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.

Returns
Type Description
string

setParent

Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkerPool

Required. The WorkerPool instance to create.

Returns
Type Description
WorkerPool|null

hasWorkerPool

clearWorkerPool

setWorkerPool

Required. The WorkerPool instance to create.

Parameter
Name Description
var WorkerPool
Returns
Type Description
$this

getWorkerPoolId

Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters.

The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.

Returns
Type Description
string

setWorkerPoolId

Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters.

The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

Returns
Type Description
bool

setValidateOnly

Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens. Please see WorkerPoolsClient::locationName() for help formatting this field.

workerPool WorkerPool

Required. The WorkerPool instance to create.

workerPoolId string

Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.

Returns
Type Description
CreateWorkerPoolRequest