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

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

@@ -0,0 +1,207 @@
+# 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 V1beta4
+        # 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 request.
+        # @!attribute [rw] dns_name
+        #   @return [::String]
+        #     Required. Cloud SQL instance ID. This does not include the project ID.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     Required. The region of the instance.
+        class ResolveConnectSettingsRequest
+          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::V1beta4::SslCert]
+        #     SSL configuration.
+        # @!attribute [rw] ip_addresses
+        #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
+        #     The assigned IP addresses for the instance.
+        # @!attribute [rw] region
+        #   @return [::String]
+        #     The cloud region for the instance. e.g. `us-central1`, `europe-west1`.
+        #     The region cannot be changed after instance creation.
+        # @!attribute [rw] database_version
+        #   @return [::Google::Cloud::Sql::V1beta4::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` or `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::V1beta4::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::V1beta4::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::V1beta4::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::V1beta4::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::V1beta4::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.
+        # @!attribute [r] connection_name
+        #   @return [::String]
+        #     Optional. Output only. Connection name of the Cloud SQL instance used in
+        #     connection strings, in the format project:region:instance.
+        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::V1beta4::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::V1beta4::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 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
+
+          # 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::V1beta4::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/v1beta4/cloud_sql_data.rb

@@ -0,0 +1,189 @@
+# 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 V1beta4
+        # Message sent from the client to `SqlDataService`.
+        # @!attribute [rw] ack
+        #   @return [::Google::Cloud::Sql::V1beta4::Ack]
+        #     Optional. Acknowledges data received by the client.
+        # @!attribute [rw] start_session
+        #   @return [::Google::Cloud::Sql::V1beta4::StartSession]
+        #     Starts a new session. When starting a new session, this is the first
+        #     message the client sends.
+        #
+        #     Note: The following fields are mutually exclusive: `start_session`, `continue_session`, `data`, `terminate_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] continue_session
+        #   @return [::Google::Cloud::Sql::V1beta4::ContinueSession]
+        #     Continues an existing session. When continuing an existing session, this
+        #     is the first message the client sends.
+        #
+        #     Note: The following fields are mutually exclusive: `continue_session`, `start_session`, `data`, `terminate_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] data
+        #   @return [::Google::Cloud::Sql::V1beta4::DataPacket]
+        #     Database data.
+        #
+        #     Note: The following fields are mutually exclusive: `data`, `start_session`, `continue_session`, `terminate_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] terminate_session
+        #   @return [::Google::Cloud::Sql::V1beta4::TerminateSession]
+        #     Terminates the session. This closes the connection to the database.
+        #
+        #     Note: The following fields are mutually exclusive: `terminate_session`, `start_session`, `continue_session`, `data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Optional. Deprecated: Use `StartSession.instance_id` or
+        #     `ContinueSession.instance_id` instead.
+        #     The Cloud SQL instance resource name, for example:
+        #     projects/example-project/instances/example-instance
+        class StreamSqlDataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Start a new session. The client must send this as the first message to the
+        # server to start a new session. The client may immediately send Data messages
+        # without waiting for a reply from the server.
+        # @!attribute [rw] location_id
+        #   @return [::String]
+        #     Required. `location_id` is used to route the
+        #     request to a specific region. Use the same region which was used to create
+        #     the instance. Use the format `locations/{location}`, for example:
+        #     `locations/us-central1`.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Required. The Cloud SQL instance resource name, for example:
+        #     projects/example-project/instances/example-instance
+        # @!attribute [rw] session_id
+        #   @return [::String]
+        #     Optional. The session id, chosen by the client. This should be an
+        #     unguessable string. If the client does not intend to reconnect to this
+        #     session, the client may leave session_id unset.
+        class StartSession
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Reconnects to an existing session. The client must send this as the first
+        # message to the server to reconnect to an existing session. The client may
+        # immediately send Data messages without waiting for a reply from the server.
+        # @!attribute [rw] location_id
+        #   @return [::String]
+        #     Required. `location_id` is used to route the
+        #     request to a specific region. Use the same region which was used to create
+        #     the instance. Use the format `locations/{location}`, for example:
+        #     `locations/us-central1`.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Required. The Cloud SQL instance resource name, for example:
+        #     projects/example-project/instances/example-instance
+        # @!attribute [rw] session_id
+        #   @return [::String]
+        #     Required. The id of the session to reconnect.
+        class ContinueSession
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent from SqlDataService back to the client.
+        # @!attribute [rw] ack
+        #   @return [::Google::Cloud::Sql::V1beta4::Ack]
+        #     Acknowledges data received by the server.
+        # @!attribute [rw] session_metadata
+        #   @return [::Google::Cloud::Sql::V1beta4::SessionMetadata]
+        #     The first message from the server to the client, containing metadata
+        #     about this session.
+        #
+        #     Note: The following fields are mutually exclusive: `session_metadata`, `data`, `terminate_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] data
+        #   @return [::Google::Cloud::Sql::V1beta4::DataPacket]
+        #     Data from the database.
+        #
+        #     Note: The following fields are mutually exclusive: `data`, `session_metadata`, `terminate_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] terminate_session
+        #   @return [::Google::Cloud::Sql::V1beta4::TerminateSession]
+        #     Terminates the session. This indicates that the database connection
+        #     is closed. When the client receives this message, it should not
+        #     attempt to reconnect.
+        #
+        #     Note: The following fields are mutually exclusive: `terminate_session`, `session_metadata`, `data`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class StreamSqlDataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata from the server to the client about the session. The server will
+        # always send this as the first message
+        # @!attribute [rw] supported_features
+        #   @return [::Array<::Google::Cloud::Sql::V1beta4::SqlDataFeature>]
+        #     The features supported by the server for this session. This field is used
+        #     by the client to determine which features are available on the server.
+        #     The features supported by the server for this session.
+        class SessionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contains data being sent or received by the database.
+        # @!attribute [rw] first_byte_offset
+        #   @return [::Integer]
+        #     Optional. The absolute byte offset of the first byte in this payload.
+        #     0 for new connections or resumed connections that hasn't acked any bytes
+        #     from server. Non-zero for resumed connections
+        # @!attribute [rw] data
+        #   @return [::String]
+        #     Required. Raw data being sent or received by the database.
+        class DataPacket
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Acknowledges data received by the client or server.
+        # @!attribute [rw] received_offset
+        #   @return [::Integer]
+        #     Required. The absolute number of bytes processed in the session.
+        class Ack
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Indicates that the session is permanently ended.
+        # @!attribute [rw] status
+        #   @return [::Google::Rpc::Status]
+        #     Required. The session termination status.
+        class TerminateSession
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The session features. The server must send the supported features in its
+        # first message to the client.
+        module SqlDataFeature
+          # The feature is not specified. This value should not be used.
+          SQL_DATA_FEATURE_UNSPECIFIED = 0
+
+          # The server supports reconnecting to the session. If this feature is not
+          # present, the client should not attempt to reconnect to the session.
+          SQL_DATA_FEATURE_RECONNECT = 1
+        end
+      end
+    end
+  end
+end