Package Classes (0.1.1)

Summary of entries of Classes for google-cloud-sql.

Classes

SqlAvailableDatabaseVersionsServiceAsyncClient

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

SqlAvailableDatabaseVersionsServiceClient

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

SqlBackupRunsServiceAsyncClient

Service for managing database backups.

ListAsyncPager

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.

ListPager

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.

ListBackupsAsyncPager

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.

ListBackupsPager

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.

SqlDatabasesServiceAsyncClient

Service to manage databases.

SqlEventsServiceAsyncClient

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

SqlEventsServiceClient

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

SqlFeatureEligibilityServiceAsyncClient

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

SqlFeatureEligibilityServiceClient

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

SqlFlagsServiceAsyncClient

Service to manage database flags for Cloud SQL instances.

SqlFlagsServiceClient

Service to manage database flags for Cloud SQL instances.

SqlIamPoliciesServiceAsyncClient

Service for providing IAM Meta APIs for Cloud SQL.

SqlIamPoliciesServiceClient

Service for providing IAM Meta APIs for Cloud SQL.

SqlInstanceNamesServiceAsyncClient

Cloud SQL instance names service.

ListAsyncPager

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.

ListPager

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.

SqlOperationsServiceAsyncClient

Service to fetch operations for database instances.

SqlOperationsServiceClient

Service to fetch operations for database instances.

ListAsyncPager

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.

ListPager

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.

SqlRegionsServiceAsyncClient

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.

SqlRegionsServiceClient

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.

SqlSslCertsServiceAsyncClient

Service to manage SSL certs for Cloud SQL instances.

SqlSslCertsServiceClient

Service to manage SSL certs for Cloud SQL instances.

SqlTiersServiceAsyncClient

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

SqlTiersServiceClient

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

AcquireSsrsLeaseContext

Acquire SSRS lease context.

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

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

AutoDnsStatus

The status of automated DNS provisioning.

AvailableDatabaseVersion

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

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

SqlBackupState

The backup's state

SqlBackupType

The backup type.

BackupConfiguration

Database instance backup configuration.

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

BackupTier

Backup tier that manages the backups for the instance.

TransactionalLogStorageState

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

BackupContext

Backup context.

BackupReencryptionConfig

Backup Reencryption Config

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

BackupType

Backup type for re-encryption

BackupRetentionSettings

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

RetentionUnit

The units that retained_backups specifies, we only support COUNT.

BackupRun

A BackupRun resource.

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

BackupRunsListResponse

Backup run list results.

BakType

BinLogCoordinates

Binary log coordinates.

CloneContext

Database instance clone context.

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

Column

Contains the name and datatype of a column.

ConnectSettings

Connect settings retrieval response.

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

CaMode

Various Certificate Authority (CA) modes for certificate signing.

ConnectPoolNodeConfig

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

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

ConnectionPoolConfig

The managed connection pooling configuration.

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

ConnectionPoolFlags

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

CreateBackupRequest

The request payload to create the backup

DataCacheConfig

Data cache configurations.

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

DatabaseFlags

Database flags for Cloud SQL instances.

DatabaseInstance

A Cloud SQL instance resource.

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

PoolNodeConfig

Details of a single read pool node of a read pool.

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

SqlFailoverReplica

SqlInstanceState

The current serving state of the database instance.

SqlNetworkArchitecture

The SQL network architecture for the instance.

SqlOutOfDiskReport

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

SqlOutOfDiskState

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

SqlScheduledMaintenance

Any scheduled maintenance for this instance.

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

TagsEntry

The abstract base class for a message.

DatabasesListResponse

Database list response.

DeleteBackupRequest

The request payload to delete the backup.

DemoteContext

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

DemoteMasterConfiguration

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

DemoteMasterContext

Database instance demote primary instance context.

DemoteMasterMySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.

DenyMaintenancePeriod

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

DiskEncryptionConfiguration

Disk encryption configuration for an instance.

DiskEncryptionStatus

Disk encryption status for an instance.

DnsNameMapping

DNS metadata.

ConnectionType

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

DnsScope

The scope that the DNS name applies to.

RecordManager

The system responsible for managing the DNS record.

ExecuteSqlPayload

The request payload used to execute SQL statements.

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

PartialResultMode

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

ExportContext

Database instance export context.

SqlBakExportOptions

Options for exporting BAK files (SQL Server-only)

SqlCsvExportOptions

SqlExportOptions

MysqlExportOptions

Options for exporting from MySQL.

PostgresExportOptions

Options for exporting from a Cloud SQL for PostgreSQL instance.

SqlTdeExportOptions

ExternalSyncParallelLevel

External Sync parallel level.

ExternalSyncSelectedObject

The selected object that Cloud SQL migrates.

FailoverContext

Database instance failover context.

FinalBackupConfig

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

Flag

A flag resource.

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

FlagsListResponse

Flags list response.

GeminiInstanceConfig

Gemini instance configuration.

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

GenerateEphemeralCertRequest

Ephemeral certificate creation request.

GenerateEphemeralCertResponse

Ephemeral certificate creation request.

GetBackupRequest

The request payload to get the backup.

GetConnectSettingsRequest

Connect settings retrieval request.

ImportContext

Database instance import context.

SqlBakImportOptions

EncryptionOptions

SqlCsvImportOptions

SqlImportOptions

PostgresImportOptions

SqlTdeImportOptions

InsightsConfig

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

InstanceReference

Reference to another Cloud SQL instance.

InstancesAcquireSsrsLeaseRequest

Request to acquire a lease for SSRS.

InstancesCloneRequest

Database instance clone request.

InstancesDemoteMasterRequest

Database demote primary instance request.

InstancesDemoteRequest

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

InstancesExportRequest

Database instance export request.

InstancesFailoverRequest

Instance failover request.

InstancesImportRequest

Database instance import request.

InstancesListEntraIdCertificatesResponse

Instances ListEntraIdCertificates response.

InstancesListResponse

Database instances list response.

InstancesListServerCasResponse

Instances ListServerCas response.

InstancesListServerCertificatesResponse

Instances ListServerCertificates response.

InstancesPreCheckMajorVersionUpgradeRequest

Request for Pre-checks for MVU

InstancesReencryptRequest

Database Instance reencrypt request.

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

InstancesRestoreBackupRequest

Database instance restore backup request.

InstancesRotateEntraIdCertificateRequest

Rotate Entra ID certificate request.

InstancesRotateServerCaRequest

Rotate server CA request.

InstancesRotateServerCertificateRequest

Rotate server certificate request.

InstancesTruncateLogRequest

Instance truncate log request.

IpConfiguration

IP Management configuration.

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

CaMode

Various Certificate Authority (CA) modes for certificate signing.

ServerCertificateRotationMode

Settings for automatic server certificate rotation.

SslMode

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.

IpMapping

Database instance IP mapping

ListBackupsRequest

The request payload to list the backups.

ListBackupsResponse

The response payload containing a list of the backups.

LocationPreference

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.

MaintenanceWindow

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

Metadata

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

MySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.

MySqlSyncConfig

MySQL-specific external server sync settings.

OnPremisesConfiguration

On-premises instance configuration.

SslOption

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

Operation

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

SqlOperationStatus

The status of an operation.

SqlOperationType

The type of Cloud SQL operation.

OperationError

Database instance operation error.

OperationErrors

Database instance operation errors list wrapper.

OperationsListResponse

Operations list response.

PasswordStatus

Read-only password status.

PasswordValidationPolicy

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.

Complexity

The complexity choices of the password.

PerformDiskShrinkContext

Perform disk shrink context.

PerformanceCaptureConfig

Performance capture configuration.

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

TransactionKillType

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

PointInTimeRestoreContext

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

PreCheckMajorVersionUpgradeContext

Pre-check major version upgrade context.

PreCheckResponse

Structured PreCheckResponse containing message, type, and required actions.

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

MessageType

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

PscAutoConnectionConfig

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

PscConfig

PSC settings for a Cloud SQL instance.

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

QueryResult

QueryResult contains the result of executing a single SQL statement.

ReadPoolAutoScaleConfig

The read pool auto-scale configuration.

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

TargetMetric

Target metric for read pool auto scaling.

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

ReplicaConfiguration

Read-replica configuration for connecting to the primary instance.

ReplicationCluster

A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.

ResolveConnectSettingsRequest

Connect settings retrieval request.

RestoreBackupContext

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

RotateEntraIdCertificateContext

Instance rotate Entra ID certificate context.

RotateServerCaContext

Instance rotate server CA context.

RotateServerCertificateContext

Instance rotate server certificate context.

Row

Contains the values for a row.

SelectedObjects

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

Settings

Database instance settings.

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

ConnectorEnforcement

The options for enforcing Cloud SQL connectors in the instance.

DataApiAccess

ExecuteSql API's access to the instance.

Edition

The list of Cloud SQL editions available to users.

SqlActivationPolicy

Specifies when the instance is activated.

UserLabelsEntry

The abstract base class for a message.

