Struct Instance

pub struct Instance {

    pub name: String,
    pub display_name: String,
    pub uid: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub state: i32,
    pub instance_type: i32,
    pub machine_config: Option<MachineConfig>,
    pub availability_type: i32,
    pub gce_zone: String,
    pub database_flags: HashMap<String, String>,
    pub writable_node: Option<Node>,
    pub nodes: Vec<Node>,
    pub query_insights_config: Option<QueryInsightsInstanceConfig>,
    pub observability_config: Option<ObservabilityInstanceConfig>,
    pub read_pool_config: Option<ReadPoolConfig>,
    pub ip_address: String,
    pub public_ip_address: String,
    pub reconciling: bool,
    pub etag: String,
    pub annotations: HashMap<String, String>,
    pub update_policy: Option<UpdatePolicy>,
    pub client_connection_config: Option<ClientConnectionConfig>,
    pub satisfies_pzs: bool,
    pub psc_instance_config: Option<PscInstanceConfig>,
    pub network_config: Option<InstanceNetworkConfig>,
    pub gemini_config: Option<GeminiInstanceConfig>,
    pub outbound_public_ip_addresses: Vec<String>,
}

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

Fields

name: String

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}

display_name: String

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

uid: String

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.

create_time: Option<Timestamp>

Output only. Create time stamp

update_time: Option<Timestamp>

Output only. Update time stamp

delete_time: Option<Timestamp>

Output only. Delete time stamp

labels: HashMap<String, String>

Labels as key value pairs

state: i32

Output only. The current serving state of the instance.

instance_type: i32

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

machine_config: Option<MachineConfig>

Configurations for the machines that host the underlying database engine.

availability_type: i32

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

gce_zone: String

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.

database_flags: HashMap<String, String>

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.

writable_node: Option<Node>

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

nodes: Vec<Node>

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

query_insights_config: Option<QueryInsightsInstanceConfig>

Configuration for query insights.

observability_config: Option<ObservabilityInstanceConfig>

Configuration for observability.

read_pool_config: Option<ReadPoolConfig>

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

ip_address: String

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

public_ip_address: String

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.

reconciling: bool

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.

etag: String

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

annotations: HashMap<String, String>

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

update_policy: Option<UpdatePolicy>

Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.

client_connection_config: Option<ClientConnectionConfig>

Optional. Client connection specific configurations

satisfies_pzs: bool

Output only. Reserved for future use.

psc_instance_config: Option<PscInstanceConfig>

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

network_config: Option<InstanceNetworkConfig>

Optional. Instance-level network configuration.

gemini_config: Option<GeminiInstanceConfig>

Optional. Configuration parameters related to the Gemini in Databases add-on.

outbound_public_ip_addresses: Vec<String>

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

Implementations

impl Instance

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn instance_type(&self) -> InstanceType

Returns the enum value of instance_type, or the default if the field is set to an invalid enum value.

pub fn set_instance_type(&mut self, value: InstanceType)

Sets instance_type to the provided enum value.

pub fn availability_type(&self) -> AvailabilityType

Returns the enum value of availability_type, or the default if the field is set to an invalid enum value.

pub fn set_availability_type(&mut self, value: AvailabilityType)

Sets availability_type to the provided enum value.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Self

Returns the “default value” for a type.

impl Message for Instance

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Instance

fn eq(&self, other: &Instance) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Instance