Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class DatabaseInstance.
A Cloud SQL instance resource.
Generated from protobuf message google.cloud.sql.v1beta4.DatabaseInstance
Methods
__construct
Constructor.
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
↳ 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\V1beta4\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
↳ 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
↳ server_ca_cert
↳ 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
↳ replica_configuration
Google\Cloud\Sql\V1beta4\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. 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\V1beta4\DiskEncryptionConfiguration
Disk encryption configuration specific to an instance.
↳ disk_encryption_status
↳ root_password
string
Initial root password. Use only on creation.
↳ scheduled_maintenance
Google\Cloud\Sql\V1beta4\DatabaseInstance\SqlScheduledMaintenance
The start time of any upcoming scheduled maintenance for this instance.
↳ satisfies_pzs
↳ 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\V1beta4\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
List all maintenance versions applicable on the instance
↳ maintenance_version
string
The current software version on the instance.
getKind
This is always sql#instance
.
string
setKind
This is always sql#instance
.
var
string
$this
getState
The current serving state of the Cloud SQL instance.
int
setState
The current serving state of the Cloud SQL instance.
var
int
$this
getDatabaseVersion
The database engine type and version. The databaseVersion
field cannot
be changed after instance creation.
int
setDatabaseVersion
The database engine type and version. The databaseVersion
field cannot
be changed after instance creation.
var
int
$this
getSettings
The user settings.
hasSettings
clearSettings
setSettings
The user settings.
$this
getEtag
This field is deprecated and will be removed from a future version of the
API. Use the settings.settingsVersion
field instead.
string
setEtag
This field is deprecated and will be removed from a future version of the
API. Use the settings.settingsVersion
field instead.
var
string
$this
getFailoverReplica
The name and status of the failover replica.
hasFailoverReplica
clearFailoverReplica
setFailoverReplica
The name and status of the failover replica.
$this
getMasterInstanceName
The name of the instance which will act as primary in the replication setup.
string
setMasterInstanceName
The name of the instance which will act as primary in the replication setup.
var
string
$this
getReplicaNames
The replicas of the instance.
setReplicaNames
The replicas of the instance.
var
string[]
$this
getMaxDiskSize
The maximum disk size of the instance in bytes.
hasMaxDiskSize
clearMaxDiskSize
getMaxDiskSizeValue
Returns the unboxed value from getMaxDiskSize()
The maximum disk size of the instance in bytes.
int|string|null
setMaxDiskSize
The maximum disk size of the instance in bytes.
$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.
var
int|string|null
$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.
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.
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.
$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.
var
int|string|null
$this
getIpAddresses
The assigned IP addresses for the instance.
setIpAddresses
The assigned IP addresses for the instance.
$this
getServerCaCert
SSL configuration.
hasServerCaCert
clearServerCaCert
setServerCaCert
SSL configuration.
$this
getInstanceType
The instance type.
int
setInstanceType
The instance type.
var
int
$this
getProject
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
string
setProject
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
var
string
$this
getIpv6Address
The IPv6 address assigned to the instance.
(Deprecated) This property was applicable only to First Generation instances.
string
setIpv6Address
The IPv6 address assigned to the instance.
(Deprecated) This property was applicable only to First Generation instances.
var
string
$this
getServiceAccountEmailAddress
The service account email address assigned to the instance. \This property is read-only.
string
setServiceAccountEmailAddress
The service account email address assigned to the instance. \This property is read-only.
var
string
$this
getOnPremisesConfiguration
Configuration specific to on-premises instances.
hasOnPremisesConfiguration
clearOnPremisesConfiguration
setOnPremisesConfiguration
Configuration specific to on-premises instances.
$this
getReplicaConfiguration
Configuration specific to failover replicas and read replicas.
hasReplicaConfiguration
clearReplicaConfiguration
setReplicaConfiguration
Configuration specific to failover replicas and read replicas.
$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.
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.
var
int
$this
getSelfLink
The URI of this resource.
string
setSelfLink
The URI of this resource.
var
string
$this
getSuspensionReason
If the instance state is SUSPENDED, the reason for the suspension.
setSuspensionReason
If the instance state is SUSPENDED, the reason for the suspension.
var
int[]
$this
getConnectionName
Connection name of the Cloud SQL instance used in connection strings.
string
setConnectionName
Connection name of the Cloud SQL instance used in connection strings.
var
string
$this
getName
Name of the Cloud SQL instance. This does not include the project ID.
string
setName
Name of the Cloud SQL instance. This does not include the project ID.
var
string
$this
getRegion
The geographical region. Can be:
-
us-central(FIRST_GENinstances only) -
us-central1(SECOND_GENinstances only) -
asia-east1oreurope-west1.
Defaults to us-central
or us-central1
depending on the instance
type. The region cannot be changed after instance creation.
string
setRegion
The geographical region. Can be:
-
us-central(FIRST_GENinstances only) -
us-central1(SECOND_GENinstances only) -
asia-east1oreurope-west1.
Defaults to us-central
or us-central1
depending on the instance
type. The region cannot be changed after instance creation.
var
string
$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.
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.
var
string
$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.
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.
var
string
$this
getDiskEncryptionConfiguration
Disk encryption configuration specific to an instance.
hasDiskEncryptionConfiguration
clearDiskEncryptionConfiguration
setDiskEncryptionConfiguration
Disk encryption configuration specific to an instance.
$this
getDiskEncryptionStatus
Disk encryption status specific to an instance.
hasDiskEncryptionStatus
clearDiskEncryptionStatus
setDiskEncryptionStatus
Disk encryption status specific to an instance.
$this
getRootPassword
Initial root password. Use only on creation.
string
setRootPassword
Initial root password. Use only on creation.
var
string
$this
getScheduledMaintenance
The start time of any upcoming scheduled maintenance for this instance.
hasScheduledMaintenance
clearScheduledMaintenance
setScheduledMaintenance
The start time of any upcoming scheduled maintenance for this instance.
$this
getSatisfiesPzs
The status indicating if instance satisfiesPzs.
Reserved for future use.
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsValue
Returns the unboxed value from getSatisfiesPzs()
The status indicating if instance satisfiesPzs. Reserved for future use.
bool|null
setSatisfiesPzs
The status indicating if instance satisfiesPzs.
Reserved for future use.
$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.
var
bool|null
$this
getDatabaseInstalledVersion
Output only. Stores the current database version running on the instance including
minor version such as MYSQL_8_0_18
.
string
setDatabaseInstalledVersion
Output only. Stores the current database version running on the instance including
minor version such as MYSQL_8_0_18
.
var
string
$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
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
$this
getCreateTime
Output only. The time when the instance was created in RFC 3339
format, for example 2012-11-15T16:19:00.094Z
.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created in RFC 3339
format, for example 2012-11-15T16:19:00.094Z
.
$this
getAvailableMaintenanceVersions
List all maintenance versions applicable on the instance
setAvailableMaintenanceVersions
List all maintenance versions applicable on the instance
var
string[]
$this
getMaintenanceVersion
The current software version on the instance.
string
setMaintenanceVersion
The current software version on the instance.
var
string
$this
