Class GoogleCloudRunV2WorkerPool

WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool 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

GoogleCloudRunV2WorkerPool

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRun.v2.Data

Assembly: Google.Apis.CloudRun.v2.dll

Syntax

public class GoogleCloudRunV2WorkerPool : IDirectResponseSchema

Properties

Annotations

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. 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 WorkerPool. This field follows Kubernetes annotations' namespacing, limits, and rules.

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

BinaryAuthorization

Optional. Settings for the Binary Authorization feature.

Declaration

[JsonProperty("binaryAuthorization")]
public virtual GoogleCloudRunV2BinaryAuthorization BinaryAuthorization { get; set; }

Property Value

Type	Description
GoogleCloudRunV2BinaryAuthorization

Client

Arbitrary identifier for the API client.

Declaration

[JsonProperty("client")]
public virtual string Client { get; set; }

Property Value

Type	Description
string

ClientVersion

Arbitrary version identifier for the API client.

Declaration

[JsonProperty("clientVersion")]
public virtual string ClientVersion { get; set; }

Property Value

Type	Description
string

Conditions

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Declaration

[JsonProperty("conditions")]
public virtual IList<GoogleCloudRunV2Condition> Conditions { get; set; }

Property Value

Type	Description
IList<GoogleCloudRunV2Condition>

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The creation time.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

Creator

Output only. Email address of the authenticated creator.

Declaration

[JsonProperty("creator")]
public virtual string Creator { get; set; }

Property Value

Type	Description
string

CustomAudiences

One or more custom audiences that you want this worker pool 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.

Declaration

[JsonProperty("customAudiences")]
public virtual IList<string> CustomAudiences { get; set; }

Property Value

Type	Description
IList<string>

DeleteTime

object representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }

Property Value

Type	Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DeleteTimeRaw

Output only. The deletion time. It is only populated as a response to a Delete request.

Declaration

[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }

Property Value

Type	Description
string

Description

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

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

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

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExpireTime

object representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }

Property Value

Type	Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ExpireTimeRaw

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

Declaration

[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }

Property Value

Type	Description
string

Generation

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.

Declaration

[JsonProperty("generation")]
public virtual long? Generation { get; set; }

Property Value

Type	Description
long?

InstanceSplitStatuses

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

Declaration

[JsonProperty("instanceSplitStatuses")]
public virtual IList<GoogleCloudRunV2InstanceSplitStatus> InstanceSplitStatuses { get; set; }

Property Value

Type	Description
IList<GoogleCloudRunV2InstanceSplitStatus>

InstanceSplits

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

Declaration

[JsonProperty("instanceSplits")]
public virtual IList<GoogleCloudRunV2InstanceSplit> InstanceSplits { get; set; }

Property Value

Type	Description
IList<GoogleCloudRunV2InstanceSplit>

Labels

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

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

LastModifier

Output only. Email address of the last authenticated modifier.

Declaration

[JsonProperty("lastModifier")]
public virtual string LastModifier { get; set; }

Property Value

Type	Description
string

LatestCreatedRevision

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

Declaration

[JsonProperty("latestCreatedRevision")]
public virtual string LatestCreatedRevision { get; set; }

Property Value

Type	Description
string

LatestReadyRevision

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

Declaration

[JsonProperty("latestReadyRevision")]
public virtual string LatestReadyRevision { get; set; }

Property Value

Type	Description
string

LaunchStage

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

Declaration

[JsonProperty("launchStage")]
public virtual string LaunchStage { get; set; }

Property Value

Type	Description
string

Name

The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ObservedGeneration

Output only. The generation of this WorkerPool 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.

Declaration

[JsonProperty("observedGeneration")]
public virtual long? ObservedGeneration { get; set; }

Property Value

Type	Description
long?

Reconciling

Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool 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 WorkerPool, 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 WorkerPools. Additional information on the failure can be found in terminal_condition and conditions.

Declaration

[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

Scaling

Optional. Specifies worker-pool-level scaling settings

Declaration

[JsonProperty("scaling")]
public virtual GoogleCloudRunV2WorkerPoolScaling Scaling { get; set; }

Property Value

Type	Description
GoogleCloudRunV2WorkerPoolScaling

Template

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

Declaration

[JsonProperty("template")]
public virtual GoogleCloudRunV2WorkerPoolRevisionTemplate Template { get; set; }

Property Value

Type	Description
GoogleCloudRunV2WorkerPoolRevisionTemplate

TerminalCondition

Output only. The Condition of this WorkerPool, 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.

Declaration

[JsonProperty("terminalCondition")]
public virtual GoogleCloudRunV2Condition TerminalCondition { get; set; }

Property Value

Type	Description
GoogleCloudRunV2Condition

Uid

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.

Declaration

[JsonProperty("uid")]
public virtual string Uid { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. The last-modified time.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema