Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Service.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 Service.This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 Service.This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations
-
(::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 Service.This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations
#binary_authorization
def binary_authorization() -> ::Google::Cloud::Run::V2::BinaryAuthorization
- (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
#binary_authorization=
def binary_authorization=(value) -> ::Google::Cloud::Run::V2::BinaryAuthorization
- value (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
- (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
#client
def client() -> ::String
- (::String) — Arbitrary identifier for the API client.
#client=
def client=(value) -> ::String
- value (::String) — Arbitrary identifier for the API client.
- (::String) — Arbitrary identifier for the API client.
#client_version
def client_version() -> ::String
- (::String) — Arbitrary version identifier for the API client.
#client_version=
def client_version=(value) -> ::String
- value (::String) — Arbitrary version identifier for the API client.
- (::String) — Arbitrary version identifier for the API client.
#conditions
def conditions() -> ::Array<::Google::Cloud::Run::V2::Condition>
-
(::Array<::Google::Cloud::Run::V2::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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The creation time.
#creator
def creator() -> ::String
- (::String) — Output only. Email address of the authenticated creator.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The deletion time.
#description
def description() -> ::String
- (::String) — User-provided description of the Service. This field currently has a 512-character limit.
#description=
def description=(value) -> ::String
- value (::String) — User-provided description of the Service. This field currently has a 512-character limit.
- (::String) — User-provided description of the Service. This field currently has a 512-character limit.
#etag
def etag() -> ::String
- (::String) — Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. For a deleted resource, the time after which it will be permamently deleted.
#generation
def generation() -> ::Integer
-
(::Integer) — 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 aninteger
.
#ingress
def ingress() -> ::Google::Cloud::Run::V2::IngressTraffic
- (::Google::Cloud::Run::V2::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.
#ingress=
def ingress=(value) -> ::Google::Cloud::Run::V2::IngressTraffic
- value (::Google::Cloud::Run::V2::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.
- (::Google::Cloud::Run::V2::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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service.
-
(::Google::Protobuf::Map{::String => ::String}) — 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
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service.
#last_modifier
def last_modifier() -> ::String
- (::String) — Output only. Email address of the last authenticated modifier.
#latest_created_revision
def latest_created_revision() -> ::String
-
(::String) — Output only. Name of the last created revision. See comments in
reconciling
for additional information on reconciliation process in Cloud Run.
#latest_ready_revision
def latest_ready_revision() -> ::String
-
(::String) — Output only. Name of the latest revision that is serving traffic. See
comments in
reconciling
for additional information on reconciliation process in Cloud Run.
#launch_stage
def launch_stage() -> ::Google::Api::LaunchStage
-
(::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed.
#launch_stage=
def launch_stage=(value) -> ::Google::Api::LaunchStage
-
value (::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed.
-
(::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed.
#name
def name() -> ::String
-
(::String) — 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}
#name=
def name=(value) -> ::String
-
value (::String) — 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) — 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}
#observed_generation
def observed_generation() -> ::Integer
-
(::Integer) — 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 astring
instead of aninteger
.
#reconciling
def reconciling() -> ::Boolean
-
(::Boolean) — 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
, anduri
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 interminal_condition.state
.If reconciliation succeeded, the following fields will match:
traffic
andtraffic_statuses
,observed_generation
andgeneration
,latest_ready_revision
andlatest_created_revision
.If reconciliation failed,
traffic_statuses
,observed_generation
, andlatest_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 interminal_condition
andconditions
.
#template
def template() -> ::Google::Cloud::Run::V2::RevisionTemplate
- (::Google::Cloud::Run::V2::RevisionTemplate) — Required. The template used to create revisions for this Service.
#template=
def template=(value) -> ::Google::Cloud::Run::V2::RevisionTemplate
- value (::Google::Cloud::Run::V2::RevisionTemplate) — Required. The template used to create revisions for this Service.
- (::Google::Cloud::Run::V2::RevisionTemplate) — Required. The template used to create revisions for this Service.
#terminal_condition
def terminal_condition() -> ::Google::Cloud::Run::V2::Condition
-
(::Google::Cloud::Run::V2::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.
#traffic
def traffic() -> ::Array<::Google::Cloud::Run::V2::TrafficTarget>
-
(::Array<::Google::Cloud::Run::V2::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.
#traffic=
def traffic=(value) -> ::Array<::Google::Cloud::Run::V2::TrafficTarget>
-
value (::Array<::Google::Cloud::Run::V2::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.
-
(::Array<::Google::Cloud::Run::V2::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.
#traffic_statuses
def traffic_statuses() -> ::Array<::Google::Cloud::Run::V2::TrafficTargetStatus>
-
(::Array<::Google::Cloud::Run::V2::TrafficTargetStatus>) — Output only. Detailed status information for corresponding traffic targets.
See comments in
reconciling
for additional information on reconciliation process in Cloud Run.
#uid
def uid() -> ::String
- (::String) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The last-modified time.
#uri
def uri() -> ::String
- (::String) — Output only. The main URI in which this Service is serving traffic.