Cloud Build API (cloudbuild:v1beta1)

Deletions

Methods


• ▼ ▲ cloudbuild.projects.locations.operations.cancel

  HTTP Method: POST

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameters:

  name

  Location: path

  Required: Yes

  Description: The name of the operation resource to be cancelled.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

  Path: v1beta1/{+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`.

  Parameter Order: name

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

• ▼ ▲ cloudbuild.projects.locations.operations.get

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameter Order: name

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  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.

  Path: v1beta1/{+name}

  HTTP Method: GET

  Parameters:

  name

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

  Type: string

  Description: The name of the operation resource.

• ▼ ▲ cloudbuild.projects.locations.workerPools.list

  Description: Lists `WorkerPool`s in the given project.

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Path: v1beta1/{+parent}/workerPools

  Parameters:

  parent

  Required: Yes

  Description: Required. The parent of the collection of `WorkerPools`. Format: `projects/{project}/locations/location`.

  Type: string

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/workerPools

  HTTP Method: GET

  Parameter Order: parent

• ▼ ▲ cloudbuild.projects.locations.workerPools.create

  Description: Creates a `WorkerPool` to run the builds, and returns the new worker pool. NOTE: As of now, this method returns an `Operation` that is always complete.

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/workerPools

  Parameter Order: parent

  Path: v1beta1/{+parent}/workerPools

  Parameters:

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Location: path

  Type: string

  Description: Required. The parent resource where this worker pool will be created. Format: `projects/{project}/locations/{location}`.

  Required: Yes

  workerPoolId

  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-/.

  Type: string

  Location: query

  HTTP Method: POST

• ▼ ▲ cloudbuild.projects.locations.workerPools.delete

  Parameter Order: name

  Parameters:

  etag

  Location: query

  Type: string

  Description: Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$

  Type: string

  Required: Yes

  Description: Required. The name of the `WorkerPool` to delete. Format: `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.

  Location: path

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}

  Path: v1beta1/{+name}

  Description: Deletes a `WorkerPool`. NOTE: As of now, this method returns an `Operation` that is always complete.

  HTTP Method: DELETE

  Scopes: https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ cloudbuild.projects.locations.workerPools.patch

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameter Order: name

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}

  Parameters:

  name

  Location: path

  Description: Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed.

  Required: Yes

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$

  updateMask

  Format: google-fieldmask

  Description: A mask specifying which fields in `WorkerPool` to update.

  Location: query

  Type: string

  Description: Updates a `WorkerPool`. NOTE: As of now, this method returns an `Operation` that is always complete.

  Path: v1beta1/{+name}

  HTTP Method: PATCH

• ▼ ▲ cloudbuild.projects.locations.workerPools.get

  Description: Returns details of a `WorkerPool`.

  Path: v1beta1/{+name}

  Scopes: https://www.googleapis.com/auth/cloud-platform

  HTTP Method: GET

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}

  Parameter Order: name

  Parameters:

  name

  Location: path

  Type: string

  Required: Yes

  Description: Required. The name of the `WorkerPool` to retrieve. Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$