Reference documentation and code samples for the Google Cloud Run V2 Client class UpdateWorkerPoolRequest.
Request message for updating a worker pool.
Generated from protobuf message google.cloud.run.v2.UpdateWorkerPoolRequest
Namespace
Google \ Cloud \ Run \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. The list of fields to be updated. |
↳ worker_pool |
WorkerPool
Required. The WorkerPool to be updated. |
↳ validate_only |
bool
Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources. |
↳ allow_missing |
bool
Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist. |
↳ force_new_revision |
bool
Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision. This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again. |
getUpdateMask
Optional. The list of fields to be updated.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. The list of fields to be updated.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getWorkerPool
Required. The WorkerPool to be updated.
Returns | |
---|---|
Type | Description |
WorkerPool|null |
hasWorkerPool
clearWorkerPool
setWorkerPool
Required. The WorkerPool to be updated.
Parameter | |
---|---|
Name | Description |
var |
WorkerPool
|
Returns | |
---|---|
Type | Description |
$this |
getValidateOnly
Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
Returns | |
---|---|
Type | Description |
bool |
setValidateOnly
Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getAllowMissing
Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist.
Returns | |
---|---|
Type | Description |
bool |
setAllowMissing
Optional. If set to true, and if the WorkerPool does not exist, it will create a new one. The caller must have 'run.workerpools.create' permissions if this is set to true and the WorkerPool does not exist.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getForceNewRevision
Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision.
This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.
Returns | |
---|---|
Type | Description |
bool |
setForceNewRevision
Optional. If set to true, a new revision will be created from the template even if the system doesn't detect any changes from the previously deployed revision.
This may be useful for cases where the underlying resources need to be recreated or reinitialized. For example if the image is specified by label, but the underlying image digest has changed) or if the container performs deployment initialization work that needs to be performed again.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
workerPool |
WorkerPool
Required. The WorkerPool to be updated. |
Returns | |
---|---|
Type | Description |
UpdateWorkerPoolRequest |
static::buildFromWorkerPoolUpdateMask
Parameters | |
---|---|
Name | Description |
workerPool |
WorkerPool
Required. The WorkerPool to be updated. |
updateMask |
Google\Protobuf\FieldMask
Optional. The list of fields to be updated. |
Returns | |
---|---|
Type | Description |
UpdateWorkerPoolRequest |