Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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} |
description |
str
User-provided description of the Service. This field currently has a 512-character limit. |
uid |
str
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. |
generation |
int
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.
|
labels |
MutableMapping[str, str]
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. .. raw:: html Cloud Run API v2 does not support labels with |
annotations |
MutableMapping[str, str]
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. .. raw:: html Cloud Run API v2 does not support annotations with This field follows Kubernetes annotations' namespacing, limits, and rules. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The last-modified time. |
delete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The deletion time. It is only populated as a response to a Delete request. |
expire_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. For a deleted resource, the time after which it will be permamently deleted. |
creator |
str
Output only. Email address of the authenticated creator. |
last_modifier |
str
Output only. Email address of the last authenticated modifier. |
client |
str
Arbitrary identifier for the API client. |
client_version |
str
Arbitrary version identifier for the API client. |
ingress |
google.cloud.run_v2.types.IngressTraffic
Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. |
launch_stage |
google.api.launch_stage_pb2.LaunchStage
Optional. The launch stage as defined by `Google Cloud Platform Launch Stages |
binary_authorization |
google.cloud.run_v2.types.BinaryAuthorization
Optional. Settings for the Binary Authorization feature. |
template |
google.cloud.run_v2.types.RevisionTemplate
Required. The template used to create revisions for this Service. |
traffic |
MutableSequence[google.cloud.run_v2.types.TrafficTarget]
Optional. 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.
|
scaling |
google.cloud.run_v2.types.ServiceScaling
Optional. Specifies service-level scaling settings |
invoker_iam_disabled |
bool
Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress. |
default_uri_disabled |
bool
Optional. Disables public resolution of the default URI of this service. |
urls |
MutableSequence[str]
Output only. All URLs serving traffic for this Service. |
custom_audiences |
MutableSequence[str]
One 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. |
observed_generation |
int
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.
|
terminal_condition |
google.cloud.run_v2.types.Condition
Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation
process in Cloud Run.
|
conditions |
MutableSequence[google.cloud.run_v2.types.Condition]
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.
|
latest_ready_revision |
str
Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional
information on reconciliation process in Cloud Run.
|
latest_created_revision |
str
Output only. Name of the last created revision. See comments in reconciling for additional information on
reconciliation process in Cloud Run.
|
traffic_statuses |
MutableSequence[google.cloud.run_v2.types.TrafficTargetStatus]
Output only. Detailed status information for corresponding traffic targets. See comments in reconciling for
additional information on reconciliation process in Cloud
Run.
|
uri |
str
Output only. The main URI in which this Service is serving traffic. |
satisfies_pzs |
bool
Output only. Reserved for future use. |
reconciling |
bool
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.
|
etag |
str
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |