Method: googleapis.cloudbuild.v1.projects.locations.workerPools.delete

Deletes a WorkerPool.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
`name`	`string` Required. The name of the `WorkerPool` to delete. Format: `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.
`allowMissing`	`boolean` If set to true, and the `WorkerPool` is not found, the request will succeed but no action will be taken on the server.
`etag`	`string` Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.
`validateOnly`	`boolean` If set, validate the request and preview the response, but do not actually post it.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
`OperationError`	If the long-running operation finished unsuccessfully.
`ResponseTypeError`	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- delete:
    call: googleapis.cloudbuild.v1.projects.locations.workerPools.delete
    args:
        name: ...
        allowMissing: ...
        etag: ...
        validateOnly: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.cloudbuild.v1.projects.locations.workerPools.delete",
      "args": {
        "name": "...",
        "allowMissing": "...",
        "etag": "...",
        "validateOnly": "..."
      },
      "result": "deleteResult"
    }
  }
]