SqlActiveDirectoryConfig

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

ActiveDirectoryMode

The modes of Active Directory configuration.

SqlAvailabilityType

The availability type of the given Cloud SQL instance.

SqlBackendType

SqlBackupKind

Defines the supported backup kinds.

SqlBackupRunStatus

The status of a backup run.

SqlBackupRunType

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

SqlBackupRunsDeleteRequest

Backup runs delete request.

SqlBackupRunsGetRequest

Backup runs get request.

SqlBackupRunsInsertRequest

Backup runs insert request.

SqlBackupRunsListRequest

Backup runs list request.

SqlDataDiskType

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

SqlDatabaseVersion

The database engine type and version.

SqlDatabasesDeleteRequest

Database delete request.

SqlDatabasesGetRequest

Database get request.

SqlDatabasesInsertRequest

Database insert request.

SqlDatabasesListRequest

Database list request.

SqlDatabasesUpdateRequest

Database update request.

SqlExternalSyncSettingError

External primary instance migration setting error/warning.

SqlExternalSyncSettingErrorType

SqlFileType

SqlFlagScope

Scopes of a flag describe where the flag is used.

SqlFlagType

SqlFlagsListRequest

Flags list request.

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

SqlInstanceType

SqlInstancesAcquireSsrsLeaseRequest

Request to acquire a lease for SSRS.

SqlInstancesAcquireSsrsLeaseResponse

Response for the acquire SSRS lease request.

SqlInstancesAddEntraIdCertificateRequest

Instance add Entra ID certificate request.

SqlInstancesAddServerCaRequest

Instance add server CA request.

SqlInstancesAddServerCertificateRequest

Instance add server certificate request.

SqlInstancesCloneRequest

Instance clone request.

SqlInstancesCreateEphemeralCertRequest

Instance create ephemeral certificate request.

SqlInstancesDeleteRequest

Instance delete request.

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

SqlInstancesDemoteMasterRequest

Instance demote master request.

SqlInstancesDemoteRequest

Instance demote request.

SqlInstancesExecuteSqlRequest

Execute SQL statements request.

SqlInstancesExecuteSqlResponse

Execute SQL statements response.

Message

Represents a notice or warning message from the database.

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

SqlInstancesExportRequest

Instance export request.

SqlInstancesFailoverRequest

Instance failover request.

SqlInstancesGetDiskShrinkConfigRequest

Instance get disk shrink config request.

SqlInstancesGetDiskShrinkConfigResponse

Instance get disk shrink config response.

SqlInstancesGetLatestRecoveryTimeRequest

Instance get latest recovery time request.

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

SqlInstancesGetLatestRecoveryTimeResponse

Instance get latest recovery time response.

SqlInstancesGetRequest

Instance get request.

SqlInstancesImportRequest

Instance import request.

SqlInstancesInsertRequest

Instance insert request.

SqlInstancesListEntraIdCertificatesRequest

Instance list Entra ID certificates request.

SqlInstancesListRequest

Instance list request.

SqlInstancesListServerCasRequest

Instance list server CAs request.

SqlInstancesListServerCertificatesRequest

Instance list server certificates request.

SqlInstancesPatchRequest

Instance patch request.

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

SqlInstancesPerformDiskShrinkRequest

Instance perform disk shrink request.

SqlInstancesPointInTimeRestoreRequest

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

SqlInstancesPreCheckMajorVersionUpgradeRequest

Request for Pre-checks for MVU

SqlInstancesPromoteReplicaRequest

Instance promote replica request.

SqlInstancesReencryptRequest

Instance reencrypt request.

SqlInstancesReleaseSsrsLeaseRequest

Request to release a lease for SSRS.

SqlInstancesReleaseSsrsLeaseResponse

Response for the release SSRS lease request.

SqlInstancesRescheduleMaintenanceRequest

Instance reschedule maintenance request.

SqlInstancesRescheduleMaintenanceRequestBody

Reschedule options for maintenance windows.

Reschedule

RescheduleType

SqlInstancesResetReplicaSizeRequest

Instance reset replica size request.

SqlInstancesResetSslConfigRequest

Instance reset SSL config request.

ResetSslMode

Reset SSL mode to selectively refresh the SSL materials.

SqlInstancesRestartRequest

Instance restart request.

SqlInstancesRestoreBackupRequest

Instance restore backup request.

SqlInstancesRotateEntraIdCertificateRequest

Instance rotate server certificate request.

SqlInstancesRotateServerCaRequest

Instance rotate server CA request.

SqlInstancesRotateServerCertificateRequest

