AlloyDB v1 API - Class Instance (1.9.0)

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

Reference documentation and code samples for the AlloyDB v1 API 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

IMessage Instance, IEquatable Instance, IDeepCloneable Instance, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)

Parameter
Name	Description
`other`	`Instance`

Properties

Annotations

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

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

Property Value
Type	Description
`MapFieldstringstring`

AvailabilityType

public Instance.Types.AvailabilityType AvailabilityType { get; set; }

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

Property Value
Type	Description
`InstanceTypesAvailabilityType`

ClientConnectionConfig

public Instance.Types.ClientConnectionConfig ClientConnectionConfig { get; set; }

Optional. Client connection specific configurations

Property Value
Type	Description
`InstanceTypesClientConnectionConfig`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Create time stamp

Property Value
Type	Description
`Timestamp`

DatabaseFlags

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

Database flags. Set at instance level.

They are copied from primary instance on read instance creation.
Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

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.

Property Value
Type	Description
`MapFieldstringstring`

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. Delete time stamp

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type	Description
`string`

Etag

public string Etag { get; set; }

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

Property Value
Type	Description
`string`

GceZone

public string GceZone { get; set; }

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.

Property Value
Type	Description
`string`

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type	Description
`InstanceName`

InstanceType

public Instance.Types.InstanceType InstanceType { get; set; }

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

Property Value
Type	Description
`InstanceTypesInstanceType`

IpAddress

public string IpAddress { get; set; }

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

Property Value
Type	Description
`string`

Labels

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

Labels as key value pairs

Property Value
Type	Description
`MapFieldstringstring`

MachineConfig

public Instance.Types.MachineConfig MachineConfig { get; set; }

Configurations for the machines that host the underlying database engine.

Property Value
Type	Description
`InstanceTypesMachineConfig`

Name

public string Name { get; set; }

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}

Property Value
Type	Description
`string`

NetworkConfig

public Instance.Types.InstanceNetworkConfig NetworkConfig { get; set; }

Optional. Instance-level network configuration.

Property Value
Type	Description
`InstanceTypesInstanceNetworkConfig`

Nodes

public RepeatedField<Instance.Types.Node> Nodes { get; }

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

Property Value
Type	Description
`RepeatedFieldInstanceTypesNode`

OutboundPublicIpAddresses

public RepeatedField<string> OutboundPublicIpAddresses { get; }

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

Property Value
Type	Description
`RepeatedFieldstring`

PscInstanceConfig

public Instance.Types.PscInstanceConfig PscInstanceConfig { get; set; }

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

Property Value
Type	Description
`InstanceTypesPscInstanceConfig`

PublicIpAddress

public string PublicIpAddress { get; set; }

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.

Property Value
Type	Description
`string`

QueryInsightsConfig

public Instance.Types.QueryInsightsInstanceConfig QueryInsightsConfig { get; set; }

Configuration for query insights.

Property Value
Type	Description
`InstanceTypesQueryInsightsInstanceConfig`

ReadPoolConfig

public Instance.Types.ReadPoolConfig ReadPoolConfig { get; set; }

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

Property Value
Type	Description
`InstanceTypesReadPoolConfig`

Reconciling

public bool Reconciling { get; set; }

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.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type	Description
`bool`

State

public Instance.Types.State State { get; set; }

Output only. The current serving state of the instance.

Property Value
Type	Description
`InstanceTypesState`

Uid

public string Uid { get; set; }

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.

Property Value
Type	Description
`string`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Update time stamp

Property Value
Type	Description
`Timestamp`

WritableNode

public Instance.Types.Node WritableNode { get; set; }

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

Property Value
Type	Description
`InstanceTypesNode`