Cloud Run Admin v2 API - Class Instance (2.19.0)

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

Reference documentation and code samples for the Cloud Run Admin v2 API class Instance.

A Cloud Run Instance represents a single group of containers running in a region.

Inheritance

object > Instance

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)
Parameter
Name Description
other Instance

Properties

Annotations

public MapField<string, string> Annotations { get; }
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 Instance does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Property Value
Type Description
RepeatedFieldCondition

ContainerStatuses

public RepeatedField<ContainerStatus> ContainerStatuses { get; }

Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images.

Property Value
Type Description
RepeatedFieldContainerStatus

Containers

public RepeatedField<Container> Containers { get; }

Required. Holds the single container that defines the unit of execution for this Instance.

Property Value
Type Description
RepeatedFieldContainer

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 Instance. This field currently has a 512-character limit.

Property Value
Type Description
string

EncryptionKey

public string EncryptionKey { get; set; }

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

Property Value
Type Description
string

EncryptionKeyAsCryptoKeyName

public CryptoKeyName EncryptionKeyAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the EncryptionKey resource name property.

Property Value
Type Description
CryptoKeyName

EncryptionKeyRevocationAction

public EncryptionKeyRevocationAction EncryptionKeyRevocationAction { get; set; }

The action to take if the encryption key is revoked.

Property Value
Type Description
EncryptionKeyRevocationAction

EncryptionKeyShutdownDuration

public Duration EncryptionKeyShutdownDuration { get; set; }

If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

Property Value
Type Description
Duration

Etag

public string Etag { get; set; }

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

GpuZonalRedundancyDisabled

public bool GpuZonalRedundancyDisabled { get; set; }

Optional. True if GPU zonal redundancy is disabled on this instance.

Property Value
Type Description
bool

HasGpuZonalRedundancyDisabled

public bool HasGpuZonalRedundancyDisabled { get; }

Gets whether the "gpu_zonal_redundancy_disabled" field is set

Property Value
Type Description
bool

IapEnabled

public bool IapEnabled { get; set; }

Optional. IAP settings on the Instance.

Property Value
Type Description
bool

Ingress

public IngressTraffic Ingress { get; set; }

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

Property Value
Type Description
IngressTraffic

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type Description
InstanceName

InvokerIamDisabled

public bool InvokerIamDisabled { get; set; }

Optional. Disables IAM permission check for run.routes.invoke for callers of this Instance. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }
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

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

LogUri

public string LogUri { get; set; }

Output only. The Google Console URI to obtain logs for the Instance.

Property Value
Type Description
string

Name

public string Name { get; set; }

The fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id.

Format: projects/{project}/locations/{location}/instances/{instance_id}

Property Value
Type Description
string

NodeSelector

public NodeSelector NodeSelector { get; set; }

Optional. The node selector for the instance.

Property Value
Type Description
NodeSelector

ObservedGeneration

public long ObservedGeneration { get; set; }

Output only. The generation of this Instance 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 Instance is currently being acted upon by the system to bring it into the desired state.

When a new Instance is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Instance to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation will have a transient value 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 Instance, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

ServiceAccount

public string ServiceAccount { get; set; }
Property Value
Type Description
string

TerminalCondition

public Condition TerminalCondition { get; set; }

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

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

Urls

public RepeatedField<string> Urls { get; }

Output only. All URLs serving traffic for this Instance.

Property Value
Type Description
RepeatedFieldstring

Volumes

public RepeatedField<Volume> Volumes { get; }

A list of Volumes to make available to containers.

Property Value
Type Description
RepeatedFieldVolume

VpcAccess

public VpcAccess VpcAccess { get; set; }

Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Property Value
Type Description
VpcAccess