Package types (0.1.1)

API documentation for sqladmin_v1beta4.types package.

Classes

Ack

Acknowledges data received by the client or server.

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

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.

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

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.

.. _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.

.. _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 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

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

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

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

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

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.

SessionMetadata

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

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

SqlBackupRunsDeleteRequest

SqlBackupRunsGetRequest

SqlBackupRunsInsertRequest

SqlBackupRunsListRequest

SqlDataDiskType

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

SqlDataFeature

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

SqlDatabaseVersion

The database engine type and version.

SqlDatabasesDeleteRequest

SqlDatabasesGetRequest

SqlDatabasesInsertRequest

SqlDatabasesListRequest

SqlDatabasesUpdateRequest

SqlExternalSyncSettingError

External primary instance migration setting error/warning.

SqlFileType

SqlFlagScope

Scopes of a flag describe where the flag is used.

SqlFlagType

SqlFlagsListRequest

.. _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

Acquire SSRS lease response.

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

SqlInstancesAddEntraIdCertificateRequest

Request for AddEntraIdCertificate RPC.

SqlInstancesAddServerCaRequest

SqlInstancesAddServerCertificateRequest

Request for AddServerCertificate RPC.

SqlInstancesCloneRequest

SqlInstancesCreateEphemeralCertRequest

SqlInstancesDeleteRequest

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

SqlInstancesDemoteMasterRequest

SqlInstancesDemoteRequest

Instance demote request.

SqlInstancesExecuteSqlRequest

Execute SQL statements request.

SqlInstancesExecuteSqlResponse

Execute SQL statements response.

SqlInstancesExportRequest

SqlInstancesFailoverRequest

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

SqlInstancesImportRequest

SqlInstancesInsertRequest

SqlInstancesListEntraIdCertificatesRequest

Request message for SqlInstancesService.ListEntraIdCertificates.

SqlInstancesListRequest

SqlInstancesListServerCasRequest

SqlInstancesListServerCertificatesRequest

SqlInstancesPatchRequest

.. _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

SqlInstancesReencryptRequest

Instance reencrypt request.

SqlInstancesReleaseSsrsLeaseRequest

Request to release a lease for SSRS.

SqlInstancesReleaseSsrsLeaseResponse

The response for the release of the SSRS lease.

SqlInstancesRescheduleMaintenanceRequest

SqlInstancesRescheduleMaintenanceRequestBody

Reschedule options for maintenance windows.

SqlInstancesResetReplicaSizeRequest

Instance reset replica size request.

SqlInstancesResetSslConfigRequest

SqlInstancesRestartRequest

SqlInstancesRestoreBackupRequest

SqlInstancesRotateEntraIdCertificateRequest

Request message for SqlInstancesService.RotateEntraIdCertificate.

SqlInstancesRotateServerCaRequest

SqlInstancesRotateServerCertificateRequest

SqlInstancesStartExternalSyncRequest

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

SqlInstancesStartReplicaRequest

SqlInstancesStopReplicaRequest

SqlInstancesSwitchoverRequest

Instance switchover request.

SqlInstancesTruncateLogRequest

SqlInstancesUpdateRequest

SqlInstancesVerifyExternalSyncSettingsRequest

.. _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

The request payload to cancel an operation.

SqlOperationsGetRequest

SqlOperationsListRequest

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

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.

StartSession

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.