provider projects PATCH /v2/{name}
@utdk/google-cloud-run /v2/{name}
run.projects.locations.services.patch
Updates a Service.
$.xgafv query
V1 error format.
enum: 1, 2
access_token query
OAuth access token.
string
alt query
Data format for response.
enum: json, media, proto
callback query
JSONP
string
fields query
Selector specifying which fields to include in a partial response.
string
key query
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string
oauth_token query
OAuth 2.0 token for the current user.
string
prettyPrint query
Returns response with indentations and line breaks.
boolean
quotaUser query
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
upload_protocol query
Upload protocol for media (e.g. "raw", "multipart").
string
uploadType query
Legacy upload protocol for media (e.g. "media", "multipart").
string
name path required
The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}
string
allowMissing query
This field is currently not used by Cloud Run; setting it does not have any effect.
boolean
validateOnly query
Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
boolean

Try it

Authentication
Configure credentials for Cloud Run Admin API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

runProjectsLocationsServicesPatch
PATCH/v2/{name}
Updates a Service.

Parameters

required

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}

V1 error format.

OAuth access token.

Data format for response.

JSONP

Selector specifying which fields to include in a partial response.

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

OAuth 2.0 token for the current user.

Returns response with indentations and line breaks.

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Upload protocol for media (e.g. "raw", "multipart").

Legacy upload protocol for media (e.g. "media", "multipart").

This field is currently not used by Cloud Run; setting it does not have any effect.

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

Input

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 Service. This field follows Kubernetes annotations' namespacing, limits, and rules.

Settings for Binary Authorization feature.

Arbitrary identifier for the API client.

Arbitrary version identifier for the API client.

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.

Output only. The creation time.

Output only. Email address of the authenticated creator.

Output only. The deletion time.

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

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

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

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

Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.

Map of string keys and values 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 Service.

Output only. Email address of the last authenticated modifier.

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

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

The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/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.

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}

Output only. The generation of this Service currently serving traffic. 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`.

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_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 Service, 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: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`.

Output only. Reserved for future use.

RevisionTemplate describes the data a revision should have when created from a template.

Defines a status condition for a resource.

Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision.

Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.

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.

Output only. The last-modified time.

Output only. The main URI in which this Service is serving traffic.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import google_cloud_run from '@utdk/google-cloud-run';

await google_cloud_run.runProjectsLocationsServicesPatch()