Google Cloud Sql Admin V1 Client - Class DatabaseInstance (0.19.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class DatabaseInstance.

A Cloud SQL instance resource.

Generated from protobuf message google.cloud.sql.v1.DatabaseInstance

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ kind string

This is always sql#instance.
↳ state int

The current serving state of the Cloud SQL instance.
↳ database_version int

The database engine type and version. The databaseVersion field cannot be changed after instance creation.
↳ settings Google\Cloud\Sql\V1\Settings

The user settings.
↳ etag string

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.
↳ failover_replica Google\Cloud\Sql\V1\DatabaseInstance\SqlFailoverReplica

The name and status of the failover replica.
↳ master_instance_name string

The name of the instance which will act as primary in the replication setup.
↳ replica_names array

The replicas of the instance.
↳ max_disk_size Google\Protobuf\Int64Value

The maximum disk size of the instance in bytes.
↳ current_disk_size Google\Protobuf\Int64Value

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
↳ ip_addresses array<Google\Cloud\Sql\V1\IpMapping>

The assigned IP addresses for the instance.
↳ server_ca_cert Google\Cloud\Sql\V1\SslCert

SSL configuration.
↳ instance_type int

The instance type.
↳ project string

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
↳ ipv6_address string

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
↳ service_account_email_address string

The service account email address assigned to the instance.\This property is read-only.
↳ on_premises_configuration Google\Cloud\Sql\V1\OnPremisesConfiguration

Configuration specific to on-premises instances.
↳ replica_configuration Google\Cloud\Sql\V1\ReplicaConfiguration

Configuration specific to failover replicas and read replicas.
↳ backend_type int

The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.
↳ self_link string

The URI of this resource.
↳ suspension_reason array

If the instance state is SUSPENDED, the reason for the suspension.
↳ connection_name string

Connection name of the Cloud SQL instance used in connection strings.
↳ name string

Name of the Cloud SQL instance. This does not include the project ID.
↳ region string

The geographical region of the Cloud SQL instance. It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.
↳ gce_zone string

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.
↳ secondary_gce_zone string

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.
↳ disk_encryption_configuration Google\Cloud\Sql\V1\DiskEncryptionConfiguration

Disk encryption configuration specific to an instance.
↳ disk_encryption_status Google\Cloud\Sql\V1\DiskEncryptionStatus

Disk encryption status specific to an instance.
↳ root_password string

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
↳ scheduled_maintenance Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance

The start time of any upcoming scheduled maintenance for this instance.
↳ satisfies_pzs Google\Protobuf\BoolValue

This status indicates whether the instance satisfies PZS. The status is reserved for future use.
↳ database_installed_version string

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.
↳ out_of_disk_report Google\Cloud\Sql\V1\DatabaseInstance\SqlOutOfDiskReport

This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job
↳ create_time Google\Protobuf\Timestamp

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
↳ available_maintenance_versions array

Output only. List all maintenance versions applicable on the instance
↳ maintenance_version string

The current software version on the instance.
↳ sql_network_architecture int
↳ psc_service_attachment_link string

Output only. The link to service attachment of PSC instance.
↳ dns_name string

Output only. The dns name of the instance.
↳ primary_dns_name string

Output only. DEPRECATED: please use write_endpoint instead.
↳ write_endpoint string

Output only. The dns name of the primary instance in a replication group.
↳ replication_cluster Google\Cloud\Sql\V1\ReplicationCluster

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
↳ gemini_config Google\Cloud\Sql\V1\GeminiInstanceConfig

Gemini instance configuration.

getKind

This is always sql#instance.

Returns
Type Description
string

setKind

This is always sql#instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

The current serving state of the Cloud SQL instance.

Returns
Type Description
int

setState

The current serving state of the Cloud SQL instance.

Parameter
Name Description
var int
Returns
Type Description
$this

getDatabaseVersion

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

Returns
Type Description
int

setDatabaseVersion

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

Parameter
Name Description
var int
Returns
Type Description
$this

getSettings

The user settings.

Returns
Type Description
Google\Cloud\Sql\V1\Settings|null

hasSettings

clearSettings

setSettings

The user settings.

Parameter
Name Description
var Google\Cloud\Sql\V1\Settings
Returns
Type Description
$this

getEtag

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

Returns
Type Description
string

setEtag

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

Parameter
Name Description
var string
Returns
Type Description
$this

getFailoverReplica

The name and status of the failover replica.

Returns
Type Description
Google\Cloud\Sql\V1\DatabaseInstance\SqlFailoverReplica|null

hasFailoverReplica

clearFailoverReplica

setFailoverReplica

The name and status of the failover replica.

Parameter
Name Description
var Google\Cloud\Sql\V1\DatabaseInstance\SqlFailoverReplica
Returns
Type Description
$this

getMasterInstanceName

The name of the instance which will act as primary in the replication setup.

Returns
Type Description
string

setMasterInstanceName

The name of the instance which will act as primary in the replication setup.

Parameter
Name Description
var string
Returns
Type Description
$this

getReplicaNames

The replicas of the instance.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReplicaNames

The replicas of the instance.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMaxDiskSize

The maximum disk size of the instance in bytes.

Returns
Type Description
Google\Protobuf\Int64Value|null

hasMaxDiskSize

clearMaxDiskSize

getMaxDiskSizeValue

Returns the unboxed value from getMaxDiskSize()

The maximum disk size of the instance in bytes.

Returns
Type Description
int|string|null

setMaxDiskSize

The maximum disk size of the instance in bytes.

Parameter
Name Description
var Google\Protobuf\Int64Value
Returns
Type Description
$this

setMaxDiskSizeValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

The maximum disk size of the instance in bytes.

Parameter
Name Description
var int|string|null
Returns
Type Description
$this

getCurrentDiskSize

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

Returns
Type Description
Google\Protobuf\Int64Value|null

hasCurrentDiskSize

clearCurrentDiskSize

getCurrentDiskSizeValue

Returns the unboxed value from getCurrentDiskSize()

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

Returns
Type Description
int|string|null

setCurrentDiskSize

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

Parameter
Name Description
var Google\Protobuf\Int64Value
Returns
Type Description
$this

setCurrentDiskSizeValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

Parameter
Name Description
var int|string|null
Returns
Type Description
$this

getIpAddresses

The assigned IP addresses for the instance.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIpAddresses

The assigned IP addresses for the instance.

Parameter
Name Description
var array<Google\Cloud\Sql\V1\IpMapping>
Returns
Type Description
$this

getServerCaCert

SSL configuration.

Returns
Type Description
Google\Cloud\Sql\V1\SslCert|null

hasServerCaCert

clearServerCaCert

setServerCaCert

SSL configuration.

Parameter
Name Description
var Google\Cloud\Sql\V1\SslCert
Returns
Type Description
$this

getInstanceType

The instance type.

Returns
Type Description
int

setInstanceType

The instance type.

Parameter
Name Description
var int
Returns
Type Description
$this

getProject

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

Returns
Type Description
string

setProject

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpv6Address

The IPv6 address assigned to the instance.

(Deprecated) This property was applicable only to First Generation instances.

Returns
Type Description
string

setIpv6Address

The IPv6 address assigned to the instance.

(Deprecated) This property was applicable only to First Generation instances.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccountEmailAddress

The service account email address assigned to the instance.\This property is read-only.

Returns
Type Description
string

setServiceAccountEmailAddress

The service account email address assigned to the instance.\This property is read-only.

Parameter
Name Description
var string
Returns
Type Description
$this

getOnPremisesConfiguration

Configuration specific to on-premises instances.

Returns
Type Description
Google\Cloud\Sql\V1\OnPremisesConfiguration|null

hasOnPremisesConfiguration

clearOnPremisesConfiguration

setOnPremisesConfiguration

Configuration specific to on-premises instances.

Parameter
Name Description
var Google\Cloud\Sql\V1\OnPremisesConfiguration
Returns
Type Description
$this

getReplicaConfiguration

Configuration specific to failover replicas and read replicas.

Returns
Type Description
Google\Cloud\Sql\V1\ReplicaConfiguration|null

hasReplicaConfiguration

clearReplicaConfiguration

setReplicaConfiguration

Configuration specific to failover replicas and read replicas.

Parameter
Name Description
var Google\Cloud\Sql\V1\ReplicaConfiguration
Returns
Type Description
$this

getBackendType

The backend type.

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

Returns
Type Description
int

setBackendType

The backend type.

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

Parameter
Name Description
var int
Returns
Type Description
$this

getSelfLink

The URI of this resource.

Returns
Type Description
string

setSelfLink

The URI of this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSuspensionReason

If the instance state is SUSPENDED, the reason for the suspension.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSuspensionReason

If the instance state is SUSPENDED, the reason for the suspension.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getConnectionName

Connection name of the Cloud SQL instance used in connection strings.

Returns
Type Description
string

setConnectionName

Connection name of the Cloud SQL instance used in connection strings.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the Cloud SQL instance. This does not include the project ID.

Returns
Type Description
string

setName

Name of the Cloud SQL instance. This does not include the project ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

The geographical region of the Cloud SQL instance.

It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

Returns
Type Description
string

setRegion

The geographical region of the Cloud SQL instance.

It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

Parameter
Name Description
var string
Returns
Type Description
$this

getGceZone

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

Returns
Type Description
string

setGceZone

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getSecondaryGceZone

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

Returns
Type Description
string

setSecondaryGceZone

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

Parameter
Name Description
var string
Returns
Type Description
$this

getDiskEncryptionConfiguration

Disk encryption configuration specific to an instance.

Returns
Type Description
Google\Cloud\Sql\V1\DiskEncryptionConfiguration|null

hasDiskEncryptionConfiguration

clearDiskEncryptionConfiguration

setDiskEncryptionConfiguration

Disk encryption configuration specific to an instance.

Parameter
Name Description
var Google\Cloud\Sql\V1\DiskEncryptionConfiguration
Returns
Type Description
$this

getDiskEncryptionStatus

Disk encryption status specific to an instance.

Returns
Type Description
Google\Cloud\Sql\V1\DiskEncryptionStatus|null

hasDiskEncryptionStatus

clearDiskEncryptionStatus

setDiskEncryptionStatus

Disk encryption status specific to an instance.

Parameter
Name Description
var Google\Cloud\Sql\V1\DiskEncryptionStatus
Returns
Type Description
$this

getRootPassword

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

Returns
Type Description
string

setRootPassword

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

Parameter
Name Description
var string
Returns
Type Description
$this

getScheduledMaintenance

The start time of any upcoming scheduled maintenance for this instance.

Returns
Type Description
Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance|null

hasScheduledMaintenance

clearScheduledMaintenance

setScheduledMaintenance

The start time of any upcoming scheduled maintenance for this instance.

Parameter
Name Description
var Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance
Returns
Type Description
$this

getSatisfiesPzs

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

Returns
Type Description
Google\Protobuf\BoolValue|null

hasSatisfiesPzs

clearSatisfiesPzs

getSatisfiesPzsValue

Returns the unboxed value from getSatisfiesPzs()

This status indicates whether the instance satisfies PZS. The status is reserved for future use.

Returns
Type Description
bool|null

setSatisfiesPzs

This status indicates whether the instance satisfies PZS.

The status is reserved for future use.

Parameter
Name Description
var Google\Protobuf\BoolValue
Returns
Type Description
$this

setSatisfiesPzsValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

This status indicates whether the instance satisfies PZS. The status is reserved for future use.

Parameter
Name Description
var bool|null
Returns
Type Description
$this

getDatabaseInstalledVersion

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

Returns
Type Description
string

setDatabaseInstalledVersion

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

Parameter
Name Description
var string
Returns
Type Description
$this

getOutOfDiskReport

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

  • Writers:
    • the proactive database wellness job for OOD.
  • Readers:
    • the proactive database wellness job
Returns
Type Description
Google\Cloud\Sql\V1\DatabaseInstance\SqlOutOfDiskReport|null

hasOutOfDiskReport

clearOutOfDiskReport

setOutOfDiskReport

This field represents the report generated by the proactive database wellness job for OutOfDisk issues.

  • Writers:
    • the proactive database wellness job for OOD.
  • Readers:
    • the proactive database wellness job
Parameter
Name Description
var Google\Cloud\Sql\V1\DatabaseInstance\SqlOutOfDiskReport
Returns
Type Description
$this

getCreateTime

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAvailableMaintenanceVersions

Output only. List all maintenance versions applicable on the instance

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAvailableMaintenanceVersions

Output only. List all maintenance versions applicable on the instance

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMaintenanceVersion

The current software version on the instance.

Returns
Type Description
string

setMaintenanceVersion

The current software version on the instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getSqlNetworkArchitecture

Generated from protobuf field optional .google.cloud.sql.v1.DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47;

Returns
Type Description
int

hasSqlNetworkArchitecture

clearSqlNetworkArchitecture

setSqlNetworkArchitecture

Generated from protobuf field optional .google.cloud.sql.v1.DatabaseInstance.SqlNetworkArchitecture sql_network_architecture = 47;

Parameter
Name Description
var int
Returns
Type Description
$this

getPscServiceAttachmentLink

Output only. The link to service attachment of PSC instance.

Returns
Type Description
string

hasPscServiceAttachmentLink

clearPscServiceAttachmentLink

setPscServiceAttachmentLink

Output only. The link to service attachment of PSC instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getDnsName

Output only. The dns name of the instance.

Returns
Type Description
string

hasDnsName

clearDnsName

setDnsName

Output only. The dns name of the instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrimaryDnsName

Output only. DEPRECATED: please use write_endpoint instead.

Returns
Type Description
string

hasPrimaryDnsName

clearPrimaryDnsName

setPrimaryDnsName

Output only. DEPRECATED: please use write_endpoint instead.

Parameter
Name Description
var string
Returns
Type Description
$this

getWriteEndpoint

Output only. The dns name of the primary instance in a replication group.

Returns
Type Description
string

hasWriteEndpoint

clearWriteEndpoint

setWriteEndpoint

Output only. The dns name of the primary instance in a replication group.

Parameter
Name Description
var string
Returns
Type Description
$this

getReplicationCluster

Optional. A primary instance and disaster recovery (DR) replica pair.

A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.

Returns
Type Description
Google\Cloud\Sql\V1\ReplicationCluster|null

hasReplicationCluster

clearReplicationCluster

setReplicationCluster

Optional. A primary instance and disaster recovery (DR) replica pair.

A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.

Parameter
Name Description
var Google\Cloud\Sql\V1\ReplicationCluster
Returns
Type Description
$this

getGeminiConfig

Gemini instance configuration.

Returns
Type Description
Google\Cloud\Sql\V1\GeminiInstanceConfig|null

hasGeminiConfig

clearGeminiConfig

setGeminiConfig

Gemini instance configuration.

Parameter
Name Description
var Google\Cloud\Sql\V1\GeminiInstanceConfig
Returns
Type Description
$this