2023-01-18
▼ ▲ cloudbuild.projects.workerPools.delete
HTTP Method: DELETE
Description: Deletes a `WorkerPool`.
Parameters:
name
Required: Yes
Description: Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool}
Type: string
Location: path
Pattern: ^projects/[^/]+/workerPools/[^/]+$
Parameter Order: name
Path: v1alpha2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha2/projects/{projectsId}/workerPools/{workerPoolsId}
▼ ▲ cloudbuild.projects.workerPools.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha2/projects/{projectsId}/workerPools/{workerPoolsId}
Parameters:
name
Type: string
Description: Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool}
Required: Yes
Pattern: ^projects/[^/]+/workerPools/[^/]+$
Location: path
Parameter Order: name
Description: Returns details of a `WorkerPool`.
HTTP Method: GET
Path: v1alpha2/{+name}
▼ ▲ cloudbuild.projects.workerPools.patch
Parameters:
updateMask
Description: A mask specifying which fields in `WorkerPool` should be updated.
Location: query
Type: string
Format: google-fieldmask
name
Required: Yes
Pattern: ^projects/[^/]+/workerPools/[^/]+$
Location: path
Type: string
Description: Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
Path: v1alpha2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha2/projects/{projectsId}/workerPools/{workerPoolsId}
Parameter Order: name
HTTP Method: PATCH
Description: Updates a `WorkerPool`.
▼ ▲ cloudbuild.projects.workerPools.create
Description: Creates a `WorkerPool` to run the builds, and returns the new worker pool.
Path: v1alpha2/{+parent}/workerPools
Parameters:
parent
Type: string
Location: path
Pattern: ^projects/[^/]+$
Required: Yes
Description: Required. The parent resource where this book will be created. Format: projects/{project}
workerPoolId
Type: string
Description: 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-/.
Location: query
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha2/projects/{projectsId}/workerPools
HTTP Method: POST
▼ ▲ cloudbuild.projects.workerPools.list
Description: Lists `WorkerPool`s by project.
HTTP Method: GET
Flat Path: v1alpha2/projects/{projectsId}/workerPools
Path: v1alpha2/{+parent}/workerPools
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+$
Required: Yes
Type: string
Description: Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ cloudbuild.projects.locations.operations.get
Parameter Order: name
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha2/{+name}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ cloudbuild.projects.locations.operations.cancel
Flat Path: v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameter Order: name
Parameters:
name
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Path: v1alpha2/{+name}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method: POST