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

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

@@ -0,0 +1,259 @@
+# 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
+        # The request payload to create the backup
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this backup is created.
+        #     Format: projects/\\{project}
+        # @!attribute [rw] backup
+        #   @return [::Google::Cloud::Sql::V1::Backup]
+        #     Required. The Backup to create.
+        class CreateBackupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request payload to get the backup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the backup to retrieve.
+        #     Format: projects/\\{project}/backups/\\{backup}
+        class GetBackupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request payload to list the backups.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent that owns this collection of backups.
+        #     Format: projects/\\{project}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of backups to return per response. The service might
+        #     return fewer backups than this value. If a value for this parameter isn't
+        #     specified, then, at most, 500 backups are returned. The maximum value is
+        #     2,000. Any values that you set, which are greater than 2,000, are changed
+        #     to 2,000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListBackups` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListBackups` must match
+        #     the call that provided the page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Multiple filter queries are separated by spaces. For example,
+        #     'instance:abc AND type:FINAL, 'location:us',
+        #     'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by
+        #     type, instance, backupInterval.startTime (creation time), or location.
+        class ListBackupsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response payload containing a list of the backups.
+        # @!attribute [rw] backups
+        #   @return [::Array<::Google::Cloud::Sql::V1::Backup>]
+        #     A list of backups.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, then there aren't subsequent pages.
+        # @!attribute [rw] warnings
+        #   @return [::Array<::Google::Cloud::Sql::V1::ApiWarning>]
+        #     If a region isn't unavailable or if an unknown error occurs, then a warning
+        #     message is returned.
+        class ListBackupsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request payload to update the backup.
+        # @!attribute [rw] backup
+        #   @return [::Google::Cloud::Sql::V1::Backup]
+        #     Required. The backup to update.
+        #     The backup’s `name` field is used to identify the backup to update.
+        #     Format: projects/\\{project}/backups/\\{backup}
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The list of fields that you can update. You can update only the description
+        #     and retention period of the final backup.
+        class UpdateBackupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request payload to delete the backup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the backup to delete.
+        #     Format: projects/\\{project}/backups/\\{backup}
+        class DeleteBackupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A backup resource.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the backup.
+        #     Format: projects/\\{project}/backups/\\{backup}.
+        # @!attribute [r] kind
+        #   @return [::String]
+        #     Output only. This is always `sql#backup`.
+        # @!attribute [r] self_link
+        #   @return [::String]
+        #     Output only. The URI of this resource.
+        # @!attribute [r] type
+        #   @return [::Google::Cloud::Sql::V1::Backup::SqlBackupType]
+        #     Output only. The type of this backup. The type can be "AUTOMATED",
+        #     "ON_DEMAND" or “FINAL”.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The description of this backup.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     The name of the source database instance.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     The storage location of the backups. The location can be multi-regional.
+        # @!attribute [r] backup_interval
+        #   @return [::Google::Type::Interval]
+        #     Output only. This output contains the following values:
+        #     start_time: All database writes up to this time are available.
+        #     end_time: Any database writes after this time aren't available.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Sql::V1::Backup::SqlBackupState]
+        #     Output only. The status of this backup.
+        # @!attribute [r] error
+        #   @return [::Google::Cloud::Sql::V1::OperationError]
+        #     Output only. Information about why the backup operation fails (for example,
+        #     when the backup state fails).
+        # @!attribute [r] kms_key
+        #   @return [::String]
+        #     Output only. This output contains the encryption configuration for a backup
+        #     and the resource name of the KMS key for disk encryption.
+        # @!attribute [r] kms_key_version
+        #   @return [::String]
+        #     Output only. This output contains the encryption status for a backup and
+        #     the version of the KMS key that's used to encrypt the Cloud SQL instance.
+        # @!attribute [r] backup_kind
+        #   @return [::Google::Cloud::Sql::V1::SqlBackupKind]
+        #     Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
+        # @!attribute [r] time_zone
+        #   @return [::String]
+        #     Output only. This output contains a backup time zone. If a Cloud SQL for
+        #     SQL Server instance has a different time zone from the backup's time zone,
+        #     then the restore to the instance doesn't happen.
+        # @!attribute [rw] ttl_days
+        #   @return [::Integer]
+        #     Input only. The time-to-live (TTL) interval for this resource (in days).
+        #     For example: ttlDays:7, means 7 days from the current time. The
+        #     expiration time can't exceed 365 days from the time that the backup is
+        #     created.
+        #
+        #     Note: The following fields are mutually exclusive: `ttl_days`, `expiry_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] expiry_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Backup expiration time.
+        #     A UTC timestamp of when this backup expired.
+        #
+        #     Note: The following fields are mutually exclusive: `expiry_time`, `ttl_days`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] database_version
+        #   @return [::Google::Cloud::Sql::V1::SqlDatabaseVersion]
+        #     Output only. The database version of the instance of at the time this
+        #     backup was made.
+        # @!attribute [r] max_chargeable_bytes
+        #   @return [::Integer]
+        #     Output only. The maximum chargeable bytes for the backup.
+        # @!attribute [r] instance_deletion_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Output only. Timestamp in UTC of when the instance associated
+        #     with this backup is deleted.
+        # @!attribute [r] instance_settings
+        #   @return [::Google::Cloud::Sql::V1::DatabaseInstance]
+        #     Optional. Output only. The instance setting of the source instance that's
+        #     associated with this backup.
+        # @!attribute [r] backup_run
+        #   @return [::String]
+        #     Output only. The mapping to backup run resource used for IAM validations.
+        # @!attribute [r] satisfies_pzs
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Output only. This status indicates whether the backup satisfies PZS.
+        #
+        #     The status is reserved for future use.
+        # @!attribute [r] satisfies_pzi
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Output only. This status indicates whether the backup satisfies PZI.
+        #
+        #     The status is reserved for future use.
+        class Backup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The backup type.
+          module SqlBackupType
+            # This is an unknown backup type.
+            SQL_BACKUP_TYPE_UNSPECIFIED = 0
+
+            # The backup schedule triggers a backup automatically.
+            AUTOMATED = 1
+
+            # The user triggers a backup manually.
+            ON_DEMAND = 2
+
+            # The backup created when instance is deleted.
+            FINAL = 3
+          end
+
+          # The backup's state
+          module SqlBackupState
+            # The state of the backup is unknown.
+            SQL_BACKUP_STATE_UNSPECIFIED = 0
+
+            # The backup that's added to a queue.
+            ENQUEUED = 1
+
+            # The backup is in progress.
+            RUNNING = 2
+
+            # The backup failed.
+            FAILED = 3
+
+            # The backup is successful.
+            SUCCESSFUL = 4
+
+            # The backup is being deleted.
+            DELETING = 5
+
+            # Deletion of the backup failed.
+            DELETION_FAILED = 6
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,190 @@
+# 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
+        # Connect settings retrieval request.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Cloud SQL instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Optional snapshot read timestamp to trade freshness for
+        #     performance.
+        class GetConnectSettingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Connect settings retrieval response.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#connectSettings`.
+        # @!attribute [rw] server_ca_cert
+        #   @return [::Google::Cloud::Sql::V1::SslCert]
+        #     SSL configuration.
+        # @!attribute [rw] ip_addresses
+        #   @return [::Array<::Google::Cloud::Sql::V1::IpMapping>]
+        #     The assigned IP addresses for the instance.
+        # @!attribute [rw] region
+        #   @return [::String]
+        #     The cloud region for the instance. For example, `us-central1`,
+        #     `europe-west1`. The region cannot be changed after instance creation.
+        # @!attribute [rw] database_version
+        #   @return [::Google::Cloud::Sql::V1::SqlDatabaseVersion]
+        #     The database engine type and version. The `databaseVersion`
+        #     field cannot be changed after instance creation.
+        #       MySQL instances: `MYSQL_8_0`, `MYSQL_5_7` (default),
+        #     or `MYSQL_5_6`.
+        #       PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`,
+        #     `POSTGRES_11`, `POSTGRES_12` (default), `POSTGRES_13`, or `POSTGRES_14`.
+        #       SQL Server instances: `SQLSERVER_2017_STANDARD` (default),
+        #     `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`,
+        #     `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`,
+        #     `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or
+        #     `SQLSERVER_2019_WEB`.
+        # @!attribute [rw] backend_type
+        #   @return [::Google::Cloud::Sql::V1::SqlBackendType]
+        #     `SECOND_GEN`: Cloud SQL database instance.
+        #     `EXTERNAL`: A database server that is not managed by Google.
+        #     This property is read-only; use the `tier` property in the `settings`
+        #     object to determine the database type.
+        # @!attribute [rw] psc_enabled
+        #   @return [::Boolean]
+        #     Whether PSC connectivity is enabled for this instance.
+        # @!attribute [rw] dns_name
+        #   @return [::String]
+        #     The dns name of the instance.
+        # @!attribute [rw] server_ca_mode
+        #   @return [::Google::Cloud::Sql::V1::ConnectSettings::CaMode]
+        #     Specify what type of CA is used for the server certificate.
+        # @!attribute [rw] custom_subject_alternative_names
+        #   @return [::Array<::String>]
+        #     Custom subject alternative names for the server certificate.
+        # @!attribute [r] dns_names
+        #   @return [::Array<::Google::Cloud::Sql::V1::DnsNameMapping>]
+        #     Output only. The list of DNS names used by this instance.
+        # @!attribute [rw] node_count
+        #   @return [::Integer]
+        #     The number of read pool nodes in a read pool.
+        # @!attribute [r] nodes
+        #   @return [::Array<::Google::Cloud::Sql::V1::ConnectSettings::ConnectPoolNodeConfig>]
+        #     Output only. Entries containing information about each read pool node of
+        #     the read pool.
+        # @!attribute [r] mdx_protocol_support
+        #   @return [::Array<::Google::Cloud::Sql::V1::ConnectSettings::MdxProtocolSupport>]
+        #     Optional. Output only. mdx_protocol_support controls how the client uses
+        #     metadata exchange when connecting to the instance. The values in the list
+        #     representing parts of the MDX protocol that are supported by this instance.
+        #     When the list is empty, the instance does not support MDX, so the client
+        #     must not send an MDX request. The default is empty.
+        class ConnectSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Details of a single read pool node of a read pool.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The name of the read pool node. Doesn't include the project
+          #     ID.
+          # @!attribute [r] ip_addresses
+          #   @return [::Array<::Google::Cloud::Sql::V1::IpMapping>]
+          #     Output only. Mappings containing IP addresses that can be used to connect
+          #     to the read pool node.
+          # @!attribute [r] dns_name
+          #   @return [::String]
+          #     Output only. The DNS name of the read pool node.
+          # @!attribute [r] dns_names
+          #   @return [::Array<::Google::Cloud::Sql::V1::DnsNameMapping>]
+          #     Output only. The list of DNS names used by this read pool node.
+          class ConnectPoolNodeConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Various Certificate Authority (CA) modes for certificate signing.
+          module CaMode
+            # CA mode is unknown.
+            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
+
+          # MdxProtocolSupport describes parts of the MDX protocol supported by this
+          # instance.
+          module MdxProtocolSupport
+            # Not specified.
+            MDX_PROTOCOL_SUPPORT_UNSPECIFIED = 0
+
+            # Client should send the client protocol type in the MDX request.
+            CLIENT_PROTOCOL_TYPE = 1
+          end
+        end
+
+        # Ephemeral certificate creation request.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Cloud SQL instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        # @!attribute [rw] public_key
+        #   @return [::String]
+        #     PEM encoded public key to include in the signed certificate.
+        # @!attribute [rw] access_token
+        #   @return [::String]
+        #     Optional. Access token to include in the signed certificate.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Optional snapshot read timestamp to trade freshness for
+        #     performance.
+        # @!attribute [rw] valid_duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. If set, it will contain the cert valid duration.
+        class GenerateEphemeralCertRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Ephemeral certificate creation request.
+        # @!attribute [rw] ephemeral_cert
+        #   @return [::Google::Cloud::Sql::V1::SslCert]
+        #     Generated cert
+        class GenerateEphemeralCertResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# 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
+        # Database delete request.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Name of the database to be deleted in the instance.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Database instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        class SqlDatabasesDeleteRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database get request.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Name of the database in the instance.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Database instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        class SqlDatabasesGetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database insert request.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Database instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        # @!attribute [rw] body
+        #   @return [::Google::Cloud::Sql::V1::Database]
+        class SqlDatabasesInsertRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database list request.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Cloud SQL instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        class SqlDatabasesListRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database update request.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Name of the database to be updated in the instance.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Database instance ID. This does not include the project ID.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Project ID of the project that contains the instance.
+        # @!attribute [rw] body
+        #   @return [::Google::Cloud::Sql::V1::Database]
+        class SqlDatabasesUpdateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Database list response.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     This is always `sql#databasesList`.
+        # @!attribute [rw] items
+        #   @return [::Array<::Google::Cloud::Sql::V1::Database>]
+        #     List of database resources in the instance.
+        class DatabasesListResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end