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.
labels
Mapping[str, str]
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 will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.
annotations
Mapping[str, str]
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 will populate some annotations using 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations
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.
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
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
The launch stage as defined by `Google Cloud Platform Launch Stages
binary_authorization
template
google.cloud.run_v2.types.RevisionTemplate
Required. The template used to create revisions for this Service.
traffic
Sequence[ google.cloud.run_v2.types.TrafficTarget
]
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.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.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
Sequence[ 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
Sequence[ 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.
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, .Message
]
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 mapping
is a mapping type or there are keyword parameters.
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, .Message
]
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 mapping
is a mapping type or there are keyword parameters.
