Cloud Run Admin API (run:v2)

2025-02-20

8 new methods

Additions

    Methods
  • run.projects.locations.workerPools.create

      Path : v2/{+parent}/workerPools

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

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.

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

          Location : path

          Required : Yes

          Type : string

        workerPoolId

          Description : Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.

          Location : query

          Type : string

        validateOnly

          Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.

          Location : query

          Type : boolean

      Parameter Order : parent

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

      Description : Creates a new WorkerPool in a given project and location.

  • run.projects.locations.workerPools.get

      Path : v2/{+name}

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

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets information about a WorkerPool.

  • run.projects.locations.workerPools.list

      Path : v2/{+parent}/workerPools

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

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Maximum number of WorkerPools to return in this call.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A page token received from a previous call to ListWorkerPools. All other parameters must match.

          Location : query

          Type : string

        showDeleted

          Description : If true, returns deleted (but unexpired) resources along with active ones.

          Location : query

          Type : boolean

      Parameter Order : parent

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

      Description : Lists WorkerPools. Results are sorted by creation time, descending.

  • run.projects.locations.workerPools.patch

      Path : v2/{+name}

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

      HTTP Method : PATCH

      Parameters :

        name

          Description : The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. The list of fields to be updated.

          Location : query

          Type : string

          Format : google-fieldmask

        validateOnly

          Description : Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.

          Location : query

          Type : boolean

        allowMissing

          Description : 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.

          Location : query

          Type : boolean

        forceNewRevision

          Description : 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.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Updates a WorkerPool.

  • run.projects.locations.workerPools.delete

      Path : v2/{+name}

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

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.

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

          Location : path

          Required : Yes

          Type : string

        validateOnly

          Description : Optional. Indicates that the request should be validated without actually deleting any resources.

          Location : query

          Type : boolean

        etag

          Description : A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

          Location : query

          Type : string

      Parameter Order : name

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

      Description : Deletes a WorkerPool.

  • run.projects.locations.workerPools.getIamPolicy

      Path : v2/{+resource}:getIamPolicy

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

      HTTP Method : GET

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

        options.requestedPolicyVersion

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location : query

          Type : integer

          Format : int32

      Parameter Order : resource

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

      Description : Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.

  • run.projects.locations.workerPools.setIamPolicy

      Path : v2/{+resource}:setIamPolicy

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

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.

  • run.projects.locations.workerPools.testIamPermissions

      Path : v2/{+resource}:testIamPermissions

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

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.