projects

Changed on

Updates a WorkerPool.

patch/v2/{+name}

Request

  • Base URL: https://run.googleapis.com
  • URL: https://run.googleapis.com/v2/{+name}
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/run) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/run)

Path parameters

namestring required

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}

Query parameters

allowMissingboolean

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.

forceNewRevisionboolean

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.

updateMaskstring

Optional. The list of fields to be updated.

validateOnlyboolean

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

Request body

annotationsobject

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.

clientstring

Arbitrary identifier for the API client.

clientVersionstring

Arbitrary version identifier for the API client.

createTimestring google-datetime

Output only. The creation time.

creatorstring

Output only. Email address of the authenticated creator.

customAudiencesstring[]

Deprecated: Not supported, and ignored by Cloud Run.

deleteTimestring google-datetime

Output only. The deletion time. It is only populated as a response to a Delete request.

descriptionstring

User-provided description of the WorkerPool. This field currently has a 512-character limit.

etagstring

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

expireTimestring google-datetime

Output only. For a deleted resource, the time after which it will be permamently deleted.

generationstring int64

Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

labelsobject

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

lastModifierstring

Output only. Email address of the last authenticated modifier.

latestCreatedRevisionstring

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

latestReadyRevisionstring

Output only. Name of the latest revision that is serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run.

launchStage'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

namestring

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}

observedGenerationstring int64

Output only. The generation of this WorkerPool currently serving workloads. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

reconcilingboolean

Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, instance_split_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: instance_splits and instance_split_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, instance_split_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in terminal_condition and conditions.

satisfiesPzsboolean

Output only. Reserved for future use.

threatDetectionEnabledboolean

Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool.

uidstring

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

updateTimestring google-datetime

Output only. The last-modified time.

Response

Successful response

Changes

  • 1a01967de4feRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • warning

      deleted the query request parameter validateOnly

    • warning

      deleted the query request parameter validateOnly

    • info

      api operation id run.projects.locations.jobs.patch removed and replaced with run.projects.locations.workerPools.patch

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/run was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/run was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional query request parameter forceNewRevision

    • info

      added the new optional query request parameter updateMask

  • c9c90e09a8d6Revision changes
    • warning

      deleted the query request parameter validateOnly

    • warning

      deleted the query request parameter validateOnly

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/run was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/run was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional query request parameter validateOnly

    • info

      added the new optional query request parameter validateOnly

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      added the new DELAYED_EXECUTION_EXCEEDING_DURATION_LIMIT enum value to the request property //

    • info

      added the new DELAYED_EXECUTION_EXCEEDING_DURATION_LIMIT enum value to the request property /