Instance rotate server certificate request.

SqlInstancesStartExternalSyncRequest

Instance start external sync request.

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

SqlInstancesStartReplicaRequest

Instance start replica request.

SqlInstancesStopReplicaRequest

Instance stop replica request.

SqlInstancesSwitchoverRequest

Instance switchover request.

SqlInstancesTruncateLogRequest

Instance truncate log request.

SqlInstancesUpdateRequest

Instance update request.

SqlInstancesVerifyExternalSyncSettingsRequest

Instance verify external sync settings request.

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

ExternalSyncMode

MigrationType

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

SqlInstancesVerifyExternalSyncSettingsResponse

Instance verify external sync settings response.

SqlIpAddressType

SqlMaintenanceType

The type of maintenance to be performed on the instance.

SqlOperationsCancelRequest

Operations cancel request.

SqlOperationsGetRequest

Operations get request.

SqlOperationsListRequest

Operations list request.

SqlPricingPlan

The pricing plan for this instance.

SqlReplicationType

SqlServerAuditConfig

SQL Server specific audit configuration.

SqlServerDatabaseDetails

Represents a Sql Server database on the Cloud SQL instance.

SqlServerEntraIdConfig

SQL Server Entra ID configuration.

SqlServerUserDetails

Represents a Sql Server user on the Cloud SQL instance.

SqlSslCertsDeleteRequest

SqlSslCertsGetRequest

SqlSslCertsInsertRequest

SqlSslCertsListRequest

SqlSubOperationType

The sub operation type based on the operation type.

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

SqlSuspensionReason

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

SqlTiersListRequest

Tiers list request.

SqlUpdateTrack

SqlUsersDeleteRequest

SqlUsersGetRequest

Request message for Users Get RPC

SqlUsersInsertRequest

SqlUsersListRequest

SqlUsersUpdateRequest

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

SslCert

SslCerts Resource

SslCertDetail

SslCertDetail.

SslCertsCreateEphemeralRequest

SslCerts create ephemeral certificate request.

SslCertsInsertRequest

SslCerts insert request.

SslCertsInsertResponse

SslCert insert response.

SslCertsListResponse

SslCerts list response.

SyncFlags

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

Tier

A Google Cloud SQL service tier resource.

TiersListResponse

Tiers list response.

TruncateLogContext

Database Instance truncate log context.

UpdateBackupRequest

The request payload to update the backup.

User

A Cloud SQL user resource.

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

DualPasswordType

The type of retained password.

IamStatus

Indicates if a group is available for IAM database authentication.

SqlUserType

The user type.

UserPasswordValidationPolicy

User level password validation policy.

UsersListResponse

User list response.

Value

The cell value of the table.

ListAsyncPager

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.

ListPager

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.

ListBackupsAsyncPager

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.

ListBackupsPager

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.

SqlConnectServiceAsyncClient

Cloud SQL connect service.

SqlConnectServiceClient

Cloud SQL connect service.

SqlDataServiceAsyncClient

Service for streaming data to and from Cloud SQL instances.

SqlDataServiceClient

Service for streaming data to and from Cloud SQL instances.

SqlIamPoliciesServiceAsyncClient

Service for providing IAM Meta APIs for Cloud SQL.

SqlIamPoliciesServiceClient

Service for providing IAM Meta APIs for Cloud SQL.

ListAsyncPager

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.

ListPager

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.

ListAsyncPager

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.

ListPager

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.

SqlTiersServiceAsyncClient

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

SqlTiersServiceClient

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

Ack

Acknowledges data received by the client or server.

AclEntry

An entry for an Access Control list.

AcquireSsrsLeaseContext

Acquire SSRS lease context.

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

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

ApiWarning

An Admin API warning message.

SqlApiWarningCode

AutoDnsStatus

The status of automated DNS provisioning.

AvailableDatabaseVersion

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

Backup

A backup resource.

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

SqlBackupState

The backup's state

SqlBackupType

The backup type.

BackupConfiguration

Database instance backup configuration.

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

BackupTier

Backup tier that manages the backups for the instance.

TransactionalLogStorageState

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

BackupContext

Backup context.

BackupReencryptionConfig

Backup Reencryption Config

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

BackupType

Backup type for re-encryption

BackupRetentionSettings

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

RetentionUnit

The units that retained_backups specifies, we only support COUNT.

BackupRun

A BackupRun resource.

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

BackupRunsListResponse

Backup run list results.

BakType

BinLogCoordinates

Binary log coordinates.

CloneContext

Database instance clone context.

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

Column

