Module model 

The messages and enums that are part of this client library.

Modules

api_warning

Defines additional types related to ApiWarning.

backup_configuration

Defines additional types related to BackupConfiguration.

backup_reencryption_config

Defines additional types related to BackupReencryptionConfig.

backup_retention_settings

Defines additional types related to BackupRetentionSettings.

connect_settings

Defines additional types related to ConnectSettings.

database

Defines additional types related to Database.

database_instance

Defines additional types related to DatabaseInstance.

export_context

Defines additional types related to ExportContext.

import_context

Defines additional types related to ImportContext.

ip_configuration

Defines additional types related to IpConfiguration.

operation

Defines additional types related to Operation.

password_validation_policy

Defines additional types related to PasswordValidationPolicy.

settings

Defines additional types related to Settings.

sql_external_sync_setting_error

Defines additional types related to SqlExternalSyncSettingError.

sql_instances_reschedule_maintenance_request_body

Defines additional types related to SqlInstancesRescheduleMaintenanceRequestBody.

sql_instances_start_external_sync_request

Defines additional types related to SqlInstancesStartExternalSyncRequest.

sql_instances_verify_external_sync_settings_request

Defines additional types related to SqlInstancesVerifyExternalSyncSettingsRequest.

user

Defines additional types related to User.

Structs

AclEntry

An entry for an Access Control list.

AcquireSsrsLeaseContext

Acquire SSRS lease context.

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

ApiWarning

An Admin API warning message.

AvailableDatabaseVersion

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

BackupConfiguration

Database instance backup configuration.

BackupContext

Backup context.

BackupReencryptionConfig

Backup Reencryption Config

BackupRetentionSettings

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

BackupRun

A BackupRun resource.

BackupRunsListResponse

Backup run list results.

BinLogCoordinates

Binary log coordinates.

CloneContext

Database instance clone context.

ConnectSettings

Connect settings retrieval response.

DataCacheConfig

Data cache configurations.

Database

Represents a SQL database on the Cloud SQL instance.

DatabaseFlags

Database flags for Cloud SQL instances.

DatabaseInstance

A Cloud SQL instance resource.

DatabasesListResponse

Database list response.

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.

ExportContext

Database instance export context.

FailoverContext

Database instance failover context.

Flag

A flag resource.

FlagsListResponse

Flags list response.

GeminiInstanceConfig

Gemini instance configuration.

GenerateEphemeralCertRequest

Ephemeral certificate creation request.

GenerateEphemeralCertResponse

Ephemeral certificate creation request.

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.

InstancesListResponse

Database instances list response.

InstancesListServerCasResponse

Instances ListServerCas response.

InstancesReencryptRequest

Database Instance reencrypt request.

InstancesRestoreBackupRequest

Database instance restore backup request.

InstancesRotateServerCaRequest

Rotate server CA request.

InstancesTruncateLogRequest

Instance truncate log request.

IpConfiguration

IP Management configuration.

IpMapping

Database instance IP mapping

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.

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

PerformDiskShrinkContext

Perform disk shrink context.

PscConfig

PSC settings for a Cloud SQL instance.

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. Only applicable to MySQL.

RestoreBackupContext

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

RotateServerCaContext

Instance rotate server CA context.

Settings

Database instance settings.

SqlActiveDirectoryConfig

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

SqlBackupRunsDeleteRequest

Backup runs delete request.

SqlBackupRunsGetRequest

Backup runs get request.

SqlBackupRunsInsertRequest

Backup runs insert request.

SqlBackupRunsListRequest

Backup runs list request.

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.

SqlFlagsListRequest

Flags list request.

SqlInstancesAcquireSsrsLeaseRequest

Request to acquire a lease for SSRS.

SqlInstancesAcquireSsrsLeaseResponse

Response for the acquire SSRS lease request.

SqlInstancesAddServerCaRequest

Instance add server CA request.

SqlInstancesCloneRequest

Instance clone request.

SqlInstancesCreateEphemeralCertRequest

Instance create ephemeral certificate request.

SqlInstancesDeleteRequest

Instance delete request.

SqlInstancesDemoteMasterRequest

Instance demote master request.

SqlInstancesDemoteRequest

Instance demote request.

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.

SqlInstancesGetLatestRecoveryTimeResponse

Instance get latest recovery time response.

SqlInstancesGetRequest

Instance get request.

SqlInstancesImportRequest

Instance import request.

SqlInstancesInsertRequest

Instance insert request.

SqlInstancesListRequest

Instance list request.

SqlInstancesListServerCasRequest

Instance list server CAs request.

SqlInstancesPatchRequest

Instance patch request.

SqlInstancesPerformDiskShrinkRequest

Instance perform disk shrink request.

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.

SqlInstancesRotateServerCaRequest

Instance rotate server CA request.

SqlInstancesStartExternalSyncRequest

Instance start external sync request.

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.

SqlInstancesVerifyExternalSyncSettingsResponse

Instance verify external sync settings response.

SqlOperationsCancelRequest

Operations cancel request.

SqlOperationsGetRequest

Operations get request.

SqlOperationsListRequest

Operations list request.

SqlServerAuditConfig

SQL Server specific audit configuration.

SqlServerDatabaseDetails

Represents a Sql Server database on the Cloud SQL instance.

SqlServerUserDetails

Represents a Sql Server user on the Cloud SQL instance.

SqlSslCertsDeleteRequest

SqlSslCertsGetRequest

SqlSslCertsInsertRequest

SqlSslCertsListRequest

SqlTiersListRequest

Tiers list request.

SqlUsersDeleteRequest

SqlUsersGetRequest

Request message for Users Get RPC

SqlUsersInsertRequest

SqlUsersListRequest

SqlUsersUpdateRequest

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.

User

A Cloud SQL user resource.

UserPasswordValidationPolicy

User level password validation policy.

UsersListResponse

User list response.

Enums

BakType

Working with unknown values

ExternalSyncParallelLevel

External Sync parallel level.

SqlAvailabilityType

The availability type of the given Cloud SQL instance.

SqlBackendType

Working with unknown values

SqlBackupKind

Defines the supported backup kinds.

SqlBackupRunStatus

The status of a backup run.

SqlBackupRunType

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

SqlDataDiskType

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

SqlDatabaseVersion

The database engine type and version.

SqlFileType

Working with unknown values

SqlFlagType

Working with unknown values

SqlInstanceType

Working with unknown values

SqlIpAddressType

Working with unknown values

SqlPricingPlan

The pricing plan for this instance.

SqlReplicationType

Working with unknown values

SqlSuspensionReason

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

SqlUpdateTrack

Working with unknown values