Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha 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.v1alpha.Instance
Namespace
Google \ Cloud \ AlloyDb \ V1alphaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
↳ 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 |
Google\Protobuf\Timestamp
Output only. Create time stamp |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time stamp |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. Delete time stamp |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels as key value pairs |
↳ 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\V1alpha\Instance\MachineConfig
Configurations for the machines that host the underlying database engine. |
↳ availability_type |
int
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 |
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 on for true and off for false. This field must be omitted if the flag doesn't take a value. |
↳ writable_node |
Google\Cloud\AlloyDb\V1alpha\Instance\Node
Output only. This is set for the read-write VM of the PRIMARY instance only. |
↳ nodes |
array<Google\Cloud\AlloyDb\V1alpha\Instance\Node>
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. |
↳ query_insights_config |
Google\Cloud\AlloyDb\V1alpha\Instance\QueryInsightsInstanceConfig
Configuration for query insights. |
↳ read_pool_config |
Google\Cloud\AlloyDb\V1alpha\Instance\ReadPoolConfig
Read pool specific 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 |
string
For Resource freshness validation (https://google.aip.dev/154) |
↳ 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 |
↳ update_policy |
Google\Cloud\AlloyDb\V1alpha\Instance\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. |
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}
Returns | |
---|---|
Type | Description |
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}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
User-settable and human-readable display name for the Instance.
Returns | |
---|---|
Type | Description |
string |
setDisplayName
User-settable and human-readable display name for the Instance.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. Create time stamp
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time stamp
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. Update time stamp
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time stamp
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getDeleteTime
Output only. Delete time stamp
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. Delete time stamp
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Labels as key value pairs
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Labels as key value pairs
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. The current serving state of the instance.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. The current serving state of the instance.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getInstanceType
Required. The type of the instance. Specified at creation time.
Returns | |
---|---|
Type | Description |
int |
setInstanceType
Required. The type of the instance. Specified at creation time.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getMachineConfig
Configurations for the machines that host the underlying database engine.
Returns | |
---|---|
Type | Description |
Google\Cloud\AlloyDb\V1alpha\Instance\MachineConfig|null |
hasMachineConfig
clearMachineConfig
setMachineConfig
Configurations for the machines that host the underlying database engine.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AlloyDb\V1alpha\Instance\MachineConfig
|
Returns | |
---|---|
Type | Description |
$this |
getAvailabilityType
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 | |
---|---|
Type | Description |
int |
setAvailabilityType
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).
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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 on for true and off for false. This field must be omitted if the flag doesn't take a value.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
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 on for true and off for false. This field must be omitted if the flag doesn't take a value.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getWritableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
Returns | |
---|---|
Type | Description |
Google\Cloud\AlloyDb\V1alpha\Instance\Node|null |
hasWritableNode
clearWritableNode
setWritableNode
Output only. This is set for the read-write VM of the PRIMARY instance only.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AlloyDb\V1alpha\Instance\Node
|
Returns | |
---|---|
Type | Description |
$this |
getNodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setNodes
Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\AlloyDb\V1alpha\Instance\Node>
|
Returns | |
---|---|
Type | Description |
$this |
getQueryInsightsConfig
Configuration for query insights.
Returns | |
---|---|
Type | Description |
Google\Cloud\AlloyDb\V1alpha\Instance\QueryInsightsInstanceConfig|null |
hasQueryInsightsConfig
clearQueryInsightsConfig
setQueryInsightsConfig
Configuration for query insights.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AlloyDb\V1alpha\Instance\QueryInsightsInstanceConfig
|
Returns | |
---|---|
Type | Description |
$this |
getReadPoolConfig
Read pool specific config.
Returns | |
---|---|
Type | Description |
Google\Cloud\AlloyDb\V1alpha\Instance\ReadPoolConfig|null |
hasReadPoolConfig
clearReadPoolConfig
setReadPoolConfig
Read pool specific config.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AlloyDb\V1alpha\Instance\ReadPoolConfig
|
Returns | |
---|---|
Type | Description |
$this |
getIpAddress
Output only. The IP address for the Instance.
This is the connection endpoint for an end-user application.
Returns | |
---|---|
Type | Description |
string |
setIpAddress
Output only. The IP address for the Instance.
This is the connection endpoint for an end-user application.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getEtag
For Resource freshness validation (https://google.aip.dev/154)
Returns | |
---|---|
Type | Description |
string |
setEtag
For Resource freshness validation (https://google.aip.dev/154)
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setAnnotations
Annotations to allow client tools to store small amount of arbitrary data.
This is distinct from labels. https://google.aip.dev/128
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getUpdatePolicy
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.
Returns | |
---|---|
Type | Description |
Google\Cloud\AlloyDb\V1alpha\Instance\UpdatePolicy|null |
hasUpdatePolicy
clearUpdatePolicy
setUpdatePolicy
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\AlloyDb\V1alpha\Instance\UpdatePolicy
|
Returns | |
---|---|
Type | Description |
$this |