Contains the name and datatype of a column.

ConnectSettings

Connect settings retrieval response.

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

CaMode

Various Certificate Authority (CA) modes for certificate signing.

ConnectPoolNodeConfig

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

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

ConnectionPoolConfig

The managed connection pooling configuration.

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

ConnectionPoolFlags

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

ContinueSession

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.

CreateBackupRequest

The request payload to create the backup

DataCacheConfig

Data cache configurations.

DataPacket

Contains data being sent or received by the database.

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

DatabaseFlags

Database flags for Cloud SQL instances.

DatabaseInstance

A Cloud SQL instance resource.

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

PoolNodeConfig

Details of a single read pool node of a read pool.

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

SqlFailoverReplica

SqlInstanceState

The current serving state of the database instance.

SqlNetworkArchitecture

The SQL network architecture for the instance.

SqlOutOfDiskReport

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

SqlOutOfDiskState

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

SqlScheduledMaintenance

Any scheduled maintenance for this instance.

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

TagsEntry

The abstract base class for a message.

DatabasesListResponse

Database list response.

DeleteBackupRequest

The request payload to delete the backup.

DemoteContext

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

DemoteMasterConfiguration

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

DemoteMasterContext

Database instance demote primary instance context.

DemoteMasterMySqlReplicaConfiguration

Read-replica configuration specific to MySQL databases.

DenyMaintenancePeriod

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

DiskEncryptionConfiguration

Disk encryption configuration for an instance.

DiskEncryptionStatus

Disk encryption status for an instance.

DnsNameMapping

DNS metadata.

ConnectionType

The connection type of the DNS name.

DnsScope

The scope that the DNS name applies to.

RecordManager

The system responsible for managing the DNS record.

ExecuteSqlPayload

The request payload used to execute SQL statements.

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

PartialResultMode

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

ExportContext

Database instance export context.

SqlBakExportOptions

Options for exporting BAK files (SQL Server-only)

SqlCsvExportOptions

SqlExportOptions

MysqlExportOptions

Options for exporting from MySQL.

PostgresExportOptions

Options for exporting from a Cloud SQL for PostgreSQL instance.

SqlTdeExportOptions

ExternalSyncParallelLevel

External Sync parallel level.

ExternalSyncSelectedObject

The selected object that Cloud SQL migrates.

FailoverContext

Database instance failover context.

FinalBackupConfig

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

Flag

A flag resource.

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

FlagsListResponse

Flags list response.

GeminiInstanceConfig

Gemini instance configuration.

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

GenerateEphemeralCertRequest

Ephemeral certificate creation request.

GenerateEphemeralCertResponse

Ephemeral certificate creation request.

GetBackupRequest

The request payload to get the backup.

GetConnectSettingsRequest

Connect settings retrieval request.

ImportContext

Database instance import context.

SqlBakImportOptions

EncryptionOptions

SqlCsvImportOptions

SqlImportOptions

PostgresImportOptions

SqlTdeImportOptions

InsightsConfig

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

InstanceReference

Reference to another Cloud SQL instance.

InstancesAcquireSsrsLeaseRequest

Request to acquire an SSRS lease for an instance.

InstancesCloneRequest

Database instance clone request.

InstancesDemoteMasterRequest

Database demote primary instance request.

InstancesDemoteRequest

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

InstancesExportRequest

Database instance export request.

InstancesFailoverRequest

Instance failover request.

InstancesImportRequest

Database instance import request.

InstancesListEntraIdCertificatesResponse

Instances ListEntraIdCertificates response.

InstancesListResponse

Database instances list response.

InstancesListServerCasResponse

Instances ListServerCas response.

InstancesListServerCertificatesResponse

Instances ListServerCertificatess response.

InstancesPreCheckMajorVersionUpgradeRequest

Request for Pre-checks for MVU

InstancesReencryptRequest

Database Instance reencrypt request.

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

InstancesRestoreBackupRequest

Database instance restore backup request.

InstancesRotateEntraIdCertificateRequest

Rotate Entra ID Certificate request.

InstancesRotateServerCaRequest

Rotate Server CA request.

InstancesRotateServerCertificateRequest

Rotate Server Certificate request.

InstancesTruncateLogRequest

Instance truncate log request.

IpConfiguration

IP Management configuration.

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

CaMode

Various Certificate Authority (CA) modes for certificate signing.

ServerCertificateRotationMode

Settings for automatic server certificate rotation.

SslMode

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.

Package Classes (0.1.1) Stay organized with collections Save and categorize content based on your preferences.

Classes

Package Classes (0.1.1)