API Reference google_api_sql_admin v0.71.0

API client metadata for GoogleApi.SQLAdmin.V1.

API calls for all endpoints tagged BackupRuns.

API calls for all endpoints tagged Backups.

API calls for all endpoints tagged Connect.

API calls for all endpoints tagged Databases.

API calls for all endpoints tagged Flags.

API calls for all endpoints tagged Instances.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

API calls for all endpoints tagged SslCerts.

API calls for all endpoints tagged Tiers.

API calls for all endpoints tagged Users.

Handle Tesla connections for GoogleApi.SQLAdmin.V1.

An entry for an Access Control list.

Acquire SSRS lease context.

Specifies options for controlling advanced machine features.

An Admin API warning message.

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

A backup resource.

Database instance backup configuration.

Backup context.

Backup Reencryption Config

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

A BackupRun resource.

Backup run list results.

Binary log coordinates.

Database instance clone context.

Details of a single node of a read pool.

Connect settings retrieval response.

The managed connection pooling configuration.

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

Data cache configurations.

Represents a SQL database on the Cloud SQL instance.

Database flags for Cloud SQL instances.

A Cloud SQL instance resource.

The name and status of the failover replica.

Database list response.

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

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

Database instance demote primary instance context.

Read-replica configuration specific to MySQL databases.

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

Disk encryption configuration for an instance.

Disk encryption status for an instance.

DNS metadata.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Database instance export context.

Options for exporting BAK files (SQL Server-only)

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

Options for exporting data as SQL statements.

Options for exporting from MySQL.

Options for exporting from a Cloud SQL for PostgreSQL instance.

Optional. Export parameters specific to SQL Server TDE certificates

The selected object that Cloud SQL migrates.

Database instance failover context.

A flag resource.

Flags list response.

Gemini instance configuration.

Ephemeral certificate creation request.

Ephemeral certificate creation request.

Database instance import context.

Import parameters specific to SQL Server .BAK files

Attributes

• certPath (type: String.t, default: nil) - Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
• keepEncrypted (type: boolean(), default: nil) - Optional. Whether the imported file remains encrypted.
• pvkPassword (type: String.t, default: nil) - Password that encrypts the private key
• pvkPath (type: String.t, default: nil) - Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Options for importing data as CSV.

Optional. Options for importing data from SQL statements.

Optional. Options for importing from a Cloud SQL for PostgreSQL instance.

Optional. Import parameters specific to SQL Server TDE certificates

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

Reference to another Cloud SQL instance.

Request to acquire a lease for SSRS.

Database instance clone request.

Database demote primary instance request.

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

Database instance export request.

Instance failover request.

Database instance import request.

Database instances list response.

Instances ListServerCas response.

Instances ListServerCertificates response.

Database Instance reencrypt request.

Database instance restore backup request.

Rotate server CA request.

Rotate server certificate request.

Instance truncate log request.

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

IP Management configuration.

Database instance IP mapping

The response payload containing a list of the backups.

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

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

Read-replica configuration specific to MySQL databases.

MySQL-specific external server sync settings.

On-premises instance configuration.

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

Database instance operation error.

Database instance operation errors list wrapper.

Represents the metadata of the long-running operation.

Operations list response.

Read-only password status.

Database instance local user password validation policy

Perform disk shrink context.

Details of a single node of a read pool.

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

PSC settings for a Cloud SQL instance.

Read-replica configuration for connecting to the primary instance.

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

Attributes

• rescheduleType (type: String.t, default: nil) - Required. The type of the reschedule.
• scheduleTime (type: DateTime.t, default: nil) - Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

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

Instance rotate server CA context.

Instance rotate server certificate context.

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

Database instance settings.

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

External primary instance migration setting error/warning.

Response for the acquire SSRS lease request.

Instance get disk shrink config response.

Instance get latest recovery time response.

Response for the release SSRS lease request.

Reschedule options for maintenance windows.

Instance reset replica size request.

Instance start external sync request.

Instance verify external sync settings request.

Instance verify external sync settings response.

This message wraps up the information written by out-of-disk detection job.

Any scheduled maintenance for this instance.

SQL Server specific audit configuration.

Represents a Sql Server database on the Cloud SQL instance.

Represents a Sql Server user on the Cloud SQL instance.

The sub operation type based on the operation type.

SslCerts Resource

SslCertDetail.

SslCerts create ephemeral certificate request.

SslCerts insert request.

SslCert insert response.

SslCerts list response.

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

A Google Cloud SQL service tier resource.

Tiers list response.

Database Instance truncate log context.

A Cloud SQL user resource.

User level password validation policy.

User list response.

API client metadata for GoogleApi.SQLAdmin.V1beta4.

API calls for all endpoints tagged BackupRuns.

API calls for all endpoints tagged Backups.

API calls for all endpoints tagged Connect.

API calls for all endpoints tagged Databases.

API calls for all endpoints tagged Flags.

API calls for all endpoints tagged Instances.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

API calls for all endpoints tagged SslCerts.

API calls for all endpoints tagged Tiers.

API calls for all endpoints tagged Users.

Handle Tesla connections for GoogleApi.SQLAdmin.V1beta4.

An entry for an Access Control list.

Acquire SSRS lease context.

Specifies options for controlling advanced machine features.

An Admin API warning message.

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

A backup resource.

Database instance backup configuration.

Backup context.

Backup Reencryption Config

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

