Cloud Run Admin API (run:v1)

Additions

Methods


• ▼ ▲ run.namespaces.workerpools.list

  Path : apis/run.googleapis.com/v1/{+parent}/workerpools

  Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `{project_id_or_number}` * `namespaces/{project_id_or_number}` * `namespaces/{project_id_or_number}/workerpools` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`

  Pattern : ^namespaces/[^/]+$

  Location : path

  Required : Yes

  Type : string

  limit

  Description : The maximum number of records that should be returned.

  Location : query

  Type : integer

  Format : int32

  labelSelector

  Description : =, !=, exists, in, and notIn.

  Location : query

  Type : string

  continue

  Description : Encoded string to continue paging.

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Lists worker pools for the given project and region. Results are sorted by creation time, descending.

• ▼ ▲ run.namespaces.workerpools.get

  Path : apis/run.googleapis.com/v1/{+name}

  Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The fully qualified name of the worker pool to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`

  Pattern : ^namespaces/[^/]+/workerpools/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

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

  Description : Gets information about a worker pool.

• ▼ ▲ run.namespaces.workerpools.create

  Path : apis/run.googleapis.com/v1/{+parent}/workerpools

  Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The resource's parent. In Cloud Run, it may be one of the following: * `{project_id_or_number}` * `namespaces/{project_id_or_number}` * `namespaces/{project_id_or_number}/workerpools` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`

  Pattern : ^namespaces/[^/]+$

  Location : path

  Required : Yes

  Type : string

  dryRun

  Description : Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`

  Location : query

  Type : string

  Parameter Order : parent

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

  Description : Creates a new WorkerPool. WorkerPool creation will trigger a new deployment. Use GetWorkerPool, and check worker_pool.status to determine if the WorkerPool is ready.

• ▼ ▲ run.namespaces.workerpools.replaceWorkerPool

  Path : apis/run.googleapis.com/v1/{+name}

  Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}

  HTTP Method : PUT

  Parameters :

  name

  Description : Required. The fully qualified name of the worker pool to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`

  Pattern : ^namespaces/[^/]+/workerpools/[^/]+$

  Location : path

  Required : Yes

  Type : string

  dryRun

  Description : Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`

  Location : query

  Type : string

  Parameter Order : name

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

  Description : Replaces a worker pool. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

• ▼ ▲ run.namespaces.workerpools.delete

  Path : apis/run.googleapis.com/v1/{+name}

  Flat Path : apis/run.googleapis.com/v1/namespaces/{namespacesId}/workerpools/{workerpoolsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The fully qualified name of the worker pool to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/workerpools/{worker_pool_name}` (only when the `endpoint` is regional) * `projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}` * `projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}`

  Pattern : ^namespaces/[^/]+/workerpools/[^/]+$

  Location : path

  Required : Yes

  Type : string

  dryRun

  Description : Indicates that the server should validate the request and populate default values without persisting the request. Supported values: `all`

  Location : query

  Type : string

  Parameter Order : name

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

  Description : Deletes the provided worker pool. This will cause the WorkerPool to stop all instances and will delete all associated WorkerPoolRevisions.