Skip to main content

services

Overview

Nameservices
TypeResource
Idgoogle.run.services

Fields

NameDatatypeDescription
namestringThe 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}
descriptionstringUser-provided description of the Service. This field currently has a 512-character limit.
annotationsobjectUnstructured 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.
binaryAuthorizationobjectSettings for Binary Authorization feature.
clientstringArbitrary identifier for the API client.
clientVersionstringArbitrary version identifier for the API client.
conditionsarrayOutput 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.
createTimestringOutput only. The creation time.
creatorstringOutput only. Email address of the authenticated creator.
customAudiencesarrayOne or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
deleteTimestringOutput only. The deletion time.
etagstringOutput only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
expireTimestringOutput only. For a deleted resource, the time after which it will be permamently deleted.
generationstringOutput 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.
ingressstringProvides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
labelsobjectUnstructured 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 Service.
lastModifierstringOutput only. Email address of the last authenticated modifier.
latestCreatedRevisionstringOutput only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
latestReadyRevisionstringOutput only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
launchStagestringThe 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.
observedGenerationstringOutput 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.
reconcilingbooleanOutput 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.
satisfiesPzsbooleanOutput only. Reserved for future use.
templateobjectRevisionTemplate describes the data a revision should have when created from a template.
terminalConditionobjectDefines a status condition for a resource.
trafficarraySpecifies 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.
trafficStatusesarrayOutput only. Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
trafficTagsCleanupThresholdstringOptional. Override the traffic tag threshold limit. Garbage collection will start cleaning up non-serving tagged traffic targets based on creation item. The default value is 2000.
uidstringOutput only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTimestringOutput only. The last-modified time.
uristringOutput only. The main URI in which this Service is serving traffic.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, servicesIdGets information about a Service.
listSELECTlocationsId, projectsIdLists Services.
createINSERTlocationsId, projectsIdCreates a new Service in a given project and location.
deleteDELETElocationsId, projectsId, servicesIdDeletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.
_listEXEClocationsId, projectsIdLists Services.
patchEXEClocationsId, projectsId, servicesIdUpdates a Service.