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

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
NameDescription
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. This can be one of the following: * SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown. * RUNNABLE: The instance is running, or has been stopped by owner. * SUSPENDED: The instance is not available, for example due to problems with billing. * PENDING_DELETE: The instance is being deleted. * PENDING_CREATE: The instance is being created. * MAINTENANCE: The instance is down for maintenance. * FAILED: The instance creation failed.

↳ database_version int

The database engine type and version. The databaseVersion field cannot be changed after instance creation. * MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6. * PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default). * SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.

↳ 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. This can be one of the following: * CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance. * ON_PREMISES_INSTANCE: An instance running on the customer's premises. * READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.

↳ 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. Can be: * us-central (FIRST_GEN instances only) * us-central1 (SECOND_GEN instances only) * asia-east1 or europe-west1. Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.

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

↳ 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. Reserved for future use.

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

↳ scheduled_maintenance Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance

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

↳ satisfies_pzs Google\Protobuf\BoolValue

The status indicating if instance satisfiesPzs. Reserved for future use.

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

getKind

This is always sql#instance.

Returns
TypeDescription
string

setKind

This is always sql#instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

The current serving state of the Cloud SQL instance. This can be one of the following:

  • SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown.

  • RUNNABLE: The instance is running, or has been stopped by owner.

  • SUSPENDED: The instance is not available, for example due to problems with billing.
  • PENDING_DELETE: The instance is being deleted.
  • PENDING_CREATE: The instance is being created.
  • MAINTENANCE: The instance is down for maintenance.
  • FAILED: The instance creation failed.
Returns
TypeDescription
int

setState

The current serving state of the Cloud SQL instance. This can be one of the following:

  • SQL_INSTANCE_STATE_UNSPECIFIED: The state of the instance is unknown.

  • RUNNABLE: The instance is running, or has been stopped by owner.

  • SUSPENDED: The instance is not available, for example due to problems with billing.
  • PENDING_DELETE: The instance is being deleted.
  • PENDING_CREATE: The instance is being created.
  • MAINTENANCE: The instance is down for maintenance.
  • FAILED: The instance creation failed.
Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDatabaseVersion

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

  • MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6.
  • PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default).
  • SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.
Returns
TypeDescription
int

setDatabaseVersion

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

  • MySQL instances: MYSQL_8_0, MYSQL_5_7 (default), or MYSQL_5_6.
  • PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13 (default).
  • SQL Server instances: SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB, SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or SQLSERVER_2017_WEB.
Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSettings

The user settings.

Returns
TypeDescription
Google\Cloud\Sql\V1\Settings|null

hasSettings

clearSettings

setSettings

The user settings.

Parameter
NameDescription
var Google\Cloud\Sql\V1\Settings
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFailoverReplica

The name and status of the failover replica.

Returns
TypeDescription
Google\Cloud\Sql\V1\DatabaseInstance\SqlFailoverReplica|null

hasFailoverReplica

clearFailoverReplica

setFailoverReplica

The name and status of the failover replica.

Parameter
NameDescription
var Google\Cloud\Sql\V1\DatabaseInstance\SqlFailoverReplica
Returns
TypeDescription
$this

getMasterInstanceName

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

Returns
TypeDescription
string

setMasterInstanceName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReplicaNames

The replicas of the instance.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setReplicaNames

The replicas of the instance.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMaxDiskSize

The maximum disk size of the instance in bytes.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasMaxDiskSize

clearMaxDiskSize

getMaxDiskSizeValue

Returns the unboxed value from getMaxDiskSize()

The maximum disk size of the instance in bytes.

Returns
TypeDescription
int|string|null

setMaxDiskSize

The maximum disk size of the instance in bytes.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$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
NameDescription
var int|string|null
Returns
TypeDescription
$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
TypeDescription
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
TypeDescription
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
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$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
NameDescription
var int|string|null
Returns
TypeDescription
$this

getIpAddresses

The assigned IP addresses for the instance.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIpAddresses

The assigned IP addresses for the instance.

Parameter
NameDescription
var array<Google\Cloud\Sql\V1\IpMapping>
Returns
TypeDescription
$this

getServerCaCert

SSL configuration.

Returns
TypeDescription
Google\Cloud\Sql\V1\SslCert|null

hasServerCaCert

clearServerCaCert

setServerCaCert

SSL configuration.

Parameter
NameDescription
var Google\Cloud\Sql\V1\SslCert
Returns
TypeDescription
$this

getInstanceType

The instance type. This can be one of the following:

  • CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance.

  • ON_PREMISES_INSTANCE: An instance running on the customer's premises.

  • READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
Returns
TypeDescription
int

setInstanceType

The instance type. This can be one of the following:

  • CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a primary instance.

  • ON_PREMISES_INSTANCE: An instance running on the customer's premises.

  • READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.
Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProject

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

Returns
TypeDescription
string

setProject

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIpv6Address

The IPv6 address assigned to the instance.

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

Returns
TypeDescription
string

setIpv6Address

The IPv6 address assigned to the instance.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceAccountEmailAddress

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

Returns
TypeDescription
string

setServiceAccountEmailAddress

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOnPremisesConfiguration

Configuration specific to on-premises instances.

Returns
TypeDescription
Google\Cloud\Sql\V1\OnPremisesConfiguration|null

hasOnPremisesConfiguration

clearOnPremisesConfiguration

setOnPremisesConfiguration

Configuration specific to on-premises instances.

Parameter
NameDescription
var Google\Cloud\Sql\V1\OnPremisesConfiguration
Returns
TypeDescription
$this

getReplicaConfiguration

Configuration specific to failover replicas and read replicas.

Returns
TypeDescription
Google\Cloud\Sql\V1\ReplicaConfiguration|null

hasReplicaConfiguration

clearReplicaConfiguration

setReplicaConfiguration

Configuration specific to failover replicas and read replicas.

Parameter
NameDescription
var Google\Cloud\Sql\V1\ReplicaConfiguration
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

The URI of this resource.

Returns
TypeDescription
string

The URI of this resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSuspensionReason

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSuspensionReason

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

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getConnectionName

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

Returns
TypeDescription
string

setConnectionName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

The geographical region. Can be:

  • us-central (FIRST_GEN instances only)
  • us-central1 (SECOND_GEN instances only)
  • asia-east1 or europe-west1.

Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.

Returns
TypeDescription
string

setRegion

The geographical region. Can be:

  • us-central (FIRST_GEN instances only)
  • us-central1 (SECOND_GEN instances only)
  • asia-east1 or europe-west1.

Defaults to us-central or us-central1 depending on the instance type. The region cannot be changed after instance creation.

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Reserved for future use.

Returns
TypeDescription
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.

Reserved for future use.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDiskEncryptionConfiguration

Disk encryption configuration specific to an instance.

Returns
TypeDescription
Google\Cloud\Sql\V1\DiskEncryptionConfiguration|null

hasDiskEncryptionConfiguration

clearDiskEncryptionConfiguration

setDiskEncryptionConfiguration

Disk encryption configuration specific to an instance.

Parameter
NameDescription
var Google\Cloud\Sql\V1\DiskEncryptionConfiguration
Returns
TypeDescription
$this

getDiskEncryptionStatus

Disk encryption status specific to an instance.

Returns
TypeDescription
Google\Cloud\Sql\V1\DiskEncryptionStatus|null

hasDiskEncryptionStatus

clearDiskEncryptionStatus

setDiskEncryptionStatus

Disk encryption status specific to an instance.

Parameter
NameDescription
var Google\Cloud\Sql\V1\DiskEncryptionStatus
Returns
TypeDescription
$this

getRootPassword

Initial root password. Use only on creation.

Returns
TypeDescription
string

setRootPassword

Initial root password. Use only on creation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScheduledMaintenance

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

Returns
TypeDescription
Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance|null

hasScheduledMaintenance

clearScheduledMaintenance

setScheduledMaintenance

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

Parameter
NameDescription
var Google\Cloud\Sql\V1\DatabaseInstance\SqlScheduledMaintenance
Returns
TypeDescription
$this

getSatisfiesPzs

The status indicating if instance satisfiesPzs.

Reserved for future use.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasSatisfiesPzs

clearSatisfiesPzs

getSatisfiesPzsValue

Returns the unboxed value from getSatisfiesPzs()

The status indicating if instance satisfiesPzs. Reserved for future use.

Returns
TypeDescription
bool|null

setSatisfiesPzs

The status indicating if instance satisfiesPzs.

Reserved for future use.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setSatisfiesPzsValue

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

The status indicating if instance satisfiesPzs. Reserved for future use.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Sql\V1\DatabaseInstance\SqlOutOfDiskReport
Returns
TypeDescription
$this

getCreateTime

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

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this