Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
failover(project, instance, body=None, x__xgafv=None)
Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
+Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
get(project, instance, x__xgafv=None)
Retrieves a resource containing information about a Cloud SQL instance.
@@ -253,10 +253,10 @@failover(project, instance, body=None, x__xgafv=None)
- Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance. +Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance. Args: project: string, ID of the project that contains the read replica. (required) @@ -702,7 +702,7 @@Method Details
{ # Instance failover request. "failoverContext": { # Database instance failover context. # Failover Context. - "kind": "A String", # This is always *sql#failoverContext*. + "kind": "A String", # This is always **sql#failoverContext**. "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. }, } @@ -810,11 +810,11 @@Method Details
An object of the form: { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -823,13 +823,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -838,7 +838,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -848,7 +848,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -862,10 +862,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -995,7 +995,7 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], @@ -1136,11 +1136,11 @@Method Details
The object takes the form of: { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -1149,13 +1149,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -1164,7 +1164,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -1174,7 +1174,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -1188,10 +1188,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -1321,7 +1321,7 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], @@ -1434,11 +1434,11 @@Method Details
{ # Database instances list response. "items": [ # List of database instance resources. { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -1447,13 +1447,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -1462,7 +1462,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -1472,7 +1472,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -1486,10 +1486,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -1619,13 +1619,13 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], }, ], - "kind": "A String", # This is always *sql#instancesList*. + "kind": "A String", # This is always **sql#instancesList**. "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. "warnings": [ # List of warnings that occurred while handling the request. { # An Admin API warning message. @@ -1667,7 +1667,7 @@Method Details
"sha1Fingerprint": "A String", # Sha1 Fingerprint. }, ], - "kind": "A String", # This is always *sql#instancesListServerCas*. + "kind": "A String", # This is always **sql#instancesListServerCas**. }
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
failover(project, instance, body=None, x__xgafv=None)
Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
+Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
get(project, instance, x__xgafv=None)
Retrieves a resource containing information about a Cloud SQL instance.
@@ -187,7 +187,7 @@failover(project, instance, body=None, x__xgafv=None)
- Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance. +Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance. Args: project: string, ID of the project that contains the read replica. (required) @@ -702,7 +702,7 @@Method Details
{ # Instance failover request. "failoverContext": { # Database instance failover context. # Failover Context. - "kind": "A String", # This is always *sql#failoverContext*. + "kind": "A String", # This is always **sql#failoverContext**. "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. }, } @@ -743,7 +743,7 @@Method Details
"A String", ], "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. - "kind": "A String", # This is always *sql#exportContext*. + "kind": "A String", # This is always **sql#exportContext**. "offload": True or False, # Option for export offload. "sqlExportOptions": { # Options for exporting data as SQL statements. "mysqlExportOptions": { # Options for exporting from MySQL. @@ -761,7 +761,7 @@Method Details
"encryptionOptions": { "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. "pvkPassword": "A String", # Password that encrypts the private key - "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file. + "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. }, }, "csvImportOptions": { # Options for importing data as CSV. @@ -810,11 +810,11 @@Method Details
An object of the form: { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -823,13 +823,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -838,7 +838,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -848,7 +848,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -862,10 +862,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -926,7 +926,7 @@Method Details
"location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. - "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. + "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. }, "collation": "A String", # The name of server Instance collation. @@ -935,7 +935,7 @@Method Details
"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. "databaseFlags": [ # The database flags passed to the instance at startup. { # Database flags for Cloud SQL instances. - "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation. + "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. "value": "A String", # 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. }, ], @@ -995,7 +995,7 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], @@ -1018,7 +1018,7 @@Method Details
"encryptionOptions": { "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. "pvkPassword": "A String", # Password that encrypts the private key - "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file. + "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. }, }, "csvImportOptions": { # Options for importing data as CSV. @@ -1075,7 +1075,7 @@Method Details
"A String", ], "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. - "kind": "A String", # This is always *sql#exportContext*. + "kind": "A String", # This is always **sql#exportContext**. "offload": True or False, # Option for export offload. "sqlExportOptions": { # Options for exporting data as SQL statements. "mysqlExportOptions": { # Options for exporting from MySQL. @@ -1093,7 +1093,7 @@Method Details
"encryptionOptions": { "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. "pvkPassword": "A String", # Password that encrypts the private key - "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file. + "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. }, }, "csvImportOptions": { # Options for importing data as CSV. @@ -1136,11 +1136,11 @@Method Details
The object takes the form of: { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -1149,13 +1149,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -1164,7 +1164,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -1174,7 +1174,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -1188,10 +1188,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -1252,7 +1252,7 @@Method Details
"location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. - "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. + "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. }, "collation": "A String", # The name of server Instance collation. @@ -1261,7 +1261,7 @@Method Details
"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. "databaseFlags": [ # The database flags passed to the instance at startup. { # Database flags for Cloud SQL instances. - "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation. + "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. "value": "A String", # 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. }, ], @@ -1321,7 +1321,7 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], @@ -1363,7 +1363,7 @@Method Details
"A String", ], "fileType": "A String", # The file type for the specified uri. * **SQL**: The file contains SQL statements. * **CSV**: The file contains CSV data. * **BAK**: The file contains backup data for a SQL Server instance. - "kind": "A String", # This is always *sql#exportContext*. + "kind": "A String", # This is always **sql#exportContext**. "offload": True or False, # Option for export offload. "sqlExportOptions": { # Options for exporting data as SQL statements. "mysqlExportOptions": { # Options for exporting from MySQL. @@ -1381,7 +1381,7 @@Method Details
"encryptionOptions": { "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. "pvkPassword": "A String", # Password that encrypts the private key - "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs://bucketName/fileName*. The instance must have write permissions to the bucket and read access to the file. + "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. }, }, "csvImportOptions": { # Options for importing data as CSV. @@ -1434,11 +1434,11 @@Method Details
{ # Database instances list response. "items": [ # List of database instance resources. { # A Cloud SQL instance resource. - "backendType": "A String", # *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. + "backendType": "A String", # 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. "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. - "currentDiskSize": "A String", # 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. - "databaseVersion": "A String", # 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*. + "currentDiskSize": "A String", # 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](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseVersion": "A String", # 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. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. "kind": "A String", # This is always **sql#diskEncryptionConfiguration**. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption @@ -1447,13 +1447,13 @@Method Details
"kind": "A String", # This is always **sql#diskEncryptionStatus**. "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource }, - "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead. + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the **settings.settingsVersion** field instead. "failoverReplica": { # The name and status of the failover replica. "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. }, "gceZone": "A 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. - "instanceType": "A String", # 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. + "instanceType": "A String", # 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. "ipAddresses": [ # The assigned IP addresses for the instance. { # Database instance IP Mapping. "ipAddress": "A String", # The IP address assigned. @@ -1462,7 +1462,7 @@Method Details
}, ], "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. - "kind": "A String", # This is always *sql#instance*. + "kind": "A String", # This is always **sql#instance**. "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. @@ -1472,7 +1472,7 @@Method Details
"clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. "hostPort": "A String", # The host and port of the on-premises instance in host:port format - "kind": "A String", # This is always *sql#onPremisesConfiguration*. + "kind": "A String", # This is always **sql#onPremisesConfiguration**. "password": "A String", # The password for connecting to on-premises instance. "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. @@ -1486,10 +1486,10 @@Method Details
"sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job }, "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. - "region": "A 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. + "region": "A 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. "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. - "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to *true* the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. - "kind": "A String", # This is always *sql#replicaConfiguration*. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to **true** the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always **sql#replicaConfiguration**. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named **master.info** in the data directory. "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. @@ -1550,7 +1550,7 @@Method Details
"location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. - "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. + "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. }, "collation": "A String", # The name of server Instance collation. @@ -1559,7 +1559,7 @@Method Details
"dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**. Not used for First Generation instances. "databaseFlags": [ # The database flags passed to the instance at startup. { # Database flags for Cloud SQL instances. - "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud SQL documentation. + "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. "value": "A String", # 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. }, ], @@ -1619,13 +1619,13 @@Method Details
"a_key": "A String", }, }, - "state": "A String", # 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. + "state": "A String", # 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. "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], }, ], - "kind": "A String", # This is always *sql#instancesList*. + "kind": "A String", # This is always **sql#instancesList**. "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. "warnings": [ # List of warnings that occurred while handling the request. { # An Admin API warning message. @@ -1667,7 +1667,7 @@Method Details
"sha1Fingerprint": "A String", # Sha1 Fingerprint. }, ], - "kind": "A String", # This is always *sql#instancesListServerCas*. + "kind": "A String", # This is always **sql#instancesListServerCas**. }