A BackupRun resource.

Backup run list results.

Binary log coordinates.

Database instance clone context.

Details of a single node of a read pool.

Connect settings retrieval response.

The managed connection pooling configuration.

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

Data cache configurations.

Represents a SQL database on the Cloud SQL instance.

Database flags for Cloud SQL instances.

A Cloud SQL instance resource.

The name and status of the failover replica.

Database list response.

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

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

Database instance demote primary instance context.

Read-replica configuration specific to MySQL databases.

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

Disk encryption configuration for an instance.

Disk encryption status for an instance.

DNS metadata.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Database instance export context.

Options for exporting BAK files (SQL Server-only)

Options for exporting data as CSV. MySQL and PostgreSQL instances only.

Options for exporting data as SQL statements.

Options for exporting from MySQL.

Options for exporting from a Cloud SQL for PostgreSQL instance.

Optional. Export parameters specific to SQL Server TDE certificates

The selected object that Cloud SQL migrates.

Database instance failover context.

A flag resource.

Flags list response.

Gemini instance configuration.

Ephemeral certificate creation request.

Ephemeral certificate creation request.

Database instance import context.

Import parameters specific to SQL Server .BAK files

Attributes

• certPath (type: String.t, default: nil) - Path to the Certificate (.cer) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.
• keepEncrypted (type: boolean(), default: nil) - Optional. Whether the imported file remains encrypted.
• pvkPassword (type: String.t, default: nil) - Password that encrypts the private key
• pvkPath (type: String.t, default: nil) - Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form gs://bucketName/fileName. The instance must have write permissions to the bucket and read access to the file.

Options for importing data as CSV.

Optional. Options for importing data from SQL statements.

Optional. Options for importing from a Cloud SQL for PostgreSQL instance.

Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates

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

Reference to another Cloud SQL instance.

Request to acquire an SSRS lease for an instance.

Database instance clone request.

Database demote primary instance request.

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

Database instance export request.

Instance failover request.

Database instance import request.

Database instances list response.

Instances ListServerCas response.

Instances ListServerCertificatess response.

Database Instance reencrypt request.

Database instance restore backup request.

Rotate Server CA request.

Rotate Server Certificate request.

Instance truncate log request.

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

IP Management configuration.

Database instance IP mapping

The response payload containing a list of the backups.

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

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

Read-replica configuration specific to MySQL databases.

MySQL-specific external server sync settings.

On-premises instance configuration.

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

Database instance operation error.

Database instance operation errors list wrapper.

Represents the metadata of the long-running operation.

Operations list response.

Read-only password status.

Database instance local user password validation policy

Perform disk shrink context.

Details of a single node of a read pool.

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

PSC settings for a Cloud SQL instance.

Read-replica configuration for connecting to the primary instance.

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

Attributes

• rescheduleType (type: String.t, default: nil) - Required. The type of the reschedule.
• scheduleTime (type: DateTime.t, default: nil) - Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

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

Instance rotate server CA context.

Instance rotate server certificate context.

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

Database instance settings.

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

External primary instance migration setting error/warning.

Acquire SSRS lease response.

Instance get disk shrink config response.

Instance get latest recovery time response.

The response for the release of the SSRS lease.

Reschedule options for maintenance windows.

Instance reset replica size request.

Attributes

• migrationType (type: String.t, default: nil) - Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are LOGICAL or PHYSICAL. Only applicable to MySQL.
• mysqlSyncConfig (type: GoogleApi.SQLAdmin.V1beta4.Model.MySqlSyncConfig.t, default: nil) - MySQL-specific settings for start external sync.
• skipVerification (type: boolean(), default: nil) - Whether to skip the verification step (VESS).
• syncMode (type: String.t, default: nil) - External sync mode.
• syncParallelLevel (type: String.t, default: nil) - Optional. Parallel level for initial data sync. Currently only applicable for MySQL.

Attributes

• migrationType (type: String.t, default: nil) - Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are LOGICAL or PHYSICAL. Only applicable to MySQL.
• mysqlSyncConfig (type: GoogleApi.SQLAdmin.V1beta4.Model.MySqlSyncConfig.t, default: nil) - Optional. MySQL-specific settings for start external sync.
• selectedObjects (type: list(GoogleApi.SQLAdmin.V1beta4.Model.ExternalSyncSelectedObject.t), default: nil) - Optional. Migrate only the specified objects from the source instance. If this field is empty, then migrate all objects.
• syncMode (type: String.t, default: nil) - External sync mode
• syncParallelLevel (type: String.t, default: nil) - Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
• verifyConnectionOnly (type: boolean(), default: nil) - Flag to enable verifying connection only
• verifyReplicationOnly (type: boolean(), default: nil) - Optional. Flag to verify settings required by replication setup only

Instance verify external sync settings response.

This message wraps up the information written by out-of-disk detection job.

Any scheduled maintenance for this instance.

SQL Server specific audit configuration.

Represents a Sql Server database on the Cloud SQL instance.

Represents a Sql Server user on the Cloud SQL instance.

The sub operation type based on the operation type.

SslCerts Resource

SslCertDetail.

SslCerts create ephemeral certificate request.

SslCerts insert request.

SslCert insert response.

SslCerts list response.

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

A Google Cloud SQL service tier resource.

Tiers list response.

Database Instance truncate log context.

A Cloud SQL user resource.

User level password validation policy.

User list response.