AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::Instance (v0.9.1)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::Instance.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

#availability_type

def availability_type() -> ::Google::Cloud::AlloyDB::V1::Instance::AvailabilityType
Returns
  • (::Google::Cloud::AlloyDB::V1::Instance::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).

#availability_type=

def availability_type=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::AvailabilityType
Parameter
  • value (::Google::Cloud::AlloyDB::V1::Instance::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).
Returns
  • (::Google::Cloud::AlloyDB::V1::Instance::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).

#client_connection_config

def client_connection_config() -> ::Google::Cloud::AlloyDB::V1::Instance::ClientConnectionConfig
Returns

#client_connection_config=

def client_connection_config=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::ClientConnectionConfig
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#database_flags

def database_flags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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.

#database_flags=

def database_flags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::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.

Returns
  • (::Google::Protobuf::Map{::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.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — User-settable and human-readable display name for the Instance.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User-settable and human-readable display name for the Instance.
Returns
  • (::String) — User-settable and human-readable display name for the Instance.

#etag

def etag() -> ::String
Returns
  • (::String) — For Resource freshness validation (https://google.aip.dev/154)

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — For Resource freshness validation (https://google.aip.dev/154)
Returns
  • (::String) — For Resource freshness validation (https://google.aip.dev/154)

#gce_zone

def gce_zone() -> ::String
Returns
  • (::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.

#gce_zone=

def gce_zone=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#instance_type

def instance_type() -> ::Google::Cloud::AlloyDB::V1::Instance::InstanceType
Returns

#instance_type=

def instance_type=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::InstanceType
Parameter
Returns

#ip_address

def ip_address() -> ::String
Returns
  • (::String) — Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#machine_config

def machine_config() -> ::Google::Cloud::AlloyDB::V1::Instance::MachineConfig
Returns

#machine_config=

def machine_config=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::MachineConfig
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::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}

#nodes

def nodes() -> ::Array<::Google::Cloud::AlloyDB::V1::Instance::Node>
Returns

#query_insights_config

def query_insights_config() -> ::Google::Cloud::AlloyDB::V1::Instance::QueryInsightsInstanceConfig
Returns

#query_insights_config=

def query_insights_config=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::QueryInsightsInstanceConfig
Parameter
Returns

#read_pool_config

def read_pool_config() -> ::Google::Cloud::AlloyDB::V1::Instance::ReadPoolConfig
Returns

#read_pool_config=

def read_pool_config=(value) -> ::Google::Cloud::AlloyDB::V1::Instance::ReadPoolConfig
Parameter
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — 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.

#state

def state() -> ::Google::Cloud::AlloyDB::V1::Instance::State
Returns

#uid

def uid() -> ::String
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#writable_node

def writable_node() -> ::Google::Cloud::AlloyDB::V1::Instance::Node
Returns