API documentation for sqladmin_v1.types package.
Classes
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.
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.
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
BackupConfiguration
Database instance backup configuration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupContext
Backup context.
BackupReencryptionConfig
Backup Reencryption Config
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BackupRetentionSettings
We currently only support backup retention by specifying the number of backups we will retain.
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
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
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.
ExecuteSqlPayload
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
ExportContext
Database instance export context.
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.
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
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.
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
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.
Operation
An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
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.
PerformDiskShrinkContext
Perform disk shrink context.
PerformanceCaptureConfig
Performance capture configuration.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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
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
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
SqlActiveDirectoryConfig
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
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.
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.
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
SqlInstancesDemoteMasterRequest
Instance demote master request.
SqlInstancesDemoteRequest
Instance demote request.
SqlInstancesExecuteSqlRequest
Execute SQL statements request.
SqlInstancesExecuteSqlResponse
Execute SQL statements response.
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.
SqlInstancesResetReplicaSizeRequest
Instance reset replica size request.
SqlInstancesResetSslConfigRequest
Instance reset SSL config request.
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
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
UserPasswordValidationPolicy
User level password validation policy.
UsersListResponse
User list response.
Value
The cell value of the table.