google-cloud-sql-v1 0.a → 0.2.0

data/proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb

@@ -0,0 +1,2634 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Sql
+      module V1
+        # An entry for an Access Control list.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     The allowlisted value for the access control list.
+        # @!attribute [rw] expiration_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when this access control entry expires in
+        #     [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Optional. A label to identify this entry.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#aclEntry`.
+        class AclEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An Admin API warning message.
+        # @!attribute [rw] code
+        #   @return [::Google::Cloud::Sql::V1::ApiWarning::SqlApiWarningCode]
+        #     Code to uniquely identify the warning type.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     The warning message.
+        # @!attribute [rw] region
+        #   @return [::String]
+        #     The region name for REGION_UNREACHABLE warning.
+        class ApiWarning
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module SqlApiWarningCode
+            # An unknown or unset warning type from Cloud SQL API.
+            SQL_API_WARNING_CODE_UNSPECIFIED = 0
+
+            # Warning when one or more regions are not reachable.  The returned result
+            # set may be incomplete.
+            REGION_UNREACHABLE = 1
+
+            # Warning when user provided maxResults parameter exceeds the limit.  The
+            # returned result set may be incomplete.
+            MAX_RESULTS_EXCEEDS_LIMIT = 2
+
+            # Warning when user tries to create/update a user with credentials that
+            # have previously been compromised by a public data breach.
+            COMPROMISED_CREDENTIALS = 3
+
+            # Warning when the operation succeeds but some non-critical workflow state
+            # failed.
+            INTERNAL_STATE_FAILURE = 4
+          end
+        end
+
+        # We currently only support backup retention by specifying the number
+        # of backups we will retain.
+        # @!attribute [rw] retention_unit
+        #   @return [::Google::Cloud::Sql::V1::BackupRetentionSettings::RetentionUnit]
+        #     The unit that 'retained_backups' represents.
+        # @!attribute [rw] retained_backups
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Depending on the value of retention_unit, this is used to determine
+        #     if a backup needs to be deleted.  If retention_unit is 'COUNT', we will
+        #     retain this many backups.
+        class BackupRetentionSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The units that retained_backups specifies, we only support COUNT.
+          module RetentionUnit
+            # Backup retention unit is unspecified, will be treated as COUNT.
+            RETENTION_UNIT_UNSPECIFIED = 0
+
+            # Retention will be by count, eg. "retain the most recent 7 backups".
+            COUNT = 1
+          end
+        end
+
+        # Database instance backup configuration.
+        # @!attribute [rw] start_time
+        #   @return [::String]
+        #     Start time for the daily backup configuration in UTC timezone in the 24
+        #     hour format - `HH:MM`.
+        # @!attribute [rw] enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether this configuration is enabled.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#backupConfiguration`.
+        # @!attribute [rw] binary_log_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     (MySQL only) Whether binary log is enabled. If backup configuration is
+        #     disabled, binarylog must be disabled as well.
+        # @!attribute [rw] replication_log_archiving_enabled
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. Deprecated: replication_log_archiving_enabled is deprecated and
+        #     will be removed from a future version of the API. Use
+        #     {::Google::Cloud::Sql::V1::BackupConfiguration#point_in_time_recovery_enabled point_in_time_recovery_enabled}
+        #     instead.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     Location of the backup
+        # @!attribute [rw] point_in_time_recovery_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether point in time recovery is enabled.
+        # @!attribute [rw] backup_retention_settings
+        #   @return [::Google::Cloud::Sql::V1::BackupRetentionSettings]
+        #     Backup retention settings.
+        # @!attribute [rw] transaction_log_retention_days
+        #   @return [::Google::Protobuf::Int32Value]
+        #     The number of days of transaction logs we retain for point in time
+        #     restore, from 1-7.
+        # @!attribute [r] transactional_log_storage_state
+        #   @return [::Google::Cloud::Sql::V1::BackupConfiguration::TransactionalLogStorageState]
+        #     Output only. This value contains the storage location of transactional logs
+        #     used to perform point-in-time recovery (PITR) for the database.
+        # @!attribute [r] backup_tier
+        #   @return [::Google::Cloud::Sql::V1::BackupConfiguration::BackupTier]
+        #     Output only. Backup tier that manages the backups for the instance.
+        class BackupConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # This value contains the storage location of the transactional logs
+          # used to perform point-in-time recovery (PITR) for the database.
+          module TransactionalLogStorageState
+            # Unspecified.
+            TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED = 0
+
+            # The transaction logs used for PITR for the instance are stored
+            # on a data disk.
+            DISK = 1
+
+            # The transaction logs used for PITR for the instance are switching from
+            # being stored on a data disk to being stored in Cloud Storage.
+            # Only applicable to MySQL.
+            SWITCHING_TO_CLOUD_STORAGE = 2
+
+            # The transaction logs used for PITR for the instance are now stored
+            # in Cloud Storage. Previously, they were stored on a data disk.
+            # Only applicable to MySQL.
+            SWITCHED_TO_CLOUD_STORAGE = 3
+
+            # The transaction logs used for PITR for the instance are stored in
+            # Cloud Storage. Only applicable to MySQL and PostgreSQL.
+            CLOUD_STORAGE = 4
+          end
+
+          # Backup tier that manages the backups for the instance.
+          module BackupTier
+            # Unspecified.
+            BACKUP_TIER_UNSPECIFIED = 0
+
+            # Instance is managed by Cloud SQL.
+            STANDARD = 1
+
+            # Deprecated: ADVANCED is deprecated. Please use ENHANCED instead.
+            ADVANCED = 2
+
+            # Instance is managed by Google Cloud Backup and DR Service.
+            ENHANCED = 3
+          end
+        end
+
+        # Perform disk shrink context.
+        # @!attribute [rw] target_size_gb
+        #   @return [::Integer]
+        #     The target disk shrink size in GigaBytes.
+        class PerformDiskShrinkContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Structured PreCheckResponse containing message, type, and required
+        # actions.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     The message to be displayed to the user.
+        # @!attribute [rw] message_type
+        #   @return [::Google::Cloud::Sql::V1::PreCheckResponse::MessageType]
+        #     The type of message whether it is an info, warning, or error.
+        # @!attribute [rw] actions_required
+        #   @return [::Array<::String>]
+        #     The actions that the user needs to take. Use repeated for multiple
+        #     actions.
+        class PreCheckResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of message which can be an info, a warning, or an error that
+          # requires user intervention.
+          module MessageType
+            # Default unspecified value to prevent unintended behavior changes.
+            MESSAGE_TYPE_UNSPECIFIED = 0
+
+            # General informational messages that don't require action.
+            INFO = 1
+
+            # Warnings that might impact the upgrade but don't block it.
+            WARNING = 2
+
+            # Errors that a user must resolve before proceeding with the upgrade.
+            ERROR = 3
+          end
+        end
+
+        # Pre-check major version upgrade context.
+        # @!attribute [rw] target_database_version
+        #   @return [::Google::Cloud::Sql::V1::SqlDatabaseVersion]
+        #     Required. The target database version to upgrade to.
+        # @!attribute [r] pre_check_response
+        #   @return [::Array<::Google::Cloud::Sql::V1::PreCheckResponse>]
+        #     Output only. The responses from the precheck operation.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+        class PreCheckMajorVersionUpgradeContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Backup context.
+        # @!attribute [rw] backup_id
+        #   @return [::Integer]
+        #     The identifier of the backup.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#backupContext`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the backup.
+        #     Format: projects/\\{project}/backups/\\{backup}
+        class BackupContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a SQL database on the Cloud SQL instance.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#database`.
+        # @!attribute [rw] charset
+        #   @return [::String]
+        #     The Cloud SQL charset value.
+        # @!attribute [rw] collation
+        #   @return [::String]
+        #     The Cloud SQL collation value.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     This field is deprecated and will be removed from a future version of the
+        #     API.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the database in the Cloud SQL instance. This does not include
+        #     the project ID or instance name.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     The name of the Cloud SQL instance. This does not include the project ID.
+        # @!attribute [rw] self_link
+        #   @return [::String]
+        #     The URI of this resource.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     The project ID of the project containing the Cloud SQL database. The Google
+        #     apps domain is prefixed if applicable.
+        # @!attribute [rw] sqlserver_database_details
+        #   @return [::Google::Cloud::Sql::V1::SqlServerDatabaseDetails]
+        class Database
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a Sql Server database on the Cloud SQL instance.
+        # @!attribute [rw] compatibility_level
+        #   @return [::Integer]
+        #     The version of SQL Server with which the database is to be made compatible
+        # @!attribute [rw] recovery_model
+        #   @return [::String]
+        #     The recovery model of a SQL Server database
+        class SqlServerDatabaseDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database flags for Cloud SQL instances.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the flag. These flags are passed at instance startup, so
+        #     include both server options and system variables. Flags are
+        #     specified with underscores, not hyphens. For more information, see
+        #     [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags)
+        #     in the Cloud SQL documentation.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     The value of the flag. Boolean flags are set to `on` for true
+        #     and `off` for false. This field must be omitted if the flag
+        #     doesn't take a value.
+        class DatabaseFlags
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # MySQL-specific external server sync settings.
+        # @!attribute [rw] initial_sync_flags
+        #   @return [::Array<::Google::Cloud::Sql::V1::SyncFlags>]
+        #     Flags to use for the initial dump.
+        class MySqlSyncConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Initial sync flags for certain Cloud SQL APIs.
+        # Currently used for the MySQL external server initial dump.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the flag.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     The value of the flag. This field must be omitted if the flag
+        #     doesn't take a value.
+        class SyncFlags
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Reference to another Cloud SQL instance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the Cloud SQL instance being referenced.
+        #     This does not include the project ID.
+        # @!attribute [rw] region
+        #   @return [::String]
+        #     The region of the Cloud SQL instance being referenced.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     The project ID of the Cloud SQL instance being referenced.
+        #     The default is the same project ID as the instance references it.
+        class InstanceReference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Read-replica configuration for connecting to the on-premises primary
+        # instance.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#demoteMasterConfiguration`.
+        # @!attribute [rw] mysql_replica_configuration
+        #   @return [::Google::Cloud::Sql::V1::DemoteMasterMySqlReplicaConfiguration]
+        #     MySQL specific configuration when replicating from a MySQL on-premises
+        #     primary instance. Replication configuration information such as the
+        #     username, password, certificates, and keys are not stored in the instance
+        #     metadata. The configuration information is used only to set up the
+        #     replication connection and is stored by MySQL in a file named
+        #     `master.info` in the data directory.
+        class DemoteMasterConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Read-replica configuration specific to MySQL databases.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#demoteMasterMysqlReplicaConfiguration`.
+        # @!attribute [rw] username
+        #   @return [::String]
+        #     The username for the replication connection.
+        # @!attribute [rw] password
+        #   @return [::String]
+        #     The password for the replication connection.
+        # @!attribute [rw] client_key
+        #   @return [::String]
+        #     PEM representation of the replica's private key. The corresponding public
+        #     key is encoded in the client's certificate. The format of the replica's
+        #     private key can be either PKCS #1 or PKCS #8.
+        # @!attribute [rw] client_certificate
+        #   @return [::String]
+        #     PEM representation of the replica's x509 certificate.
+        # @!attribute [rw] ca_certificate
+        #   @return [::String]
+        #     PEM representation of the trusted CA's x509 certificate.
+        class DemoteMasterMySqlReplicaConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database instance export context.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The path to the file in Google Cloud Storage where the export will be
+        #     stored. The URI is in the form `gs://bucketName/fileName`. If the file
+        #     already exists, the request succeeds, but the operation fails. If
+        #     `fileType` is `SQL` and the filename ends with .gz,
+        #     the contents are compressed.
+        # @!attribute [rw] databases
+        #   @return [::Array<::String>]
+        #     Databases to be exported. <br /> `MySQL instances:` If
+        #     `fileType` is `SQL` and no database is specified, all
+        #     databases are exported, except for the `mysql` system database.
+        #     If `fileType` is `CSV`, you can specify one database,
+        #     either by using this property or by using the
+        #     `csvExportOptions.selectQuery` property, which takes precedence
+        #     over this property. <br /> `PostgreSQL instances:` If you don't specify a
+        #     database by name, all user databases in the instance are exported.
+        #     This excludes system databases and Cloud SQL databases used to manage
+        #     internal operations. Exporting all user databases is only available for
+        #     directory-formatted parallel export. If `fileType` is `CSV`,
+        #     this database must match the one specified in the
+        #     `csvExportOptions.selectQuery` property. <br /> `SQL Server
+        #     instances:` You must specify one database to be exported, and the
+        #     `fileType` must be `BAK`.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#exportContext`.
+        # @!attribute [rw] sql_export_options
+        #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions]
+        #     Options for exporting data as SQL statements.
+        # @!attribute [rw] csv_export_options
+        #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions]
+        #     Options for exporting data as CSV. `MySQL` and `PostgreSQL`
+        #     instances only.
+        # @!attribute [rw] file_type
+        #   @return [::Google::Cloud::Sql::V1::SqlFileType]
+        #     The file type for the specified uri.
+        # @!attribute [rw] offload
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether to perform a serverless export.
+        # @!attribute [rw] bak_export_options
+        #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions]
+        #     Options for exporting data as BAK files.
+        # @!attribute [rw] tde_export_options
+        #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions]
+        #     Optional. Export parameters specific to SQL Server TDE certificates
+        class ExportContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] select_query
+          #   @return [::String]
+          #     The select query used to extract the data.
+          # @!attribute [rw] escape_character
+          #   @return [::String]
+          #     Specifies the character that should appear before a data character that
+          #     needs to be escaped.
+          # @!attribute [rw] quote_character
+          #   @return [::String]
+          #     Specifies the quoting character to be used when a data value is quoted.
+          # @!attribute [rw] fields_terminated_by
+          #   @return [::String]
+          #     Specifies the character that separates columns within each row (line) of
+          #     the file.
+          # @!attribute [rw] lines_terminated_by
+          #   @return [::String]
+          #     This is used to separate lines. If a line does not contain all fields,
+          #     the rest of the columns are set to their default values.
+          class SqlCsvExportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] tables
+          #   @return [::Array<::String>]
+          #     Tables to export, or that were exported, from the specified database. If
+          #     you specify tables, specify one and only one database. For PostgreSQL
+          #     instances, you can specify only one table.
+          # @!attribute [rw] schema_only
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Export only schemas.
+          # @!attribute [rw] mysql_export_options
+          #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions::MysqlExportOptions]
+          # @!attribute [rw] threads
+          #   @return [::Google::Protobuf::Int32Value]
+          #     Optional. The number of threads to use for parallel export.
+          # @!attribute [rw] parallel
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Optional. Whether or not the export should be parallel.
+          # @!attribute [rw] postgres_export_options
+          #   @return [::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions::PostgresExportOptions]
+          #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
+          class SqlExportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Options for exporting from MySQL.
+            # @!attribute [rw] master_data
+            #   @return [::Google::Protobuf::Int32Value]
+            #     Option to include SQL statement required to set up replication. If set
+            #     to `1`, the dump file includes a CHANGE MASTER TO statement with the
+            #     binary log coordinates, and --set-gtid-purged is set to ON. If set to
+            #     `2`, the CHANGE MASTER TO statement is written as a SQL comment and
+            #     has no effect. If set to any value other than `1`, --set-gtid-purged
+            #     is set to OFF.
+            class MysqlExportOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Options for exporting from a Cloud SQL for PostgreSQL instance.
+            # @!attribute [rw] clean
+            #   @return [::Google::Protobuf::BoolValue]
+            #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
+            #     SQL statements. Use these statements to delete database objects before
+            #     running the import operation.
+            # @!attribute [rw] if_exists
+            #   @return [::Google::Protobuf::BoolValue]
+            #     Optional. Option to include an IF EXISTS SQL statement with each DROP
+            #     statement produced by clean.
+            class PostgresExportOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Options for exporting BAK files (SQL Server-only)
+          # @!attribute [rw] striped
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Whether or not the export should be striped.
+          # @!attribute [rw] stripe_count
+          #   @return [::Google::Protobuf::Int32Value]
+          #     Option for specifying how many stripes to use for the export.
+          #     If blank, and the value of the striped field is true,
+          #     the number of stripes is automatically chosen.
+          # @!attribute [rw] bak_type
+          #   @return [::Google::Cloud::Sql::V1::BakType]
+          #     Type of this bak file will be export, FULL or DIFF, SQL Server only
+          # @!attribute [rw] copy_only
+          #   @deprecated This field is deprecated and may be removed in the next major version update.
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Deprecated: copy_only is deprecated. Use differential_base instead
+          # @!attribute [rw] differential_base
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Whether or not the backup can be used as a differential base
+          #     copy_only backup can not be served as differential base
+          # @!attribute [rw] export_log_start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The begin timestamp when transaction log will be included in
+          #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
+          #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
+          #     available logs from the beginning of retention period will be included.
+          #     Only applied to Cloud SQL for SQL Server.
+          # @!attribute [rw] export_log_end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The end timestamp when transaction log will be included in the
+          #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
+          #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
+          #     available logs until current time will be included. Only applied to Cloud
+          #     SQL for SQL Server.
+          class SqlBakExportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] certificate_path
+          #   @return [::String]
+          #     Required. Path to the TDE certificate public key
+          #     in the form gs://bucketName/fileName.
+          #     The instance must have write access to the bucket.
+          #     Applicable only for SQL Server instances.
+          # @!attribute [rw] private_key_path
+          #   @return [::String]
+          #     Required. Path to the TDE certificate private key
+          #     in the form gs://bucketName/fileName.
+          #     The instance must have write access to the location.
+          #     Applicable only for SQL Server instances.
+          # @!attribute [rw] private_key_password
+          #   @return [::String]
+          #     Required. Password that encrypts the private key.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Certificate name.
+          #     Applicable only for SQL Server instances.
+          class SqlTdeExportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Database instance import context.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Path to the import file in Cloud Storage, in the form
+        #     `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported
+        #     when `fileType` is `SQL`. The instance must have
+        #     write permissions to the bucket and read access to the file.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     The target database for the import. If `fileType` is `SQL`, this field
+        #     is required only if the import file does not specify a database, and is
+        #     overridden by any database specification in the import file. For entire
+        #     instance parallel import operations, the database is overridden by the
+        #     database name stored in subdirectory name. If
+        #     `fileType` is `CSV`, one database must be specified.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#importContext`.
+        # @!attribute [rw] file_type
+        #   @return [::Google::Cloud::Sql::V1::SqlFileType]
+        #     The file type for the specified uri.\`SQL`: The file
+        #     contains SQL statements. \`CSV`: The file contains CSV data.
+        # @!attribute [rw] csv_import_options
+        #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlCsvImportOptions]
+        #     Options for importing data as CSV.
+        # @!attribute [rw] import_user
+        #   @return [::String]
+        #     The PostgreSQL user for this import operation. PostgreSQL instances only.
+        # @!attribute [rw] bak_import_options
+        #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlBakImportOptions]
+        #     Import parameters specific to SQL Server .BAK files
+        # @!attribute [rw] sql_import_options
+        #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlImportOptions]
+        #     Optional. Options for importing data from SQL statements.
+        # @!attribute [rw] tde_import_options
+        #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlTdeImportOptions]
+        #     Optional. Import parameters specific to SQL Server TDE certificates
+        class ImportContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] threads
+          #   @return [::Google::Protobuf::Int32Value]
+          #     Optional. The number of threads to use for parallel import.
+          # @!attribute [rw] parallel
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Optional. Whether or not the import should be parallel.
+          # @!attribute [rw] postgres_import_options
+          #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlImportOptions::PostgresImportOptions]
+          #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+          class SqlImportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] clean
+            #   @return [::Google::Protobuf::BoolValue]
+            #     Optional. The --clean flag for the pg_restore utility. This flag
+            #     applies only if you enabled Cloud SQL to import files in parallel.
+            # @!attribute [rw] if_exists
+            #   @return [::Google::Protobuf::BoolValue]
+            #     Optional. The --if-exists flag for the pg_restore utility. This flag
+            #     applies only if you enabled Cloud SQL to import files in parallel.
+            class PostgresImportOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # @!attribute [rw] table
+          #   @return [::String]
+          #     The table to which CSV data is imported.
+          # @!attribute [rw] columns
+          #   @return [::Array<::String>]
+          #     The columns to which CSV data is imported. If not specified, all columns
+          #     of the database table are loaded with CSV data.
+          # @!attribute [rw] escape_character
+          #   @return [::String]
+          #     Specifies the character that should appear before a data character that
+          #     needs to be escaped.
+          # @!attribute [rw] quote_character
+          #   @return [::String]
+          #     Specifies the quoting character to be used when a data value is quoted.
+          # @!attribute [rw] fields_terminated_by
+          #   @return [::String]
+          #     Specifies the character that separates columns within each row (line) of
+          #     the file.
+          # @!attribute [rw] lines_terminated_by
+          #   @return [::String]
+          #     This is used to separate lines. If a line does not contain all fields,
+          #     the rest of the columns are set to their default values.
+          class SqlCsvImportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] encryption_options
+          #   @return [::Google::Cloud::Sql::V1::ImportContext::SqlBakImportOptions::EncryptionOptions]
+          # @!attribute [rw] striped
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Whether or not the backup set being restored is striped.
+          #     Applies only to Cloud SQL for SQL Server.
+          # @!attribute [rw] no_recovery
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Whether or not the backup importing will restore database
+          #     with NORECOVERY option.
+          #     Applies only to Cloud SQL for SQL Server.
+          # @!attribute [rw] recovery_only
+          #   @return [::Google::Protobuf::BoolValue]
+          #     Whether or not the backup importing request will just bring database
+          #     online without downloading Bak content only one of "no_recovery" and
+          #     "recovery_only" can be true otherwise error will return. Applies only to
+          #     Cloud SQL for SQL Server.
+          # @!attribute [rw] bak_type
+          #   @return [::Google::Cloud::Sql::V1::BakType]
+          #     Type of the bak content, FULL or DIFF
+          # @!attribute [rw] stop_at
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The timestamp when the import should stop. This timestamp is in
+          #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
+          #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
+          #     keyword and applies to Cloud SQL for SQL Server only.
+          # @!attribute [rw] stop_at_mark
+          #   @return [::String]
+          #     Optional. The marked transaction where the import should stop. This field
+          #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
+          #     Server only.
+          class SqlBakImportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] cert_path
+            #   @return [::String]
+            #     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.
+            # @!attribute [rw] pvk_path
+            #   @return [::String]
+            #     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.
+            # @!attribute [rw] pvk_password
+            #   @return [::String]
+            #     Password that encrypts the private key
+            # @!attribute [rw] keep_encrypted
+            #   @return [::Google::Protobuf::BoolValue]
+            #     Optional. Whether the imported file remains encrypted.
+            class EncryptionOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # @!attribute [rw] certificate_path
+          #   @return [::String]
+          #     Required. Path to the TDE certificate public key
+          #     in the form gs://bucketName/fileName.
+          #     The instance must have read access to the file.
+          #     Applicable only for SQL Server instances.
+          # @!attribute [rw] private_key_path
+          #   @return [::String]
+          #     Required. Path to the TDE certificate private key
+          #     in the form gs://bucketName/fileName.
+          #     The instance must have read access to the file.
+          #     Applicable only for SQL Server instances.
+          # @!attribute [rw] private_key_password
+          #   @return [::String]
+          #     Required. Password that encrypts the private key.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Certificate name.
+          #     Applicable only for SQL Server instances.
+          class SqlTdeImportOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # IP Management configuration.
+        # @!attribute [rw] ipv4_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether the instance is assigned a public IP address or not.
+        # @!attribute [rw] private_network
+        #   @return [::String]
+        #     The resource link for the VPC network from which the Cloud SQL instance is
+        #     accessible for private IP. For example,
+        #     `/projects/myProject/global/networks/default`. This setting can
+        #     be updated, but it cannot be removed after it is set.
+        # @!attribute [rw] require_ssl
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Use `ssl_mode` instead.
+        #
+        #     Whether SSL/TLS connections over IP are enforced.
+        #     If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections.
+        #     For SSL/TLS connections, the client certificate won't be verified. If
+        #     set to true, then only allow connections encrypted with SSL/TLS and with
+        #     valid client certificates. If you want to enforce SSL/TLS without enforcing
+        #     the requirement for valid client certificates, then use the `ssl_mode` flag
+        #     instead of the `require_ssl` flag.
+        # @!attribute [rw] authorized_networks
+        #   @return [::Array<::Google::Cloud::Sql::V1::AclEntry>]
+        #     The list of external networks that are allowed to connect to the instance
+        #     using the IP. In 'CIDR' notation, also known as 'slash' notation (for
+        #     example: `157.197.200.0/24`).
+        # @!attribute [rw] allocated_ip_range
+        #   @return [::String]
+        #     The name of the allocated ip range for the private ip Cloud SQL instance.
+        #     For example: "google-managed-services-default". If set, the instance ip
+        #     will be created in the allocated range. The range name must comply with
+        #     [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name
+        #     must be 1-63 characters long and match the regular expression
+        #     `[a-z]([-a-z0-9]*[a-z0-9])?.`
+        # @!attribute [rw] enable_private_path_for_google_cloud_services
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Controls connectivity to private IP instances from Google services,
+        #     such as BigQuery.
+        # @!attribute [rw] ssl_mode
+        #   @return [::Google::Cloud::Sql::V1::IpConfiguration::SslMode]
+        #     Specify how SSL/TLS is enforced in database connections. If you must use
+        #     the `require_ssl` flag for backward compatibility, then only the following
+        #     value pairs are valid:
+        #
+        #     For PostgreSQL and MySQL:
+        #
+        #     * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false`
+        #     * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`
+        #     * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true`
+        #
+        #     For SQL Server:
+        #
+        #     * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false`
+        #     * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true`
+        #
+        #     The value of `ssl_mode` has priority over the value of `require_ssl`.
+        #
+        #     For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and
+        #     `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL
+        #     connections, while `require_ssl=false` means accept both non-SSL
+        #     and SSL connections. In this case, MySQL and PostgreSQL databases respect
+        #     `ssl_mode` and accepts only SSL connections.
+        # @!attribute [rw] psc_config
+        #   @return [::Google::Cloud::Sql::V1::PscConfig]
+        #     PSC settings for this instance.
+        # @!attribute [rw] server_ca_mode
+        #   @return [::Google::Cloud::Sql::V1::IpConfiguration::CaMode]
+        #     Specify what type of CA is used for the server certificate.
+        # @!attribute [rw] custom_subject_alternative_names
+        #   @return [::Array<::String>]
+        #     Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.
+        # @!attribute [rw] server_ca_pool
+        #   @return [::String]
+        #     Optional. The resource name of the server CA pool for an instance with
+        #     `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`.
+        #     Format: projects/\\{PROJECT}/locations/\\{REGION}/caPools/\\{CA_POOL_ID}
+        # @!attribute [rw] server_certificate_rotation_mode
+        #   @return [::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode]
+        #     Optional. Controls the automatic server certificate rotation feature. This
+        #     feature is disabled by default. When enabled, the server certificate will
+        #     be automatically rotated during Cloud SQL scheduled maintenance or
+        #     self-service maintenance updates up to six months before it expires. This
+        #     setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA
+        #     or CUSTOMER_MANAGED_CAS_CA.
+        class IpConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The SSL options for database connections.
+          module SslMode
+            # The SSL mode is unknown.
+            SSL_MODE_UNSPECIFIED = 0
+
+            # Allow non-SSL/non-TLS and SSL/TLS connections.
+            # 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.
+            ALLOW_UNENCRYPTED_AND_ENCRYPTED = 1
+
+            # 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.
+            ENCRYPTED_ONLY = 2
+
+            # 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.
+            TRUSTED_CLIENT_CERTIFICATE_REQUIRED = 3
+          end
+
+          # Various Certificate Authority (CA) modes for certificate signing.
+          module CaMode
+            # CA mode is unspecified. It is effectively the same as
+            # `GOOGLE_MANAGED_INTERNAL_CA`.
+            CA_MODE_UNSPECIFIED = 0
+
+            # Google-managed self-signed internal CA.
+            GOOGLE_MANAGED_INTERNAL_CA = 1
+
+            # Google-managed regional CA part of root CA hierarchy hosted on Google
+            # Cloud's Certificate Authority Service (CAS).
+            GOOGLE_MANAGED_CAS_CA = 2
+
+            # Customer-managed CA hosted on Google Cloud's Certificate Authority
+            # Service (CAS).
+            CUSTOMER_MANAGED_CAS_CA = 3
+          end
+
+          # Settings for automatic server certificate rotation.
+          module ServerCertificateRotationMode
+            # Unspecified: no automatic server certificate rotation.
+            SERVER_CERTIFICATE_ROTATION_MODE_UNSPECIFIED = 0
+
+            # No automatic server certificate rotation. The user must [manage server
+            # certificate
+            # rotation](/sql/docs/mysql/manage-ssl-instance#rotate-server-certificate-cas)
+            # on their side.
+            NO_AUTOMATIC_ROTATION = 1
+
+            # Automatic server certificate rotation during Cloud SQL scheduled
+            # maintenance or self-service maintenance updates. Requires
+            # `server_ca_mode` to be `GOOGLE_MANAGED_CAS_CA` or
+            # `CUSTOMER_MANAGED_CAS_CA`.
+            AUTOMATIC_ROTATION_DURING_MAINTENANCE = 2
+          end
+        end
+
+        # PSC settings for a Cloud SQL instance.
+        # @!attribute [rw] psc_enabled
+        #   @return [::Boolean]
+        #     Whether PSC connectivity is enabled for this instance.
+        # @!attribute [rw] allowed_consumer_projects
+        #   @return [::Array<::String>]
+        #     Optional. The list of consumer projects that are allow-listed for PSC
+        #     connections to this instance. This instance can be connected to with PSC
+        #     from any network in these projects.
+        #
+        #     Each consumer project in this list may be represented by a project number
+        #     (numeric) or by a project id (alphanumeric).
+        # @!attribute [rw] psc_auto_connections
+        #   @return [::Array<::Google::Cloud::Sql::V1::PscAutoConnectionConfig>]
+        #     Optional. The list of settings for requested Private Service Connect
+        #     consumer endpoints that can be used to connect to this Cloud SQL instance.
+        # @!attribute [rw] network_attachment_uri
+        #   @return [::String]
+        #     Optional. The network attachment of the consumer network that the
+        #     Private Service Connect enabled Cloud SQL instance is
+        #     authorized to connect via PSC interface.
+        #     format: projects/PROJECT/regions/REGION/networkAttachments/ID
+        # @!attribute [rw] psc_auto_dns_enabled
+        #   @return [::Boolean]
+        #     Optional. Indicates whether Private Service Connect DNS automation is
+        #     enabled for this instance. When enabled, Cloud SQL provisions a universal
+        #     DNS record across all networks configured with Private Service Connect
+        #     auto-connections. This will default to true for new instances when
+        #     Private Service Connect is enabled.
+        # @!attribute [rw] psc_write_endpoint_dns_enabled
+        #   @return [::Boolean]
+        #     Optional. Indicates whether Private Service Connect write endpoint DNS
+        #     automation is enabled for this instance. When enabled, Cloud SQL provisions
+        #     a universal global DNS record across all networks configured with Private
+        #     Service Connect auto-connections that points to the cluster primary
+        #     instance. This feature is only supported for Enterprise Plus edition. This
+        #     will default to true for new Enterprise Plus instances when
+        #     `psc_auto_dns_enabled` is enabled.
+        # @!attribute [rw] psc_auto_connection_policy_enabled
+        #   @return [::Boolean]
+        #     Optional. Whether to set up the PSC service connection policy
+        #     automatically.
+        class PscConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Settings for an automatically-setup Private Service Connect consumer endpoint
+        # that is used to connect to a Cloud SQL instance.
+        # @!attribute [rw] consumer_project
+        #   @return [::String]
+        #     Optional. This is the project ID of consumer service project of this
+        #     consumer endpoint.
+        #
+        #     This is only applicable if `consumer_network` is a shared VPC
+        #     network.
+        # @!attribute [rw] consumer_network
+        #   @return [::String]
+        #     Optional. The consumer network of this consumer endpoint. This must be a
+        #     resource path that includes both the host project and the network name.
+        #
+        #     For example, `projects/project1/global/networks/network1`.
+        #
+        #     The consumer host project of this network might be different from the
+        #     consumer service project.
+        # @!attribute [rw] ip_address
+        #   @return [::String]
+        #     The IP address of the consumer endpoint.
+        # @!attribute [rw] status
+        #   @return [::String]
+        #     The connection status of the consumer endpoint.
+        # @!attribute [rw] consumer_network_status
+        #   @return [::String]
+        #     The connection policy status of the consumer network.
+        # @!attribute [r] service_connection_policy
+        #   @return [::String]
+        #     Output only. The service connection policy created automatically for the
+        #     consumer network when `psc_auto_connection_policy_enabled` is true. It is
+        #     in the format of:
+        #     `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}`
+        #     The `policy_id` is in format of `$NETWORK-$RANDOM`.
+        # @!attribute [r] service_connection_policy_creation_result
+        #   @return [::String]
+        #     Output only. The status of service connection policy creation.
+        # @!attribute [r] instance_auto_dns_status
+        #   @return [::Google::Cloud::Sql::V1::AutoDnsStatus]
+        #     Output only. The status of automated DNS provisioning.
+        # @!attribute [r] write_endpoint_auto_dns_status
+        #   @return [::Google::Cloud::Sql::V1::AutoDnsStatus]
+        #     Output only. The status of automated DNS provisioning for the write
+        #     endpoint.
+        class PscAutoConnectionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] follow_gae_application
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::String]
+        #     The App Engine application to follow, it must be in the same region as the
+        #     Cloud SQL instance. WARNING: Changing this might restart the instance.
+        # @!attribute [rw] zone
+        #   @return [::String]
+        #     The preferred Compute Engine zone (for example: us-central1-a,
+        #     us-central1-b, etc.). WARNING: Changing this might restart the instance.
+        # @!attribute [rw] secondary_zone
+        #   @return [::String]
+        #     The preferred Compute Engine zone for the secondary/failover
+        #     (for example: us-central1-a, us-central1-b, etc.).
+        #     To disable this field, set it to 'no_secondary_zone'.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#locationPreference`.
+        class LocationPreference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Maintenance window. This specifies when a Cloud SQL instance is
+        # restarted for system maintenance purposes.
+        # @!attribute [rw] hour
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Hour of day - 0 to 23. Specify in the UTC time zone.
+        # @!attribute [rw] day
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`,
+        #     `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone.
+        #     Returned in output as an integer, 1 to 7, where `1` equals Monday.
+        # @!attribute [rw] update_track
+        #   @return [::Google::Cloud::Sql::V1::SqlUpdateTrack]
+        #     Maintenance timing settings: `canary`, `stable`, or `week5`.
+        #     For more information, see [About maintenance on Cloud SQL
+        #     instances](https://cloud.google.com/sql/docs/mysql/maintenance).
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#maintenanceWindow`.
+        class MaintenanceWindow
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Deny maintenance Periods. This specifies a date range during when all CSA
+        # rollout will be denied.
+        # @!attribute [rw] start_date
+        #   @return [::String]
+        #     "deny maintenance period" start date. If the year of the start date is
+        #     empty, the year of the end date also must be empty. In this case, it means
+        #     the deny maintenance period recurs every year. The date is in format
+        #     yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
+        # @!attribute [rw] end_date
+        #   @return [::String]
+        #     "deny maintenance period" end date. If the year of the end date is empty,
+        #     the year of the start date also must be empty. In this case, it means the
+        #     no maintenance interval recurs every year. The date is in format yyyy-mm-dd
+        #     i.e., 2020-11-01, or mm-dd, i.e., 11-01
+        # @!attribute [rw] time
+        #   @return [::String]
+        #     Time in UTC when the "deny maintenance period" starts on start_date and
+        #     ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
+        class DenyMaintenancePeriod
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Insights configuration. This specifies when Cloud SQL Insights feature is
+        # enabled and optional configuration.
+        # @!attribute [rw] query_insights_enabled
+        #   @return [::Boolean]
+        #     Whether Query Insights feature is enabled.
+        # @!attribute [rw] record_client_address
+        #   @return [::Boolean]
+        #     Whether Query Insights will record client address when enabled.
+        # @!attribute [rw] record_application_tags
+        #   @return [::Boolean]
+        #     Whether Query Insights will record application tags from query when
+        #     enabled.
+        # @!attribute [rw] query_string_length
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Maximum query length stored in bytes. Default value: 1024 bytes.
+        #     Range: 256-4500 bytes. Query lengths greater than this field value will be
+        #     truncated to this value. When unset, query length will be the default
+        #     value. Changing query length will restart the database.
+        # @!attribute [rw] query_plans_per_minute
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Number of query execution plans captured by Insights per minute
+        #     for all queries combined. Default is 5.
+        # @!attribute [rw] enhanced_query_insights_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. Whether enhanced query insights feature is enabled.
+        class InsightsConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Read-replica configuration specific to MySQL databases.
+        # @!attribute [rw] dump_file_path
+        #   @return [::String]
+        #     Path to a SQL dump file in Google Cloud Storage from which the replica
+        #     instance is to be created. The URI is in the form gs://bucketName/fileName.
+        #     Compressed gzip files (.gz) are also supported.
+        #     Dumps have the binlog co-ordinates from which replication
+        #     begins. This can be accomplished by setting --master-data to 1 when using
+        #     mysqldump.
+        # @!attribute [rw] username
+        #   @return [::String]
+        #     The username for the replication connection.
+        # @!attribute [rw] password
+        #   @return [::String]
+        #     The password for the replication connection.
+        # @!attribute [rw] connect_retry_interval
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Seconds to wait between connect retries. MySQL's default is 60 seconds.
+        # @!attribute [rw] master_heartbeat_period
+        #   @return [::Google::Protobuf::Int64Value]
+        #     Interval in milliseconds between replication heartbeats.
+        # @!attribute [rw] ca_certificate
+        #   @return [::String]
+        #     PEM representation of the trusted CA's x509 certificate.
+        # @!attribute [rw] client_certificate
+        #   @return [::String]
+        #     PEM representation of the replica's x509 certificate.
+        # @!attribute [rw] client_key
+        #   @return [::String]
+        #     PEM representation of the replica's private key. The corresponding public
+        #     key is encoded in the client's certificate.
+        # @!attribute [rw] ssl_cipher
+        #   @return [::String]
+        #     A list of permissible ciphers to use for SSL encryption.
+        # @!attribute [rw] verify_server_certificate
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether or not to check the primary instance's Common Name value in the
+        #     certificate that it sends during the SSL handshake.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#mysqlReplicaConfiguration`.
+        class MySqlReplicaConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Disk encryption configuration for an instance.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     Resource name of KMS key for disk encryption
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#diskEncryptionConfiguration`.
+        class DiskEncryptionConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Disk encryption status for an instance.
+        # @!attribute [rw] kms_key_version_name
+        #   @return [::String]
+        #     KMS key version used to encrypt the Cloud SQL instance resource
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#diskEncryptionStatus`.
+        class DiskEncryptionStatus
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database instance IP mapping
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::Sql::V1::SqlIpAddressType]
+        #     The type of this IP address. A `PRIMARY` address is a public address that
+        #     can accept incoming connections. A `PRIVATE` address is a private address
+        #     that can accept incoming connections. An `OUTGOING` address is the source
+        #     address of connections originating from the instance, if supported.
+        # @!attribute [rw] ip_address
+        #   @return [::String]
+        #     The IP address assigned.
+        # @!attribute [rw] time_to_retire
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The due time for this IP to be retired in
+        #     [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`. This field is only available when
+        #     the IP is scheduled to be retired.
+        class IpMapping
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The sub operation type based on the operation type.
+        # @!attribute [rw] maintenance_type
+        #   @return [::Google::Cloud::Sql::V1::SqlMaintenanceType]
+        #     The type of maintenance to be performed on the instance.
+        class SqlSubOperationType
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An Operation resource.&nbsp;For successful operations that return an
+        # Operation resource, only the fields relevant to the operation are populated
+        # in the resource.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#operation`.
+        # @!attribute [rw] target_link
+        #   @return [::String]
+        # @!attribute [rw] status
+        #   @return [::Google::Cloud::Sql::V1::Operation::SqlOperationStatus]
+        #     The status of an operation.
+        # @!attribute [rw] user
+        #   @return [::String]
+        #     The email address of the user who initiated this operation.
+        # @!attribute [rw] insert_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time this operation was enqueued in UTC timezone in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time this operation actually started in UTC timezone in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time this operation finished in UTC timezone in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`.
+        # @!attribute [rw] error
+        #   @return [::Google::Cloud::Sql::V1::OperationErrors]
+        #     If errors occurred during processing of this operation, this field will be
+        #     populated.
+        # @!attribute [rw] api_warning
+        #   @return [::Google::Cloud::Sql::V1::ApiWarning]
+        #     An Admin API warning message.
+        # @!attribute [rw] operation_type
+        #   @return [::Google::Cloud::Sql::V1::Operation::SqlOperationType]
+        #     The type of the operation. Valid values are:
+        #     *  `CREATE`
+        #     *  `DELETE`
+        #     *  `UPDATE`
+        #     *  `RESTART`
+        #     *  `IMPORT`
+        #     *  `EXPORT`
+        #     *  `BACKUP_VOLUME`
+        #     *  `RESTORE_VOLUME`
+        #     *  `CREATE_USER`
+        #     *  `DELETE_USER`
+        #     *  `CREATE_DATABASE`
+        #     *  `DELETE_DATABASE`
+        # @!attribute [rw] import_context
+        #   @return [::Google::Cloud::Sql::V1::ImportContext]
+        #     The context for import operation, if applicable.
+        # @!attribute [rw] export_context
+        #   @return [::Google::Cloud::Sql::V1::ExportContext]
+        #     The context for export operation, if applicable.
+        # @!attribute [rw] backup_context
+        #   @return [::Google::Cloud::Sql::V1::BackupContext]
+        #     The context for backup operation, if applicable.
+        # @!attribute [rw] pre_check_major_version_upgrade_context
+        #   @return [::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext]
+        #     This field is only populated when the operation_type is
+        #     PRE_CHECK_MAJOR_VERSION_UPGRADE.
+        #     The PreCheckMajorVersionUpgradeContext message itself contains the details
+        #     for that pre-check, such as the target database version for the upgrade
+        #     and the results of the check (including any warnings or errors found).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     An identifier that uniquely identifies the operation. You can use this
+        #     identifier to retrieve the Operations resource that has information about
+        #     the operation.
+        # @!attribute [rw] target_id
+        #   @return [::String]
+        #     Name of the resource on which this operation runs.
+        # @!attribute [rw] self_link
+        #   @return [::String]
+        #     The URI of this resource.
+        # @!attribute [rw] target_project
+        #   @return [::String]
+        #     The project ID of the target instance related to this operation.
+        # @!attribute [rw] acquire_ssrs_lease_context
+        #   @return [::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext]
+        #     The context for acquire SSRS lease operation, if applicable.
+        # @!attribute [rw] sub_operation_type
+        #   @return [::Google::Cloud::Sql::V1::SqlSubOperationType]
+        #     Optional. The sub operation based on the operation type.
+        class Operation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of Cloud SQL operation.
+          module SqlOperationType
+            # Unknown operation type.
+            SQL_OPERATION_TYPE_UNSPECIFIED = 0
+
+            # Imports data into a Cloud SQL instance.
+            IMPORT = 1
+
+            # Exports data from a Cloud SQL instance to a Cloud Storage
+            # bucket.
+            EXPORT = 2
+
+            # Creates a new Cloud SQL instance.
+            CREATE = 3
+
+            # Updates the settings of a Cloud SQL instance.
+            UPDATE = 4
+
+            # Deletes a Cloud SQL instance.
+            DELETE = 5
+
+            # Restarts the Cloud SQL instance.
+            RESTART = 6
+
+            BACKUP = 7
+
+            SNAPSHOT = 8
+
+            # Performs instance backup.
+            BACKUP_VOLUME = 9
+
+            # Deletes an instance backup.
+            DELETE_VOLUME = 10
+
+            # Restores an instance backup.
+            RESTORE_VOLUME = 11
+
+            # Injects a privileged user in mysql for MOB instances.
+            INJECT_USER = 12
+
+            # Clones a Cloud SQL instance.
+            CLONE = 14
+
+            # Stops replication on a Cloud SQL read replica instance.
+            STOP_REPLICA = 15
+
+            # Starts replication on a Cloud SQL read replica instance.
+            START_REPLICA = 16
+
+            # Promotes a Cloud SQL replica instance.
+            PROMOTE_REPLICA = 17
+
+            # Creates a Cloud SQL replica instance.
+            CREATE_REPLICA = 18
+
+            # Creates a new user in a Cloud SQL instance.
+            CREATE_USER = 19
+
+            # Deletes a user from a Cloud SQL instance.
+            DELETE_USER = 20
+
+            # Updates an existing user in a Cloud SQL instance. If a user with the
+            # specified username doesn't exist, a new user is created.
+            UPDATE_USER = 21
+
+            # Creates a database in the Cloud SQL instance.
+            CREATE_DATABASE = 22
+
+            # Deletes a database in the Cloud SQL instance.
+            DELETE_DATABASE = 23
+
+            # Updates a database in the Cloud SQL instance.
+            UPDATE_DATABASE = 24
+
+            # Performs failover of an HA-enabled Cloud SQL
+            # failover replica.
+            FAILOVER = 25
+
+            # Deletes the backup taken by a backup run.
+            DELETE_BACKUP = 26
+
+            RECREATE_REPLICA = 27
+
+            # Truncates a general or slow log table in MySQL.
+            TRUNCATE_LOG = 28
+
+            # Demotes the stand-alone instance to be a Cloud SQL
+            # read replica for an external database server.
+            DEMOTE_MASTER = 29
+
+            # Indicates that the instance is currently in maintenance. Maintenance
+            # typically causes the instance to be unavailable for 1-3 minutes.
+            MAINTENANCE = 30
+
+            # This field is deprecated, and will be removed in future version of API.
+            ENABLE_PRIVATE_IP = 31
+
+            DEFER_MAINTENANCE = 32
+
+            # Creates clone instance.
+            CREATE_CLONE = 33
+
+            # Reschedule maintenance to another time.
+            RESCHEDULE_MAINTENANCE = 34
+
+            # Starts external sync of a Cloud SQL EM replica to an external primary
+            # instance.
+            START_EXTERNAL_SYNC = 35
+
+            # Recovers logs from an instance's old data disk.
+            LOG_CLEANUP = 36
+
+            # Performs auto-restart of an HA-enabled Cloud SQL database for auto
+            # recovery.
+            AUTO_RESTART = 37
+
+            # Re-encrypts CMEK instances with latest key version.
+            REENCRYPT = 38
+
+            # Switches the roles of the primary and replica pair. The target instance
+            # should be the replica.
+            SWITCHOVER = 39
+
+            # Update a backup.
+            UPDATE_BACKUP = 40
+
+            # Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
+            ACQUIRE_SSRS_LEASE = 42
+
+            # Release a lease for the setup of SQL Server Reporting Services (SSRS).
+            RELEASE_SSRS_LEASE = 43
+
+            # Reconfigures old primary after a promote replica operation. Effect of a
+            # promote operation to the old primary is executed in this operation,
+            # asynchronously from the promote replica operation executed to the
+            # replica.
+            RECONFIGURE_OLD_PRIMARY = 44
+
+            # Indicates that the instance, its read replicas, and its cascading
+            # replicas are in maintenance. Maintenance typically gets initiated on
+            # groups of replicas first, followed by the primary instance. For each
+            # instance, maintenance typically causes the instance to be unavailable for
+            # 1-3 minutes.
+            CLUSTER_MAINTENANCE = 45
+
+            # Indicates that the instance (and any of its replicas) are currently in
+            # maintenance. This is initiated as a self-service request by using SSM.
+            # Maintenance typically causes the instance to be unavailable for 1-3
+            # minutes.
+            SELF_SERVICE_MAINTENANCE = 46
+
+            # Switches a primary instance to a replica. This operation runs as part of
+            # a switchover operation to the original primary instance.
+            SWITCHOVER_TO_REPLICA = 47
+
+            # Updates the major version of a Cloud SQL instance.
+            MAJOR_VERSION_UPGRADE = 48
+
+            # Deprecated: ADVANCED_BACKUP is deprecated. Use ENHANCED_BACKUP instead.
+            ADVANCED_BACKUP = 49
+
+            # Changes the BackupTier of a Cloud SQL instance.
+            MANAGE_BACKUP = 50
+
+            # Creates a backup for an Enhanced BackupTier Cloud SQL instance.
+            ENHANCED_BACKUP = 51
+
+            # Repairs entire read pool or specified read pool nodes in the read pool.
+            REPAIR_READ_POOL = 52
+
+            # Creates a Cloud SQL read pool instance.
+            CREATE_READ_POOL = 53
+
+            # Pre-checks the major version upgrade operation.
+            PRE_CHECK_MAJOR_VERSION_UPGRADE = 54
+
+            # This operation type represents individual steps in a multi-step setup
+            # migration workflow: including configuration, replication,
+            # switchover/back, and data reseeding, as defined by operation's intent.
+            SETUP_MIGRATION = 55
+          end
+
+          # The status of an operation.
+          module SqlOperationStatus
+            # The state of the operation is unknown.
+            SQL_OPERATION_STATUS_UNSPECIFIED = 0
+
+            # The operation has been queued, but has not started yet.
+            PENDING = 1
+
+            # The operation is running.
+            RUNNING = 2
+
+            # The operation completed.
+            DONE = 3
+          end
+        end
+
+        # Database instance operation error.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#operationError`.
+        # @!attribute [rw] code
+        #   @return [::String]
+        #     Identifies the specific error that occurred.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     Additional information about the error encountered.
+        class OperationError
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database instance operation errors list wrapper.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#operationErrors`.
+        # @!attribute [rw] errors
+        #   @return [::Array<::Google::Cloud::Sql::V1::OperationError>]
+        #     The list of errors encountered while processing this operation.
+        class OperationErrors
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] min_length
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Minimum number of characters allowed.
+        # @!attribute [rw] complexity
+        #   @return [::Google::Cloud::Sql::V1::PasswordValidationPolicy::Complexity]
+        #     The complexity of the password.
+        # @!attribute [rw] reuse_interval
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Number of previous passwords that cannot be reused.
+        # @!attribute [rw] disallow_username_substring
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Disallow username as a part of the password.
+        # @!attribute [rw] password_change_interval
+        #   @return [::Google::Protobuf::Duration]
+        #     Minimum interval after which the password can be changed. This flag is only
+        #     supported for PostgreSQL.
+        # @!attribute [rw] enable_password_policy
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether to enable the password policy or not. When enabled, passwords must
+        #     meet complexity requirements. Keep this policy enabled to help prevent
+        #     unauthorized access. Disabling this policy allows weak passwords.
+        # @!attribute [rw] disallow_compromised_credentials
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Protobuf::BoolValue]
+        #     This field is deprecated and will be removed in a future version of the
+        #     API.
+        class PasswordValidationPolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The complexity choices of the password.
+          module Complexity
+            # Complexity check is not specified.
+            COMPLEXITY_UNSPECIFIED = 0
+
+            # A combination of lowercase, uppercase, numeric, and non-alphanumeric
+            # characters.
+            COMPLEXITY_DEFAULT = 1
+          end
+        end
+
+        # Data cache configurations.
+        # @!attribute [rw] data_cache_enabled
+        #   @return [::Boolean]
+        #     Whether data cache is enabled for the instance.
+        class DataCacheConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Config used to determine the final backup settings for the instance.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Whether the final backup is enabled for the instance.
+        # @!attribute [rw] retention_days
+        #   @return [::Integer]
+        #     The number of days to retain the final backup after the instance deletion.
+        #     The final backup will be purged at (time_of_instance_deletion +
+        #     retention_days).
+        class FinalBackupConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database instance settings.
+        # @!attribute [rw] settings_version
+        #   @return [::Google::Protobuf::Int64Value]
+        #     The version of instance settings. This is a required field for update
+        #     method to make sure concurrent updates are handled properly. During update,
+        #     use the most recent settingsVersion value for this instance and do not try
+        #     to update this value.
+        # @!attribute [rw] authorized_gae_applications
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Array<::String>]
+        #     The App Engine app IDs that can access this instance.
+        #     (Deprecated) Applied to First Generation instances only.
+        # @!attribute [rw] tier
+        #   @return [::String]
+        #     The tier (or machine type) for this instance, for example
+        #     `db-custom-1-3840`. WARNING: Changing this restarts the instance.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#settings`.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     User-provided labels, represented as a dictionary where each label is a
+        #     single key value pair.
+        # @!attribute [rw] availability_type
+        #   @return [::Google::Cloud::Sql::V1::SqlAvailabilityType]
+        #     Availability type. Potential values:
+        #     *  `ZONAL`: The instance serves data from only one zone. Outages in that
+        #     zone affect data accessibility.
+        #     *  `REGIONAL`: The instance can serve data from more than one zone in a
+        #     region (it is highly available)./
+        #
+        #     For more information, see [Overview of the High Availability
+        #     Configuration](https://cloud.google.com/sql/docs/mysql/high-availability).
+        # @!attribute [rw] pricing_plan
+        #   @return [::Google::Cloud::Sql::V1::SqlPricingPlan]
+        #     The pricing plan for this instance. This can be either `PER_USE` or
+        #     `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+        # @!attribute [rw] replication_type
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Cloud::Sql::V1::SqlReplicationType]
+        #     The type of replication this instance uses. This can be either
+        #     `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only
+        #     applicable to First Generation instances.
+        # @!attribute [rw] storage_auto_resize_limit
+        #   @return [::Google::Protobuf::Int64Value]
+        #     The maximum size to which storage capacity can be automatically increased.
+        #     The default value is 0, which specifies that there is no limit.
+        # @!attribute [rw] activation_policy
+        #   @return [::Google::Cloud::Sql::V1::Settings::SqlActivationPolicy]
+        #     The activation policy specifies when the instance is activated; it is
+        #     applicable only when the instance state is RUNNABLE. Valid values:
+        #     *  `ALWAYS`: The instance is on, and remains so even in the absence of
+        #     connection requests.
+        #     *  `NEVER`: The instance is off; it is not activated, even if a
+        #     connection request arrives.
+        # @!attribute [rw] ip_configuration
+        #   @return [::Google::Cloud::Sql::V1::IpConfiguration]
+        #     The settings for IP Management. This allows to enable or disable the
+        #     instance IP and manage which external networks can connect to the instance.
+        #     The IPv4 address cannot be disabled for Second Generation instances.
+        # @!attribute [rw] storage_auto_resize
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Configuration to increase storage size automatically. The default value is
+        #     true.
+        # @!attribute [rw] location_preference
+        #   @return [::Google::Cloud::Sql::V1::LocationPreference]
+        #     The location preference settings. This allows the instance to be located as
+        #     near as possible to either an App Engine app or Compute Engine zone for
+        #     better performance. App Engine co-location was only applicable to First
+        #     Generation instances.
+        # @!attribute [rw] database_flags
+        #   @return [::Array<::Google::Cloud::Sql::V1::DatabaseFlags>]
+        #     The database flags passed to the instance at startup.
+        # @!attribute [rw] data_disk_type
+        #   @return [::Google::Cloud::Sql::V1::SqlDataDiskType]
+        #     The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for
+        #     First Generation instances.
+        # @!attribute [rw] maintenance_window
+        #   @return [::Google::Cloud::Sql::V1::MaintenanceWindow]
+        #     The maintenance window for this instance. This specifies when the instance
+        #     can be restarted for maintenance purposes.
+        # @!attribute [rw] backup_configuration
+        #   @return [::Google::Cloud::Sql::V1::BackupConfiguration]
+        #     The daily backup configuration for the instance.
+        # @!attribute [rw] database_replication_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Configuration specific to read replica instances. Indicates whether
+        #     replication is enabled or not. WARNING: Changing this restarts the
+        #     instance.
+        # @!attribute [rw] crash_safe_replication_enabled
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Configuration specific to read replica instances. Indicates whether
+        #     database flags for crash-safe replication are enabled. This property was
+        #     only applicable to First Generation instances.
+        # @!attribute [rw] data_disk_size_gb
+        #   @return [::Google::Protobuf::Int64Value]
+        #     The size of data disk, in GB. The data disk size minimum is 10GB.
+        # @!attribute [rw] active_directory_config
+        #   @return [::Google::Cloud::Sql::V1::SqlActiveDirectoryConfig]
+        #     Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+        # @!attribute [rw] collation
+        #   @return [::String]
+        #     The name of server Instance collation.
+        # @!attribute [rw] deny_maintenance_periods
+        #   @return [::Array<::Google::Cloud::Sql::V1::DenyMaintenancePeriod>]
+        #     Deny maintenance periods
+        # @!attribute [rw] insights_config
+        #   @return [::Google::Cloud::Sql::V1::InsightsConfig]
+        #     Insights configuration, for now relevant only for Postgres.
+        # @!attribute [rw] password_validation_policy
+        #   @return [::Google::Cloud::Sql::V1::PasswordValidationPolicy]
+        #     The local user password validation policy of the instance.
+        # @!attribute [rw] sql_server_audit_config
+        #   @return [::Google::Cloud::Sql::V1::SqlServerAuditConfig]
+        #     SQL Server specific audit configuration.
+        # @!attribute [rw] edition
+        #   @return [::Google::Cloud::Sql::V1::Settings::Edition]
+        #     Optional. The edition type of the Cloud SQL instance.
+        # @!attribute [rw] connector_enforcement
+        #   @return [::Google::Cloud::Sql::V1::Settings::ConnectorEnforcement]
+        #     Specifies if connections must use Cloud SQL connectors.
+        #     Option values include the following: `NOT_REQUIRED` (Cloud SQL instances
+        #     can be connected without Cloud SQL
+        #     Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL
+        #     Connectors).
+        #
+        #     Note that using REQUIRED disables all existing authorized networks. If
+        #     this field is not specified when creating a new instance, NOT_REQUIRED is
+        #     used. If this field is not specified when patching or updating an existing
+        #     instance, it is left unchanged in the instance.
+        # @!attribute [rw] deletion_protection_enabled
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Configuration to protect against accidental instance deletion.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     Server timezone, relevant only for Cloud SQL for SQL Server.
+        # @!attribute [rw] advanced_machine_features
+        #   @return [::Google::Cloud::Sql::V1::AdvancedMachineFeatures]
+        #     Specifies advanced machine configuration for the instances relevant only
+        #     for SQL Server.
+        # @!attribute [rw] data_cache_config
+        #   @return [::Google::Cloud::Sql::V1::DataCacheConfig]
+        #     Configuration for data cache.
+        # @!attribute [rw] replication_lag_max_seconds
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Optional. Configuration value for recreation of replica after certain
+        #     replication lag
+        # @!attribute [rw] enable_google_ml_integration
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. When this parameter is set to true, Cloud SQL instances can
+        #     connect to Vertex AI to pass requests for real-time predictions and
+        #     insights to the AI. The default value is false. This applies only to Cloud
+        #     SQL for MySQL and Cloud SQL for PostgreSQL instances.
+        # @!attribute [rw] enable_dataplex_integration
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. By default, Cloud SQL instances have schema extraction disabled
+        #     for Dataplex. When this parameter is set to true, schema extraction for
+        #     Dataplex on Cloud SQL instances is activated.
+        # @!attribute [rw] retain_backups_on_delete
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. When this parameter is set to true, Cloud SQL retains backups of
+        #     the instance even after the instance is deleted. The ON_DEMAND backup will
+        #     be retained until customer deletes the backup or the project. The AUTOMATED
+        #     backup will be retained based on the backups retention setting.
+        # @!attribute [rw] data_disk_provisioned_iops
+        #   @return [::Integer]
+        #     Optional. Provisioned number of I/O operations per second for the data
+        #     disk. This field is only used for hyperdisk-balanced disk types.
+        # @!attribute [rw] data_disk_provisioned_throughput
+        #   @return [::Integer]
+        #     Optional. Provisioned throughput measured in MiB per second for the data
+        #     disk. This field is only used for hyperdisk-balanced disk types.
+        # @!attribute [rw] connection_pool_config
+        #   @return [::Google::Cloud::Sql::V1::ConnectionPoolConfig]
+        #     Optional. The managed connection pooling configuration for the instance.
+        # @!attribute [rw] final_backup_config
+        #   @return [::Google::Cloud::Sql::V1::FinalBackupConfig]
+        #     Optional. The final backup configuration for the instance.
+        # @!attribute [rw] read_pool_auto_scale_config
+        #   @return [::Google::Cloud::Sql::V1::ReadPoolAutoScaleConfig]
+        #     Optional. The read pool auto-scale configuration for the instance.
+        # @!attribute [rw] accelerated_replica_mode
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Optional. Whether the replica is in accelerated mode. This feature is in
+        #     private preview and requires allowlisting to take effect.
+        # @!attribute [rw] auto_upgrade_enabled
+        #   @return [::Boolean]
+        #     Optional. Cloud SQL for MySQL auto-upgrade configuration. When this
+        #     parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor
+        #     versions. The MySQL version must be 8.0.35 or higher.
+        # @!attribute [rw] entraid_config
+        #   @return [::Google::Cloud::Sql::V1::SqlServerEntraIdConfig]
+        #     Optional. The Microsoft Entra ID configuration for the SQL Server instance.
+        # @!attribute [rw] data_api_access
+        #   @return [::Google::Cloud::Sql::V1::Settings::DataApiAccess]
+        #     This parameter controls whether to allow using ExecuteSql API to connect to
+        #     the instance. Not allowed by default.
+        # @!attribute [rw] performance_capture_config
+        #   @return [::Google::Cloud::Sql::V1::PerformanceCaptureConfig]
+        #     Optional. Configuration for Performance Capture, provides diagnostic
+        #     metrics during high load situations.
+        class Settings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Specifies when the instance is activated.
+          module SqlActivationPolicy
+            # Unknown activation plan.
+            SQL_ACTIVATION_POLICY_UNSPECIFIED = 0
+
+            # The instance is always up and running.
+            ALWAYS = 1
+
+            # The instance never starts.
+            NEVER = 2
+
+            # The instance starts upon receiving requests.
+            ON_DEMAND = 3
+          end
+
+          # The list of Cloud SQL editions available to users.
+          module Edition
+            # The instance did not specify the edition.
+            EDITION_UNSPECIFIED = 0
+
+            # The instance is an enterprise edition.
+            ENTERPRISE = 2
+
+            # The instance is an Enterprise Plus edition.
+            ENTERPRISE_PLUS = 3
+
+            # This instance is a Cloud SQL developer edition instance.
+            DEVELOPER = 5
+          end
+
+          # The options for enforcing Cloud SQL connectors in the instance.
+          module ConnectorEnforcement
+            # The requirement for Cloud SQL connectors is unknown.
+            CONNECTOR_ENFORCEMENT_UNSPECIFIED = 0
+
+            # Do not require Cloud SQL connectors.
+            NOT_REQUIRED = 1
+
+            # Require all connections to use Cloud SQL connectors, including the
+            # Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors.
+            # Note: This disables all existing authorized networks.
+            REQUIRED = 2
+          end
+
+          # ExecuteSql API's access to the instance.
+          module DataApiAccess
+            # Unspecified, effectively the same as `DISALLOW_DATA_API`.
+            DATA_API_ACCESS_UNSPECIFIED = 0
+
+            # Disallow using ExecuteSql API to connect to the instance.
+            DISALLOW_DATA_API = 1
+
+            # Allow using ExecuteSql API to connect to the instance. For private IP
+            # instances, this allows authorized users to access the instance from
+            # the public internet using ExecuteSql API.
+            ALLOW_DATA_API = 2
+          end
+        end
+
+        # Performance capture configuration.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Optional. Enables or disables the performance capture feature.
+        # @!attribute [rw] probing_interval_seconds
+        #   @return [::Integer]
+        #     Optional. Specifies the interval in seconds between consecutive probes that
+        #     check if any trigger condition thresholds have been reached.
+        # @!attribute [rw] probe_threshold
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum number of consecutive probe threshold that
+        #     triggers performance capture.
+        # @!attribute [rw] running_threads_threshold
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum number of MySQL `Threads_running` to
+        #     trigger the performance capture on the primary instance.
+        # @!attribute [rw] seconds_behind_source_threshold
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum number of seconds replica must be lagging
+        #     behind primary instance to trigger the performance capture on replica.
+        # @!attribute [rw] transaction_duration_threshold
+        #   @return [::Integer]
+        #     Optional. Specifies the amount of time in seconds that a transaction needs
+        #     to have been open before the watcher starts recording it.
+        # @!attribute [rw] cpu_utilization_threshold_percent
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum percentage of CPU utilization to trigger
+        #     the performance capture. Valid integers range from `10` to `99`. Enter `0`
+        #     to disable the check.
+        # @!attribute [rw] memory_usage_threshold_percent
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum percentage of memory usage to trigger the
+        #     performance capture.
+        #     Valid integers range from `10` to `99`. Enter `0` to disable the check.
+        # @!attribute [rw] transaction_lock_wait_threshold_count
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum allowed number of transactions in lock wait
+        #     state to trigger the performance capture. Valid integers range from `10` to
+        #     `10000`. Enter `0` to disable the check.
+        # @!attribute [rw] semaphore_wait_threshold_count
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum allowed number of semaphore waits to
+        #     trigger the performance capture. Valid integers range from `10` to `10000`.
+        #     Enter `0` to disable the check.
+        # @!attribute [rw] history_list_length_threshold_count
+        #   @return [::Integer]
+        #     Optional. Specifies the minimum number of undo log entries in the history
+        #     list length to trigger the performance capture. Valid integers range from
+        #     `10000` to `10000000`. Enter `0` to disable the check.
+        # @!attribute [rw] transaction_kill_threshold_seconds
+        #   @return [::Integer]
+        #     Optional. Specifies the amount of time in seconds that a transaction needs
+        #     to have been open before the watcher starts terminating it. Valid integers
+        #     range from `60` to `604800` (7 days). Enter `0` to disable. If enabled
+        #     (i.e., > 0), this value must be greater than or equal to
+        #     `transaction_duration_threshold`. Configurations where
+        #     `0 < transaction_kill_threshold_seconds < transaction_duration_threshold`
+        #     will be rejected.
+        # @!attribute [rw] transaction_kill_excluded_user_hosts
+        #   @return [::Array<::String>]
+        #     Optional. Specifies a customer-defined list of users to exclude from
+        #     transaction termination. Entries can be in the format 'user@host' or just
+        #     'user'. A standalone 'user' implies 'user@%', excluding the user from any
+        #     host. Wildcard '%' is allowed in the host part of the 'user@host' format.
+        #     Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]`
+        # @!attribute [rw] transaction_kill_type
+        #   @return [::Google::Cloud::Sql::V1::PerformanceCaptureConfig::TransactionKillType]
+        #     Optional. Determines which transactions are allowed to be terminated when
+        #     they exceed `transaction_kill_threshold_seconds`. This allows protecting
+        #     write-heavy transactions from auto-termination if desired. Defaults to
+        #     `READ_ONLY_TRANSACTIONS` if unspecified.
+        class PerformanceCaptureConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines the categories of long-running transactions eligible for automatic
+          # termination by the Performance Capture.
+          module TransactionKillType
+            # Unspecified.
+            TRANSACTION_KILL_TYPE_UNSPECIFIED = 0
+
+            # Only read-only transactions are eligible for termination.
+            READ_ONLY_TRANSACTIONS = 1
+
+            # All transactions are eligible for termination, including those with write
+            # operations (such as INSERT, UPDATE, DELETE, or DDL).
+            ALL_TRANSACTIONS = 2
+          end
+        end
+
+        # Connection pool flags for Cloud SQL instances managed connection pool
+        # configuration.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the flag.
+        # @!attribute [rw] value
+        #   @return [::String]
+        #     Required. The value of the flag. Boolean flags are set to `on` for true
+        #     and `off` for false. This field must be omitted if the flag
+        #     doesn't take a value.
+        class ConnectionPoolFlags
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The managed connection pooling configuration.
+        # @!attribute [rw] connection_pooling_enabled
+        #   @return [::Boolean]
+        #     Whether managed connection pooling is enabled.
+        # @!attribute [rw] flags
+        #   @return [::Array<::Google::Cloud::Sql::V1::ConnectionPoolFlags>]
+        #     Optional. List of connection pool configuration flags.
+        # @!attribute [r] pooler_count
+        #   @return [::Integer]
+        #     Output only. Number of connection poolers.
+        class ConnectionPoolConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The read pool auto-scale configuration.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Indicates whether read pool auto scaling is enabled.
+        # @!attribute [rw] min_node_count
+        #   @return [::Integer]
+        #     Minimum number of read pool nodes to be maintained.
+        # @!attribute [rw] max_node_count
+        #   @return [::Integer]
+        #     Maximum number of read pool nodes to be maintained.
+        # @!attribute [rw] target_metrics
+        #   @return [::Array<::Google::Cloud::Sql::V1::ReadPoolAutoScaleConfig::TargetMetric>]
+        #     Optional. Target metrics for read pool auto scaling.
+        # @!attribute [rw] disable_scale_in
+        #   @return [::Boolean]
+        #     Indicates whether read pool auto scaling supports scale in operations
+        #     (removing nodes).
+        # @!attribute [rw] scale_in_cooldown_seconds
+        #   @return [::Integer]
+        #     The cooldown period for scale-in operations.
+        # @!attribute [rw] scale_out_cooldown_seconds
+        #   @return [::Integer]
+        #     The cooldown period for scale-out operations.
+        class ReadPoolAutoScaleConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Target metric for read pool auto scaling.
+          # @!attribute [rw] metric
+          #   @return [::String]
+          #     The metric name to be used for auto scaling.
+          # @!attribute [rw] target_value
+          #   @return [::Float]
+          #     The target value for the metric.
+          class TargetMetric
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Specifies options for controlling advanced machine features.
+        # @!attribute [rw] threads_per_core
+        #   @return [::Integer]
+        #     The number of threads per physical core.
+        class AdvancedMachineFeatures
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # SslCerts Resource
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#sslCert`.
+        # @!attribute [rw] cert_serial_number
+        #   @return [::String]
+        #     Serial number, as extracted from the certificate.
+        # @!attribute [rw] cert
+        #   @return [::String]
+        #     PEM representation.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when the certificate was created in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`
+        # @!attribute [rw] common_name
+        #   @return [::String]
+        #     User supplied name.  Constrained to [a-zA-Z.-_ ]+.
+        # @!attribute [rw] expiration_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when the certificate expires in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2012-11-15T16:19:00.094Z`.
+        # @!attribute [rw] sha1_fingerprint
+        #   @return [::String]
+        #     Sha1 Fingerprint.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Name of the database instance.
+        # @!attribute [rw] self_link
+        #   @return [::String]
+        #     The URI of this resource.
+        class SslCert
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # SslCertDetail.
+        # @!attribute [rw] cert_info
+        #   @return [::Google::Cloud::Sql::V1::SslCert]
+        #     The public information about the cert.
+        # @!attribute [rw] cert_private_key
+        #   @return [::String]
+        #     The private key for the client cert, in pem format.  Keep private in order
+        #     to protect your security.
+        class SslCertDetail
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always sql#activeDirectoryConfig.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     The name of the domain (e.g., mydomain.com).
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::Sql::V1::SqlActiveDirectoryConfig::ActiveDirectoryMode]
+        #     Optional. The mode of the Active Directory configuration.
+        # @!attribute [rw] dns_servers
+        #   @return [::Array<::String>]
+        #     Optional. Domain controller IPv4 addresses used to bootstrap Active
+        #     Directory.
+        # @!attribute [rw] admin_credential_secret_name
+        #   @return [::String]
+        #     Optional. The secret manager key storing the administrator credential.
+        #     (e.g., projects/\\{project}/secrets/\\{secret}).
+        # @!attribute [rw] organizational_unit
+        #   @return [::String]
+        #     Optional. The organizational unit distinguished name. This is the full
+        #     hierarchical path to the organizational unit.
+        class SqlActiveDirectoryConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The modes of Active Directory configuration.
+          module ActiveDirectoryMode
+            # Unspecified mode. Will default to MANAGED_ACTIVE_DIRECTORY if the mode is
+            # not specified to maintain backward compatibility.
+            ACTIVE_DIRECTORY_MODE_UNSPECIFIED = 0
+
+            # Managed Active Directory mode.
+            MANAGED_ACTIVE_DIRECTORY = 1
+
+            # Deprecated: Use CUSTOMER_MANAGED_ACTIVE_DIRECTORY instead.
+            SELF_MANAGED_ACTIVE_DIRECTORY = 2
+
+            # Customer-managed Active Directory mode.
+            CUSTOMER_MANAGED_ACTIVE_DIRECTORY = 3
+          end
+        end
+
+        # SQL Server specific audit configuration.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always sql#sqlServerAuditConfig
+        # @!attribute [rw] bucket
+        #   @return [::String]
+        #     The name of the destination bucket (e.g., gs://mybucket).
+        # @!attribute [rw] retention_interval
+        #   @return [::Google::Protobuf::Duration]
+        #     How long to keep generated audit files.
+        # @!attribute [rw] upload_interval
+        #   @return [::Google::Protobuf::Duration]
+        #     How often to upload generated audit files.
+        class SqlServerAuditConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # SQL Server Entra ID configuration.
+        # @!attribute [r] kind
+        #   @return [::String]
+        #     Output only. This is always sql#sqlServerEntraIdConfig
+        # @!attribute [rw] tenant_id
+        #   @return [::String]
+        #     Optional. The tenant ID for the Entra ID configuration.
+        # @!attribute [rw] application_id
+        #   @return [::String]
+        #     Optional. The application ID for the Entra ID configuration.
+        class SqlServerEntraIdConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Acquire SSRS lease context.
+        # @!attribute [rw] setup_login
+        #   @return [::String]
+        #     The username to be used as the setup login to connect to the database
+        #     server for SSRS setup.
+        # @!attribute [rw] service_login
+        #   @return [::String]
+        #     The username to be used as the service login to connect to the report
+        #     database for SSRS setup.
+        # @!attribute [rw] report_database
+        #   @return [::String]
+        #     The report database to be used for SSRS setup.
+        # @!attribute [rw] duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Lease duration needed for SSRS setup.
+        class AcquireSsrsLeaseContext
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # DNS metadata.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The DNS name.
+        # @!attribute [r] connection_type
+        #   @return [::Google::Cloud::Sql::V1::DnsNameMapping::ConnectionType]
+        #     Output only. The connection type of the DNS name.
+        # @!attribute [r] dns_scope
+        #   @return [::Google::Cloud::Sql::V1::DnsNameMapping::DnsScope]
+        #     Output only. The scope that the DNS name applies to.
+        # @!attribute [r] record_manager
+        #   @return [::Google::Cloud::Sql::V1::DnsNameMapping::RecordManager]
+        #     Output only. The manager for this DNS record.
+        class DnsNameMapping
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The connection type of the DNS name.
+          # This enum is not frozen, and new values may be added in the future.
+          module ConnectionType
+            # Unknown connection type.
+            CONNECTION_TYPE_UNSPECIFIED = 0
+
+            # Public IP.
+            PUBLIC = 1
+
+            # Private services access (private IP).
+            PRIVATE_SERVICES_ACCESS = 2
+
+            # Private Service Connect.
+            PRIVATE_SERVICE_CONNECT = 3
+          end
+
+          # The scope that the DNS name applies to.
+          module DnsScope
+            # DNS scope not set. This value should not be used.
+            DNS_SCOPE_UNSPECIFIED = 0
+
+            # Indicates an instance-level DNS name.
+            INSTANCE = 1
+
+            # Indicates a cluster-level DNS name.
+            CLUSTER = 2
+          end
+
+          # The system responsible for managing the DNS record.
+          module RecordManager
+            # Record manager not set. This value should not be used.
+            RECORD_MANAGER_UNSPECIFIED = 0
+
+            # The record may be managed by the customer. It is not automatically
+            # managed by Cloud SQL automation.
+            CUSTOMER = 1
+
+            # The record is managed by Cloud SQL, which will create, update,
+            # and delete the DNS records for the zone automatically when
+            # the Cloud SQL database instance is created or updated.
+            CLOUD_SQL_AUTOMATION = 2
+          end
+        end
+
+        module SqlFileType
+          # Unknown file type.
+          SQL_FILE_TYPE_UNSPECIFIED = 0
+
+          # File containing SQL statements.
+          SQL = 1
+
+          # File in CSV format.
+          CSV = 2
+
+          BAK = 4
+
+          # TDE certificate.
+          TDE = 8
+        end
+
+        module BakType
+          # Default type.
+          BAK_TYPE_UNSPECIFIED = 0
+
+          # Full backup.
+          FULL = 1
+
+          # Differential backup.
+          DIFF = 2
+
+          # Transaction Log backup
+          TLOG = 3
+        end
+
+        # The type of maintenance to be performed on the instance.
+        module SqlMaintenanceType
+          # Maintenance type is unspecified.
+          SQL_MAINTENANCE_TYPE_UNSPECIFIED = 0
+
+          # Indicates that a standalone instance is undergoing maintenance. The
+          # instance can be either a primary instance or a replica.
+          INSTANCE_MAINTENANCE = 1
+
+          # Indicates that the primary instance and all of its replicas, including
+          # cascading replicas, are undergoing maintenance. Maintenance is performed on
+          # groups of replicas first, followed by the primary instance.
+          REPLICA_INCLUDED_MAINTENANCE = 2
+
+          # Indicates that the standalone instance is undergoing maintenance, initiated
+          # by self-service. The instance can be either a primary instance or a
+          # replica.
+          INSTANCE_SELF_SERVICE_MAINTENANCE = 3
+
+          # Indicates that the primary instance and all of its replicas are undergoing
+          # maintenance, initiated by self-service. Maintenance is performed on groups
+          # of replicas first, followed by the primary instance.
+          REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE = 4
+        end
+
+        module SqlBackendType
+          # This is an unknown backend type for instance.
+          SQL_BACKEND_TYPE_UNSPECIFIED = 0
+
+          # V1 speckle instance.
+          FIRST_GEN = 1
+
+          # V2 speckle instance.
+          SECOND_GEN = 2
+
+          # On premises instance.
+          EXTERNAL = 3
+        end
+
+        module SqlIpAddressType
+          # This is an unknown IP address type.
+          SQL_IP_ADDRESS_TYPE_UNSPECIFIED = 0
+
+          # IP address the customer is supposed to connect to. Usually this is the
+          # load balancer's IP address
+          PRIMARY = 1
+
+          # Source IP address of the connection a read replica establishes to its
+          # external primary instance. This IP address can be allowlisted by the
+          # customer in case it has a firewall that filters incoming connection to its
+          # on premises primary instance.
+          OUTGOING = 2
+
+          # Private IP used when using private IPs and network peering.
+          PRIVATE = 3
+
+          # V1 IP of a migrated instance. We want the user to
+          # decommission this IP as soon as the migration is complete.
+          # Note: V1 instances with V1 ip addresses will be counted as PRIMARY.
+          MIGRATED_1ST_GEN = 4
+        end
+
+        # The database engine type and version.
+        module SqlDatabaseVersion
+          # This is an unknown database version.
+          SQL_DATABASE_VERSION_UNSPECIFIED = 0
+
+          # The database version is MySQL 5.1.
+          MYSQL_5_1 = 2
+
+          # The database version is MySQL 5.5.
+          MYSQL_5_5 = 3
+
+          # The database version is MySQL 5.6.
+          MYSQL_5_6 = 5
+
+          # The database version is MySQL 5.7.
+          MYSQL_5_7 = 6
+
+          # The database version is MySQL 8.
+          MYSQL_8_0 = 20
+
+          # The database major version is MySQL 8.0 and the minor version is 18.
+          MYSQL_8_0_18 = 41
+
+          # The database major version is MySQL 8.0 and the minor version is 26.
+          MYSQL_8_0_26 = 85
+
+          # The database major version is MySQL 8.0 and the minor version is 27.
+          MYSQL_8_0_27 = 111
+
+          # The database major version is MySQL 8.0 and the minor version is 28.
+          MYSQL_8_0_28 = 132
+
+          # The database major version is MySQL 8.0 and the minor version is 29.
+          MYSQL_8_0_29 = 148
+
+          # The database major version is MySQL 8.0 and the minor version is 30.
+          MYSQL_8_0_30 = 174
+
+          # The database major version is MySQL 8.0 and the minor version is 31.
+          MYSQL_8_0_31 = 197
+
+          # The database major version is MySQL 8.0 and the minor version is 32.
+          MYSQL_8_0_32 = 213
+
+          # The database major version is MySQL 8.0 and the minor version is 33.
+          MYSQL_8_0_33 = 238
+
+          # The database major version is MySQL 8.0 and the minor version is 34.
+          MYSQL_8_0_34 = 239
+
+          # The database major version is MySQL 8.0 and the minor version is 35.
+          MYSQL_8_0_35 = 240
+
+          # The database major version is MySQL 8.0 and the minor version is 36.
+          MYSQL_8_0_36 = 241
+
+          # The database major version is MySQL 8.0 and the minor version is 37.
+          MYSQL_8_0_37 = 355
+
+          # The database major version is MySQL 8.0 and the minor version is 39.
+          MYSQL_8_0_39 = 357
+
+          # The database major version is MySQL 8.0 and the minor version is 40.
+          MYSQL_8_0_40 = 358
+
+          # The database major version is MySQL 8.0 and the minor version is 41.
+          MYSQL_8_0_41 = 488
+
+          # The database major version is MySQL 8.0 and the minor version is 42.
+          MYSQL_8_0_42 = 489
+
+          # The database major version is MySQL 8.0 and the minor version is 43.
+          MYSQL_8_0_43 = 553
+
+          # The database major version is MySQL 8.0 and the minor version is 44.
+          MYSQL_8_0_44 = 554
+
+          # The database major version is MySQL 8.0 and the minor version is 45.
+          MYSQL_8_0_45 = 555
+
+          # The database major version is MySQL 8.0 and the minor version is 46.
+          MYSQL_8_0_46 = 556
+
+          # The database version is MySQL 8.4.
+          MYSQL_8_4 = 398
+
+          # The database version is MySQL 9.7.
+          MYSQL_9_7 = 654
+
+          # The database version is SQL Server 2017 Standard.
+          SQLSERVER_2017_STANDARD = 11
+
+          # The database version is SQL Server 2017 Enterprise.
+          SQLSERVER_2017_ENTERPRISE = 14
+
+          # The database version is SQL Server 2017 Express.
+          SQLSERVER_2017_EXPRESS = 15
+
+          # The database version is SQL Server 2017 Web.
+          SQLSERVER_2017_WEB = 16
+
+          # The database version is PostgreSQL 9.6.
+          POSTGRES_9_6 = 9
+
+          # The database version is PostgreSQL 10.
+          POSTGRES_10 = 18
+
+          # The database version is PostgreSQL 11.
+          POSTGRES_11 = 10
+
+          # The database version is PostgreSQL 12.
+          POSTGRES_12 = 19
+
+          # The database version is PostgreSQL 13.
+          POSTGRES_13 = 23
+
+          # The database version is PostgreSQL 14.
+          POSTGRES_14 = 110
+
+          # The database version is PostgreSQL 15.
+          POSTGRES_15 = 172
+
+          # The database version is PostgreSQL 16.
+          POSTGRES_16 = 272
+
+          # The database version is PostgreSQL 17.
+          POSTGRES_17 = 408
+
+          # The database version is PostgreSQL 18.
+          POSTGRES_18 = 557
+
+          # The database version is PostgreSQL 19.
+          POSTGRES_19 = 684
+
+          # The database version is PostgreSQL 20.
+          POSTGRES_20 = 781
+
+          # The database version is SQL Server 2019 Standard.
+          SQLSERVER_2019_STANDARD = 26
+
+          # The database version is SQL Server 2019 Enterprise.
+          SQLSERVER_2019_ENTERPRISE = 27
+
+          # The database version is SQL Server 2019 Express.
+          SQLSERVER_2019_EXPRESS = 28
+
+          # The database version is SQL Server 2019 Web.
+          SQLSERVER_2019_WEB = 29
+
+          # The database version is SQL Server 2022 Standard.
+          SQLSERVER_2022_STANDARD = 199
+
+          # The database version is SQL Server 2022 Enterprise.
+          SQLSERVER_2022_ENTERPRISE = 200
+
+          # The database version is SQL Server 2022 Express.
+          SQLSERVER_2022_EXPRESS = 201
+
+          # The database version is SQL Server 2022 Web.
+          SQLSERVER_2022_WEB = 202
+
+          # The database version is SQL Server 2025 Standard.
+          SQLSERVER_2025_STANDARD = 549
+
+          # The database version is SQL Server 2025 Enterprise.
+          SQLSERVER_2025_ENTERPRISE = 550
+
+          # The database version is SQL Server 2025 Express.
+          SQLSERVER_2025_EXPRESS = 551
+        end
+
+        # The pricing plan for this instance.
+        module SqlPricingPlan
+          # This is an unknown pricing plan for this instance.
+          SQL_PRICING_PLAN_UNSPECIFIED = 0
+
+          # The instance is billed at a monthly flat rate.
+          PACKAGE = 1
+
+          # The instance is billed per usage.
+          PER_USE = 2
+        end
+
+        module SqlReplicationType
+          # This is an unknown replication type for a Cloud SQL instance.
+          SQL_REPLICATION_TYPE_UNSPECIFIED = 0
+
+          # The synchronous replication mode for First Generation instances. It is the
+          # default value.
+          SYNCHRONOUS = 1
+
+          # The asynchronous replication mode for First Generation instances. It
+          # provides a slight performance gain, but if an outage occurs while this
+          # option is set to asynchronous, you can lose up to a few seconds of updates
+          # to your data.
+          ASYNCHRONOUS = 2
+        end
+
+        # The type of disk that is used for a v2 instance to use.
+        module SqlDataDiskType
+          # This is an unknown data disk type.
+          SQL_DATA_DISK_TYPE_UNSPECIFIED = 0
+
+          # An SSD data disk.
+          PD_SSD = 1
+
+          # An HDD data disk.
+          PD_HDD = 2
+
+          # This field is deprecated and will be removed from a future version of the
+          # API.
+          OBSOLETE_LOCAL_SSD = 3
+
+          # A Hyperdisk Balanced data disk.
+          HYPERDISK_BALANCED = 4
+        end
+
+        # The availability type of the given Cloud SQL instance.
+        module SqlAvailabilityType
+          # This is an unknown Availability type.
+          SQL_AVAILABILITY_TYPE_UNSPECIFIED = 0
+
+          # Zonal available instance.
+          ZONAL = 1
+
+          # Regional available instance.
+          REGIONAL = 2
+        end
+
+        module SqlUpdateTrack
+          # This is an unknown maintenance timing preference.
+          SQL_UPDATE_TRACK_UNSPECIFIED = 0
+
+          # For an instance with a scheduled maintenance window, this maintenance
+          # timing indicates that the maintenance update is scheduled 7 to 14 days
+          # after the notification is sent out. Also referred to as `Week 1` (Console)
+          # and `preview` (gcloud CLI).
+
+          # For an instance with a scheduled maintenance window, this maintenance
+          # timing indicates that the maintenance update is scheduled 15 to 21 days
+          # after the notification is sent out. Also referred to as `Week 2` (Console)
+          # and `production` (gcloud CLI).
+
+          # For instance with a scheduled maintenance window, this maintenance
+          # timing indicates that the maintenance update is scheduled 35 to 42 days
+          # after the notification is sent out.
+          3
+        end
+
+        # The status of automated DNS provisioning.
+        module AutoDnsStatus
+          # Unspecified status. This means status is missing from dependency service.
+          AUTO_DNS_STATUS_UNSPECIFIED = 0
+
+          # DNS provisioning is OK.
+          AUTO_DNS_OK = 1
+
+          # DNS provisioning failed.
+          AUTO_DNS_FAILED = 2
+
+          # DNS provisioning status is not recognized by Cloud SQL.
+          AUTO_DNS_UNKNOWN = 3
+        end
+      end
+    end
+  end
+end