Reference documentation and code samples for the Google Cloud Build V1 Client class DeleteWorkerPoolRequest.
Request to delete a WorkerPool
.
Generated from protobuf message google.devtools.cloudbuild.v1.DeleteWorkerPoolRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the |
↳ etag |
string
Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed. |
↳ allow_missing |
bool
If set to true, and the |
↳ validate_only |
bool
If set, validate the request and preview the response, but do not actually post it. |
getName
Required. The name of the WorkerPool
to delete.
Format:
projects/{project}/locations/{location}/workerPools/{workerPool}
.
Returns | |
---|---|
Type | Description |
string |
setName
Required. The name of the WorkerPool
to delete.
Format:
projects/{project}/locations/{location}/workerPools/{workerPool}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getEtag
Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.
Returns | |
---|---|
Type | Description |
string |
setEtag
Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAllowMissing
If set to true, and the WorkerPool
is not found, the request will succeed
but no action will be taken on the server.
Returns | |
---|---|
Type | Description |
bool |
setAllowMissing
If set to true, and the WorkerPool
is not found, the request will succeed
but no action will be taken on the server.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getValidateOnly
If set, validate the request and preview the response, but do not actually post it.
Returns | |
---|---|
Type | Description |
bool |
setValidateOnly
If set, validate the request and preview the response, but do not actually post it.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |