Package Classes (0.1.1)

Service that exposes Cloud SQL database versions information. This service is only used internally.

Service that exposes Cloud SQL database versions information. This service is only used internally.

Service for managing database backups.

Service for managing database backups.

A pager for iterating through list requests.

This class thinly wraps an initial BackupRunsListResponse object, and provides an __aiter__ method to iterate through its items field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual BackupRunsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial BackupRunsListResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual BackupRunsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Cloud SQL connect service.

Cloud SQL connect service.

Service to manage databases.

Service to manage databases.

Service that exposes Cloud SQL event information. This service is only used internally.

Service that exposes Cloud SQL event information. This service is only used internally.

Service to verify the eligibility of an instance for a given operation.

Service to verify the eligibility of an instance for a given operation.

Service to manage database flags for Cloud SQL instances.

Service to manage database flags for Cloud SQL instances.

Service for providing IAM Meta APIs for Cloud SQL.

Service for providing IAM Meta APIs for Cloud SQL.

Cloud SQL instance names service.

Cloud SQL instance names service.

A pager for iterating through list requests.

This class thinly wraps an initial InstancesListResponse object, and provides an __aiter__ method to iterate through its warnings field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the warnings field on the corresponding responses.

All the usual InstancesListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial InstancesListResponse object, and provides an __iter__ method to iterate through its warnings field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the warnings field on the corresponding responses.

All the usual InstancesListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service to fetch operations for database instances.

Service to fetch operations for database instances.

A pager for iterating through list requests.

This class thinly wraps an initial OperationsListResponse object, and provides an __aiter__ method to iterate through its items field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual OperationsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial OperationsListResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual OperationsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service that exposes Cloud SQL region information. This service is only used internally and does not follow the same patterns as the other v1 RPCs.

Service that exposes Cloud SQL region information. This service is only used internally and does not follow the same patterns as the other v1 RPCs.

Service to manage SSL certs for Cloud SQL instances.

Service to manage SSL certs for Cloud SQL instances.

Service for providing machine types (tiers) for Cloud SQL instances.

Service for providing machine types (tiers) for Cloud SQL instances.

Cloud SQL users service.

Cloud SQL users service.

An entry for an Access Control list.

Acquire SSRS lease context.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies options for controlling advanced machine features.

An Admin API warning message.

The status of automated DNS provisioning.

An available database version. It can be a major or a minor version.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A backup resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The backup's state

The backup type.

Database instance backup configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup tier that manages the backups for the instance.

This value contains the storage location of the transactional logs used to perform point-in-time recovery (PITR) for the database.

Backup context.

Backup Reencryption Config

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup type for re-encryption

We currently only support backup retention by specifying the number of backups we will retain.

The units that retained_backups specifies, we only support COUNT.

A BackupRun resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup run list results.

Binary log coordinates.

Database instance clone context.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contains the name and datatype of a column.

Connect settings retrieval response.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Various Certificate Authority (CA) modes for certificate signing.

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

MdxProtocolSupport describes parts of the MDX protocol supported by this instance.

The managed connection pooling configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Connection pool flags for Cloud SQL instances managed connection pool configuration.

The request payload to create the backup

Data cache configurations.

Represents a SQL database on the Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Database flags for Cloud SQL instances.

A Cloud SQL instance resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

The current serving state of the database instance.

The SQL network architecture for the instance.

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

This enum lists all possible states regarding out-of-disk issues.

Any scheduled maintenance for this instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Database list response.

The request payload to delete the backup.

This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

Read-replica configuration for connecting to the on-premises primary instance.

Database instance demote primary instance context.

Read-replica configuration specific to MySQL databases.

Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

Disk encryption configuration for an instance.

Disk encryption status for an instance.

DNS metadata.

The connection type of the DNS name. This enum is not frozen, and new values may be added in the future.

The scope that the DNS name applies to.

The system responsible for managing the DNS record.

The request payload used to execute SQL statements.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Controls how the API should respond when the SQL execution result exceeds 10 MB.

Database instance export context.

Options for exporting BAK files (SQL Server-only)

Options for exporting from MySQL.

Options for exporting from a Cloud SQL for PostgreSQL instance.

External Sync parallel level.

The selected object that Cloud SQL migrates.

Database instance failover context.

Config used to determine the final backup settings for the instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A flag resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Flags list response.

Gemini instance configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Ephemeral certificate creation request.

Ephemeral certificate creation request.

The request payload to get the backup.

Connect settings retrieval request.

Database instance import context.

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.

Reference to another Cloud SQL instance.

Request to acquire a lease for SSRS.

Database instance clone request.

Database demote primary instance request.

This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

Database instance export request.

Instance failover request.

Database instance import request.

Instances ListEntraIdCertificates response.

Database instances list response.

Instances ListServerCas response.

Instances ListServerCertificates response.

Request for Pre-checks for MVU

Database Instance reencrypt request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Database instance restore backup request.

Rotate Entra ID certificate request.

Rotate server CA request.

Rotate server certificate request.

Instance truncate log request.

IP Management configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Various Certificate Authority (CA) modes for certificate signing.

Settings for automatic server certificate rotation.

The SSL options for database connections.

    When this value is used, the legacy `require_ssl` flag
    must be false or cleared to avoid a conflict between the
    values of the two flags.
ENCRYPTED_ONLY (2):
    Only allow connections encrypted with SSL/TLS. For SSL
    connections to MySQL and PostgreSQL, the client certificate
    isn't verified.

    When this value is used, the legacy `require_ssl` flag
    must be false or cleared to avoid a conflict between the
    values of the two flags.
TRUSTED_CLIENT_CERTIFICATE_REQUIRED (3):
    Only allow connections encrypted with SSL/TLS and with valid
    client certificates.

    When this value is used, the legacy `require_ssl` flag
    must be true or cleared to avoid the conflict between values
    of two flags. PostgreSQL clients or users that connect using
    IAM database authentication must use either the `Cloud SQL
    Auth
    Proxy <https://cloud.google.com/sql/docs/postgres/connect-auth-proxy>`__
    or `Cloud SQL
    Connectors <https://cloud.google.com/sql/docs/postgres/connect-connectors>`__
    to enforce client identity verification.

    Only applicable to MySQL and PostgreSQL. Not applicable to
    SQL Server.

Database instance IP mapping

The request payload to list the backups.

The response payload containing a list of the backups.

Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.

The additional metadata information regarding the execution of the SQL statements.

Read-replica configuration specific to MySQL databases.

MySQL-specific external server sync settings.

On-premises instance configuration.

SslOption defines the SSL mode to be used for replica connection to the on-premises source.

An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

The status of an operation.

The type of Cloud SQL operation.

Database instance operation error.

Database instance operation errors list wrapper.

Operations list response.

Read-only password status.

Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access.

The complexity choices of the password.

Perform disk shrink context.

Performance capture configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines the categories of long-running transactions eligible for automatic termination by the Performance Capture.

The context to perform a point-in-time recovery of an instance managed by Backup and Disaster Recovery (DR) Service.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Pre-check major version upgrade context.

Structured PreCheckResponse containing message, type, and required actions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of message which can be an info, a warning, or an error that requires user intervention.

Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PSC settings for a Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

QueryResult contains the result of executing a single SQL statement.

The read pool auto-scale configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Target metric for read pool auto scaling.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Read-replica configuration for connecting to the primary instance.

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.

Connect settings retrieval request.

Database instance restore from backup context. Backup context contains source instance id and project id.

Instance rotate Entra ID certificate context.

Instance rotate server CA context.

Instance rotate server certificate context.

Contains the values for a row.

A list of objects that the user selects for replication from an external source instance.

Database instance settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The options for enforcing Cloud SQL connectors in the instance.

ExecuteSql API's access to the instance.

The list of Cloud SQL editions available to users.

Specifies when the instance is activated.

The abstract base class for a message.

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

The modes of Active Directory configuration.

The availability type of the given Cloud SQL instance.

Defines the supported backup kinds.

The status of a backup run.

Type of backup (i.e. automated, on demand, etc).

Backup runs delete request.

Backup runs get request.

Backup runs insert request.

Backup runs list request.

The type of disk that is used for a v2 instance to use.

The database engine type and version.

Database delete request.

Database get request.

Database insert request.

Database list request.

Database update request.

External primary instance migration setting error/warning.

Scopes of a flag describe where the flag is used.

Flags list request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request to acquire a lease for SSRS.

Response for the acquire SSRS lease request.

Instance add Entra ID certificate request.

Instance add server CA request.

Instance add server certificate request.

Instance clone request.

Instance create ephemeral certificate request.

Instance delete request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance demote master request.

Instance demote request.

Execute SQL statements request.

Execute SQL statements response.

Represents a notice or warning message from the database.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance export request.

Instance failover request.

Instance get disk shrink config request.

Instance get disk shrink config response.

Instance get latest recovery time request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance get latest recovery time response.

Instance get request.

Instance import request.

Instance insert request.

Instance list Entra ID certificates request.

Instance list request.

Instance list server CAs request.

Instance list server certificates request.

Instance patch request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance perform disk shrink request.

Request to perform a point in time restore on a Google Cloud Backup and Disaster Recovery managed instance.

Request for Pre-checks for MVU

Instance promote replica request.

Instance reencrypt request.

Request to release a lease for SSRS.

Response for the release SSRS lease request.

Instance reschedule maintenance request.

Reschedule options for maintenance windows.

Instance reset replica size request.

Instance reset SSL config request.

Reset SSL mode to selectively refresh the SSL materials.

Instance restart request.

Instance restore backup request.

Instance rotate server certificate request.

Instance rotate server CA request.

Instance rotate server certificate request.

Instance start external sync request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance start replica request.

Instance stop replica request.

Instance switchover request.

Instance truncate log request.

Instance update request.

Instance verify external sync settings request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MigrationType determines whether the migration is a physical file-based migration or a logical dump file-based migration.

Instance verify external sync settings response.

The type of maintenance to be performed on the instance.

Operations cancel request.

Operations get request.

Operations list request.

The pricing plan for this instance.

SQL Server specific audit configuration.

Represents a Sql Server database on the Cloud SQL instance.

SQL Server Entra ID configuration.

Represents a Sql Server user on the Cloud SQL instance.

The sub operation type based on the operation type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The suspension reason of the database instance if the state is SUSPENDED.

Tiers list request.

Request message for Users Get RPC

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SslCerts Resource

SslCertDetail.

SslCerts create ephemeral certificate request.

SslCerts insert request.

SslCert insert response.

SslCerts list response.

Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.

A Google Cloud SQL service tier resource.

Tiers list response.

Database Instance truncate log context.

The request payload to update the backup.

A Cloud SQL user resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of retained password.

Indicates if a group is available for IAM database authentication.

The user type.

User level password validation policy.

User list response.

The cell value of the table.

A pager for iterating through list requests.

This class thinly wraps an initial BackupRunsListResponse object, and provides an __aiter__ method to iterate through its items field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual BackupRunsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial BackupRunsListResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual BackupRunsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_backups requests.

This class thinly wraps an initial ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Cloud SQL connect service.

Cloud SQL connect service.

Service for streaming data to and from Cloud SQL instances.

Service for streaming data to and from Cloud SQL instances.

Service for providing IAM Meta APIs for Cloud SQL.

Service for providing IAM Meta APIs for Cloud SQL.

A pager for iterating through list requests.

This class thinly wraps an initial InstancesListResponse object, and provides an __aiter__ method to iterate through its warnings field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the warnings field on the corresponding responses.

All the usual InstancesListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial InstancesListResponse object, and provides an __iter__ method to iterate through its warnings field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the warnings field on the corresponding responses.

All the usual InstancesListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial OperationsListResponse object, and provides an __aiter__ method to iterate through its items field.

If there are more pages, the __aiter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual OperationsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list requests.

This class thinly wraps an initial OperationsListResponse object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual OperationsListResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service for providing machine types (tiers) for Cloud SQL.

Service for providing machine types (tiers) for Cloud SQL.

Acknowledges data received by the client or server.

An entry for an Access Control list.

Acquire SSRS lease context.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies options for controlling advanced machine features.

An Admin API warning message.

The status of automated DNS provisioning.

An available database version. It can be a major or a minor version.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A backup resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The backup's state

The backup type.

Database instance backup configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup tier that manages the backups for the instance.

This value contains the storage location of the transactional logs used to perform point-in-time recovery (PITR) for the database.

Backup context.

Backup Reencryption Config

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup type for re-encryption

We currently only support backup retention by specifying the number of backups we will retain.

The units that retained_backups specifies, we only support COUNT.

A BackupRun resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Backup run list results.

Binary log coordinates.

Database instance clone context.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Contains the name and datatype of a column.

Connect settings retrieval response.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Various Certificate Authority (CA) modes for certificate signing.

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

MdxProtocolSupport describes parts of the MDX protocol supported by this instance.

The managed connection pooling configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Connection pool flags for Cloud SQL instances managed connection pool configuration.

Reconnects to an existing session. The client must send this as the first message to the server to reconnect to an existing session. The client may immediately send Data messages without waiting for a reply from the server.

The request payload to create the backup

Data cache configurations.

Contains data being sent or received by the database.

Represents a SQL database on the Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Database flags for Cloud SQL instances.

A Cloud SQL instance resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

The current serving state of the database instance.

The SQL network architecture for the instance.

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

This enum lists all possible states regarding out-of-disk issues.

Any scheduled maintenance for this instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Database list response.

The request payload to delete the backup.

This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

Read-replica configuration for connecting to the on-premises primary instance.

Database instance demote primary instance context.

Read-replica configuration specific to MySQL databases.

Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

Disk encryption configuration for an instance.

Disk encryption status for an instance.

DNS metadata.

The connection type of the DNS name.

The scope that the DNS name applies to.

The system responsible for managing the DNS record.

The request payload used to execute SQL statements.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Controls how the API should respond when the SQL execution result exceeds 10 MB.

Database instance export context.

Options for exporting BAK files (SQL Server-only)

Options for exporting from MySQL.

Options for exporting from a Cloud SQL for PostgreSQL instance.

External Sync parallel level.

The selected object that Cloud SQL migrates.

Database instance failover context.

Config used to determine the final backup settings for the instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A flag resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Flags list response.

Gemini instance configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Ephemeral certificate creation request.

Ephemeral certificate creation request.

The request payload to get the backup.

Connect settings retrieval request.

Database instance import context.

Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.

Reference to another Cloud SQL instance.

Request to acquire an SSRS lease for an instance.

Database instance clone request.

Database demote primary instance request.

This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

Database instance export request.

Instance failover request.

Database instance import request.

Instances ListEntraIdCertificates response.

Database instances list response.

Instances ListServerCas response.

Instances ListServerCertificatess response.

Request for Pre-checks for MVU

Database Instance reencrypt request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Database instance restore backup request.

Rotate Entra ID Certificate request.

Rotate Server CA request.

Rotate Server Certificate request.

Instance truncate log request.

IP Management configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Various Certificate Authority (CA) modes for certificate signing.

Settings for automatic server certificate rotation.

The SSL options for database connections.

    When this value is used, the legacy `require_ssl` flag
    must be false or cleared to avoid a conflict between the
    values of the two flags.
ENCRYPTED_ONLY (2):
    Only allow connections encrypted with SSL/TLS. For SSL
    connections to MySQL and PostgreSQL, the client certificate
    isn't verified.

    When this value is used, the legacy `require_ssl` flag
    must be false or cleared to avoid a conflict between the
    values of the two flags.
TRUSTED_CLIENT_CERTIFICATE_REQUIRED (3):
    Only allow connections encrypted with SSL/TLS and with valid
    client certificates.

    When this value is used, the legacy `require_ssl` flag
    must be true or cleared to avoid the conflict between values
    of two flags. PostgreSQL clients or users that connect using
    IAM database authentication must use either the `Cloud SQL
    Auth
    Proxy <https://cloud.google.com/sql/docs/postgres/connect-auth-proxy>`__
    or `Cloud SQL
    Connectors <https://cloud.google.com/sql/docs/postgres/connect-connectors>`__
    to enforce client identity verification.

    Only applicable to MySQL and PostgreSQL. Not applicable to
    SQL Server.

Database instance IP mapping

The request payload to list the backups.

The response payload containing a list of the backups.

Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.

Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.

The additional metadata information regarding the execution of the SQL statements.

Read-replica configuration specific to MySQL databases.

MySQL-specific external server sync settings.

On-premises instance configuration.

SslOption defines the SSL mode to be used for replica connection to the on-premises source.

An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

The status of an operation.

The type of Cloud SQL operation.

Database instance operation error.

Database instance operation errors list wrapper.

Operations list response.

Read-only password status.

Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access.

The complexity choices of the password.

Perform disk shrink context.

Performance capture configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines the categories of long-running transactions eligible for automatic termination by the Performance Capture.

Context to perform a point-in-time restore of an instance managed by Backup and Disaster Recovery (DR) Service.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Pre-check major version upgrade context.

Structured PreCheckResponse containing message, type, and required actions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of message which can be an info, a warning, or an error that requires user intervention.

Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PSC settings for a Cloud SQL instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

QueryResult contains the result of executing a single SQL statement.

The read pool auto-scale configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Target metric for read pool auto scaling.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Read-replica configuration for connecting to the primary instance.

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 has regional failure. Applicable to MySQL and PostgreSQL.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Connect settings retrieval request.

Database instance restore from backup context. Backup context contains source instance id and project id.

Instance rotate Entra ID certificate context.

Instance rotate server CA context.

Instance rotate server certificate context.

Contains the values for a row.

A list of objects that the user selects for replication from an external source instance.

Metadata from the server to the client about the session. The server will always send this as the first message

Database instance settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The options for enforcing Cloud SQL connectors in the instance.

ExecuteSql API's access to the instance.

The list of Cloud SQL editions available to users.

Specifies when the instance is activated.

The abstract base class for a message.

Active Directory configuration, relevant only for Cloud SQL for SQL Server.

The modes of Active Directory configuration.

The availability type of the given Cloud SQL instance.

Defines the supported backup kinds

The status of a backup run.

The type of disk that is used for a v2 instance to use.

The session features. The server must send the supported features in its first message to the client.

The database engine type and version.

External primary instance migration setting error/warning.

Scopes of a flag describe where the flag is used.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request to acquire a lease for SSRS.

Acquire SSRS lease response.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for AddEntraIdCertificate RPC.

Request for AddServerCertificate RPC.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance demote request.

Execute SQL statements request.

Execute SQL statements response.

Represents a notice or warning message from the database.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance get disk shrink config request.

Instance get disk shrink config response.

Instance get latest recovery time request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance get latest recovery time response.

Request message for SqlInstancesService.ListEntraIdCertificates.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance perform disk shrink request.

Request to perform a point in time restore on a Google Cloud Backup and Disaster Recovery managed instance.

Request for Pre-checks for MVU

Instance reencrypt request.

Request to release a lease for SSRS.

The response for the release of the SSRS lease.

Reschedule options for maintenance windows.

Instance reset replica size request.

Reset SSL mode to selectively refresh the SSL materials.

Request message for SqlInstancesService.RotateEntraIdCertificate.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Instance switchover request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MigrationType determines whether the migration is a physical file-based migration or a logical dump file-based migration.

Instance verify external sync settings response.

The type of maintenance to be performed on the instance.

The request payload to cancel an operation.

The pricing plan for this instance.

SQL Server specific audit configuration.

Represents a Sql Server database on the Cloud SQL instance.

SQL Server Entra ID configuration.

Represents a Sql Server user on the Cloud SQL instance.

The sub operation type based on the operation type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The suspension reason of the database instance if the state is SUSPENDED.

Request message for Users Get RPC

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SslCerts Resource

SslCertDetail.

SslCerts create ephemeral certificate request.

SslCerts insert request.

SslCert insert response.

SslCerts list response.

Start a new session. The client must send this as the first message to the server to start a new session. The client may immediately send Data messages without waiting for a reply from the server.

Message sent from the client to SqlDataService.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Message sent from SqlDataService back to the client.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.

Indicates that the session is permanently ended.

A Google Cloud SQL service tier resource.

Tiers list response.

Database Instance truncate log context.

The request payload to update the backup.

A Cloud SQL user resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of retained password.

Indicates if a group is available for IAM database authentication.

The user type.

User level password validation policy.

User list response.

The cell value of the table.

API documentation for sqladmin_v1.services.sql_backup_runs_service.pagers module.

API documentation for sqladmin_v1.services.sql_backups_service.pagers module.

API documentation for sqladmin_v1.services.sql_instances_service.pagers module.

API documentation for sqladmin_v1.services.sql_operations_service.pagers module.

API documentation for sqladmin_v1beta4.services.sql_backup_runs_service.pagers module.

API documentation for sqladmin_v1beta4.services.sql_backups_service.pagers module.

API documentation for sqladmin_v1beta4.services.sql_instances_service.pagers module.

API documentation for sqladmin_v1beta4.services.sql_operations_service.pagers module.