Class Instance

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Inheritance

object

Instance

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.CloudAlloyDBAdmin.v1.Data

Assembly: Google.Apis.CloudAlloyDBAdmin.v1.dll

Syntax

public class Instance : IDirectResponseSchema

Properties

ActivationPolicy

Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the NEVER to stop the instance. Likewise, the activation policy can be updated to ALWAYS to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.

Declaration

[JsonProperty("activationPolicy")]
public virtual string ActivationPolicy { get; set; }

Property Value

Type	Description
string

Annotations

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Declaration

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

Property Value

Type	Description
IDictionary<string, string>

AvailabilityType

Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

Declaration

[JsonProperty("availabilityType")]
public virtual string AvailabilityType { get; set; }

Property Value

Type	Description
string

ClientConnectionConfig

Optional. Client connection specific configurations

Declaration

[JsonProperty("clientConnectionConfig")]
public virtual ClientConnectionConfig ClientConnectionConfig { get; set; }

Property Value

Type	Description
ClientConnectionConfig

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. Create time stamp

Declaration

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

Property Value

Type	Description
string

DatabaseFlags

Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

Declaration

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

Property Value

Type	Description
IDictionary<string, 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. Delete time stamp

Declaration

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

Property Value

Type	Description
string

DisplayName

User-settable and human-readable display name for the Instance.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

For Resource freshness validation (https://google.aip.dev/154)

Declaration

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

Property Value

Type	Description
string

GceZone

The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

Declaration

[JsonProperty("gceZone")]
public virtual string GceZone { get; set; }

Property Value

Type	Description
string

InstanceType

Required. The type of the instance. Specified at creation time.

Declaration

[JsonProperty("instanceType")]
public virtual string InstanceType { get; set; }

Property Value

Type	Description
string

IpAddress

Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

Declaration

[JsonProperty("ipAddress")]
public virtual string IpAddress { get; set; }

Property Value

Type	Description
string

Labels

Labels as key value pairs

Declaration

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

Property Value

Type	Description
IDictionary<string, string>

MachineConfig

Configurations for the machines that host the underlying database engine.

Declaration

[JsonProperty("machineConfig")]
public virtual MachineConfig MachineConfig { get; set; }

Property Value

Type	Description
MachineConfig

Name

Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}

Declaration

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

Property Value

Type	Description
string

NetworkConfig

Optional. Instance-level network configuration.

Declaration

[JsonProperty("networkConfig")]
public virtual InstanceNetworkConfig NetworkConfig { get; set; }

Property Value

Type	Description
InstanceNetworkConfig

Nodes

Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

Declaration

[JsonProperty("nodes")]
public virtual IList<Node> Nodes { get; set; }

Property Value

Type	Description
IList<Node>

ObservabilityConfig

Configuration for observability.

Declaration

[JsonProperty("observabilityConfig")]
public virtual ObservabilityInstanceConfig ObservabilityConfig { get; set; }

Property Value

Type	Description
ObservabilityInstanceConfig

OutboundPublicIpAddresses

Output only. All outbound public IP addresses configured for the instance.

Declaration

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

Property Value

Type	Description
IList<string>

PscInstanceConfig

Optional. The configuration for Private Service Connect (PSC) for the instance.

Declaration

[JsonProperty("pscInstanceConfig")]
public virtual PscInstanceConfig PscInstanceConfig { get; set; }

Property Value

Type	Description
PscInstanceConfig

PublicIpAddress

Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.

Declaration

[JsonProperty("publicIpAddress")]
public virtual string PublicIpAddress { get; set; }

Property Value

Type	Description
string

QueryInsightsConfig

Configuration for query insights.

Declaration

[JsonProperty("queryInsightsConfig")]
public virtual QueryInsightsInstanceConfig QueryInsightsConfig { get; set; }

Property Value

Type	Description
QueryInsightsInstanceConfig

ReadPoolConfig

Read pool instance configuration. This is required if the value of instanceType is READ_POOL.

Declaration

[JsonProperty("readPoolConfig")]
public virtual ReadPoolConfig ReadPoolConfig { get; set; }

Property Value

Type	Description
ReadPoolConfig

Reconciling

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

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?

State

Output only. The current serving state of the instance.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

Uid

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it 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. Update time stamp

Declaration

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

Property Value

Type	Description
string

WritableNode

Output only. This is set for the read-write VM of the PRIMARY instance only.

Declaration

[JsonProperty("writableNode")]
public virtual Node WritableNode { get; set; }

Property Value

Type	Description
Node

Implements

IDirectResponseSchema