Cloud Run Admin v2 API - Class Service (2.1.0)

public sealed class Service : IMessage<Service>, IEquatable<Service>, IDeepCloneable<Service>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Run Admin v2 API class 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.

Inheritance

object > Service

Implements

IMessage Service, IEquatable Service, IDeepCloneable Service, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

Service()

public Service()

Service(Service)

public Service(Service other)

Parameter
Name	Description
`other`	`Service`

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

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

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

Property Value
Type	Description
`MapFieldstringstring`

BinaryAuthorization

public BinaryAuthorization BinaryAuthorization { get; set; }

Settings for the Binary Authorization feature.

Property Value
Type	Description
`BinaryAuthorization`

Client

public string Client { get; set; }

Arbitrary identifier for the API client.

Property Value
Type	Description
`string`

ClientVersion

public string ClientVersion { get; set; }

Arbitrary version identifier for the API client.

Property Value
Type	Description
`string`

Conditions

public RepeatedField<Condition> Conditions { get; }

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.

Property Value
Type	Description
`RepeatedFieldCondition`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation time.

Property Value
Type	Description
`Timestamp`

Creator

public string Creator { get; set; }

Output only. Email address of the authenticated creator.

Property Value
Type	Description
`string`

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. The deletion time.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

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

Property Value
Type	Description
`string`

Etag

public string Etag { get; set; }

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

Property Value
Type	Description
`string`

ExpireTime

public Timestamp ExpireTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

Generation

public long Generation { get; set; }

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.

Property Value
Type	Description
`long`

Ingress

public IngressTraffic Ingress { get; set; }

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

Property Value
Type	Description
`IngressTraffic`

Labels

public MapField<string, string> Labels { get; }

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.

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

Property Value
Type	Description
`MapFieldstringstring`

LastModifier

public string LastModifier { get; set; }

Output only. Email address of the last authenticated modifier.

Property Value
Type	Description
`string`

LatestCreatedRevision

public string LatestCreatedRevision { get; set; }

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

Property Value
Type	Description
`string`

LatestCreatedRevisionAsRevisionName

public RevisionName LatestCreatedRevisionAsRevisionName { get; set; }

RevisionName-typed view over the LatestCreatedRevision resource name property.

Property Value
Type	Description
`RevisionName`

LatestReadyRevision

public string LatestReadyRevision { get; set; }

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

Property Value
Type	Description
`string`

LatestReadyRevisionAsRevisionName

public RevisionName LatestReadyRevisionAsRevisionName { get; set; }

RevisionName-typed view over the LatestReadyRevision resource name property.

Property Value
Type	Description
`RevisionName`

LaunchStage

public LaunchStage LaunchStage { get; set; }

The 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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Property Value
Type	Description
`LaunchStage`

Name

public string Name { get; set; }

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}

Property Value
Type	Description
`string`

ObservedGeneration

public long ObservedGeneration { get; set; }

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.

Property Value
Type	Description
`long`

Reconciling

public bool Reconciling { get; set; }

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.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type	Description
`bool`

ServiceName

public ServiceName ServiceName { get; set; }

ServiceName-typed view over the Name resource name property.

Property Value
Type	Description
`ServiceName`

Template

public RevisionTemplate Template { get; set; }

Required. The template used to create revisions for this Service.

Property Value
Type	Description
`RevisionTemplate`

TerminalCondition

public Condition TerminalCondition { get; set; }

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.

Property Value
Type	Description
`Condition`

Traffic

public RepeatedField<TrafficTarget> Traffic { get; }

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.

Property Value
Type	Description
`RepeatedFieldTrafficTarget`

TrafficStatuses

public RepeatedField<TrafficTargetStatus> TrafficStatuses { get; }

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

Property Value
Type	Description
`RepeatedFieldTrafficTargetStatus`

Uid

public string Uid { get; set; }

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.

Property Value
Type	Description
`string`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The last-modified time.

Property Value
Type	Description
`Timestamp`

Uri

public string Uri { get; set; }

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

Property Value
Type	Description
`string`