DatabaseInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Cloud SQL instance resource.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
kind |
str
This is always sql#instance.
|
state |
google.cloud.sqladmin_v1beta4.types.DatabaseInstance.SqlInstanceState
The current serving state of the Cloud SQL instance. |
database_version |
google.cloud.sqladmin_v1beta4.types.SqlDatabaseVersion
The database engine type and version. The databaseVersion field cannot be changed after instance
creation.
|
settings |
google.cloud.sqladmin_v1beta4.types.Settings
The user settings. |
etag |
str
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.sqladmin_v1beta4.types.DatabaseInstance.SqlFailoverReplica
The name and status of the failover replica. |
master_instance_name |
str
The name of the instance which will act as primary in the replication setup. |
replica_names |
MutableSequence[str]
The replicas of the instance. |
max_disk_size |
google.protobuf.wrappers_pb2.Int64Value
The maximum disk size of the instance in bytes. |
current_disk_size |
google.protobuf.wrappers_pb2.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 |
ip_addresses |
MutableSequence[google.cloud.sqladmin_v1beta4.types.IpMapping]
The assigned IP addresses for the instance. |
server_ca_cert |
google.cloud.sqladmin_v1beta4.types.SslCert
SSL configuration. |
instance_type |
google.cloud.sqladmin_v1beta4.types.SqlInstanceType
The instance type. |
project |
str
The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. |
ipv6_address |
str
The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. |
service_account_email_address |
str
The service account email address assigned to the instance. \This property is read-only. |
on_premises_configuration |
google.cloud.sqladmin_v1beta4.types.OnPremisesConfiguration
Configuration specific to on-premises instances. |
replica_configuration |
google.cloud.sqladmin_v1beta4.types.ReplicaConfiguration
Configuration specific to failover replicas and read replicas. |
backend_type |
google.cloud.sqladmin_v1beta4.types.SqlBackendType
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 |
str
The URI of this resource. |
suspension_reason |
MutableSequence[google.cloud.sqladmin_v1beta4.types.SqlSuspensionReason]
If the instance state is SUSPENDED, the reason for the suspension. |
connection_name |
str
Connection name of the Cloud SQL instance used in connection strings. |
name |
str
Name of the Cloud SQL instance. This does not include the project ID. |
region |
str
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 |
str
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 |
str
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.sqladmin_v1beta4.types.DiskEncryptionConfiguration
Disk encryption configuration specific to an instance. |
disk_encryption_status |
google.cloud.sqladmin_v1beta4.types.DiskEncryptionStatus
Disk encryption status specific to an instance. |
root_password |
str
Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. |
scheduled_maintenance |
google.cloud.sqladmin_v1beta4.types.DatabaseInstance.SqlScheduledMaintenance
The start time of any upcoming scheduled maintenance for this instance. |
satisfies_pzs |
google.protobuf.wrappers_pb2.BoolValue
This status indicates whether the instance satisfies PZS. The status is reserved for future use. |
database_installed_version |
str
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.sqladmin_v1beta4.types.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 This field is a member of oneof_ _out_of_disk_report.
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the instance was created in `RFC 3339 |
available_maintenance_versions |
MutableSequence[str]
Output only. List all maintenance versions applicable on the instance |
maintenance_version |
str
The current software version on the instance. |
upgradable_database_versions |
MutableSequence[google.cloud.sqladmin_v1beta4.types.AvailableDatabaseVersion]
Output only. All database versions that are available for upgrade. |
sql_network_architecture |
google.cloud.sqladmin_v1beta4.types.DatabaseInstance.SqlNetworkArchitecture
The SQL network architecture for the instance. This field is a member of oneof_ _sql_network_architecture.
|
psc_service_attachment_link |
str
Output only. The link to service attachment of PSC instance. This field is a member of oneof_ _psc_service_attachment_link.
|
dns_name |
str
Output only. The dns name of the instance. This field is a member of oneof_ _dns_name.
|
primary_dns_name |
str
Output only. DEPRECATED: please use write_endpoint instead. This field is a member of oneof_ _primary_dns_name.
|
write_endpoint |
str
Output only. The dns name of the primary instance in a replication group. This field is a member of oneof_ _write_endpoint.
|
replication_cluster |
google.cloud.sqladmin_v1beta4.types.ReplicationCluster
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. Applicable to MySQL and PostgreSQL. This field is a member of oneof_ _replication_cluster.
|
gemini_config |
google.cloud.sqladmin_v1beta4.types.GeminiInstanceConfig
Gemini instance configuration. This field is a member of oneof_ _gemini_config.
|
satisfies_pzi |
google.protobuf.wrappers_pb2.BoolValue
Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. |
switch_transaction_logs_to_cloud_storage_enabled |
google.protobuf.wrappers_pb2.BoolValue
Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. This field is a member of oneof_ _switch_transaction_logs_to_cloud_storage_enabled.
|
include_replicas_for_major_version_upgrade |
google.protobuf.wrappers_pb2.BoolValue
Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. This field is a member of oneof_ _include_replicas_for_major_version_upgrade.
|
tags |
MutableMapping[str, str]
Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: ".
For example, a single resource can have the following tags:
::
"123/environment": "production",
"123/costCenter": "marketing",
For more information on tag creation and management, see
https://cloud.google.com/resource-manager/docs/tags/tags-overview.
|
node_count |
int
The number of read pool nodes in a read pool. This field is a member of oneof_ _node_count.
|
nodes |
MutableSequence[google.cloud.sqladmin_v1beta4.types.DatabaseInstance.PoolNodeConfig]
Output only. Entries containing information about each read pool node of the read pool. |
dns_names |
MutableSequence[google.cloud.sqladmin_v1beta4.types.DnsNameMapping]
Output only. The list of DNS names used by this instance. |
database_center_integration_enabled |
google.protobuf.wrappers_pb2.BoolValue
Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. |
Classes
PoolNodeConfig
PoolNodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Details of a single read pool node of a read pool.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SqlFailoverReplica
SqlFailoverReplica(mapping=None, *, ignore_unknown_fields=False, **kwargs)SqlInstanceState
SqlInstanceState(value)The current serving state of the database instance.
SqlNetworkArchitecture
SqlNetworkArchitecture(value)The SQL network architecture for the instance.
SqlOutOfDiskReport
SqlOutOfDiskReport(mapping=None, *, ignore_unknown_fields=False, **kwargs)This message wraps up the information written by out-of-disk detection job.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SqlScheduledMaintenance
SqlScheduledMaintenance(mapping=None, *, ignore_unknown_fields=False, **kwargs)Any scheduled maintenance for this instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TagsEntry
TagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |