Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1beta Client 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.
Generated from protobuf message google.cloud.alloydb.v1beta.Instance
Namespace
Google \ Cloud \ AlloyDb \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
↳ update_time
↳ delete_time
↳ labels
↳ state
int
Output only. The current serving state of the instance.
↳ instance_type
int
Required. The type of the instance. Specified at creation time.
↳ machine_config
Google\Cloud\AlloyDb\V1beta\Instance\MachineConfig
Configurations for the machines that host the underlying database engine.
↳ availability_type
int
Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.
↳ 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
array| Google\Protobuf\Internal\MapField
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 onfor true and offfor false. This field must be omitted if the flag doesn't take a value.
↳ writable_node
Google\Cloud\AlloyDb\V1beta\Instance\Node
Output only. This is set for the read-write VM of the PRIMARY instance only.
↳ nodes
array< Google\Cloud\AlloyDb\V1beta\Instance\Node
>
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
↳ query_insights_config
↳ read_pool_config
↳ ip_address
string
Output only. The IP address for the Instance. 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
↳ annotations
array| Google\Protobuf\Internal\MapField
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
getName
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}
string
setName
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}
var
string
$this
getDisplayName
User-settable and human-readable display name for the Instance.
string
setDisplayName
User-settable and human-readable display name for the Instance.
var
string
$this
getUid
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.
string
setUid
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.
var
string
$this
getCreateTime
Output only. Create time stamp
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time stamp
$this
getUpdateTime
Output only. Update time stamp
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time stamp
$this
getDeleteTime
Output only. Delete time stamp
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. Delete time stamp
$this
getLabels
Labels as key value pairs
setLabels
Labels as key value pairs
$this
getState
Output only. The current serving state of the instance.
int
setState
Output only. The current serving state of the instance.
var
int
$this
getInstanceType
Required. The type of the instance. Specified at creation time.
int
setInstanceType
Required. The type of the instance. Specified at creation time.
var
int
$this
getMachineConfig
Configurations for the machines that host the underlying database engine.
hasMachineConfig
clearMachineConfig
setMachineConfig
Configurations for the machines that host the underlying database engine.
$this
getAvailabilityType
Availability type of an Instance.
Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.
int
setAvailabilityType
Availability type of an Instance.
Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.
var
int
$this
getGceZone
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.
string
setGceZone
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.
var
string
$this
getDatabaseFlags
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 onfor true and offfor false. This field must be omitted if the flag doesn't take a value.
setDatabaseFlags
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 onfor true and offfor false. This field must be omitted if the flag doesn't take a value.
$this
getWritableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
hasWritableNode
clearWritableNode
setWritableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
$this
getNodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
setNodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
$this
getQueryInsightsConfig
Configuration for query insights.
hasQueryInsightsConfig
clearQueryInsightsConfig
setQueryInsightsConfig
Configuration for query insights.
$this
getReadPoolConfig
Read pool specific config.
hasReadPoolConfig
clearReadPoolConfig
setReadPoolConfig
Read pool specific config.
$this
getIpAddress
Output only. The IP address for the Instance.
This is the connection endpoint for an end-user application.
string
setIpAddress
Output only. The IP address for the Instance.
This is the connection endpoint for an end-user application.
var
string
$this
getReconciling
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.
bool
setReconciling
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.
var
bool
$this
getEtag
For Resource freshness validation ( https://google.aip.dev/154 )
string
setEtag
For Resource freshness validation ( https://google.aip.dev/154 )
var
string
$this
getAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
setAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
$this
