google-cloud-bigtable-v2 1.12.0 → 1.13.0

data/proto_docs/google/bigtable/v2/session.rb

@@ -0,0 +1,793 @@
+# 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 Bigtable
+      module V2
+        # See GetClientConfiguration() RPC in bigtable.proto. Internal usage only.
+        # @!attribute [rw] instance_name
+        #   @return [::String]
+        #     Required. The unique name of the instance for which the client will target
+        #     with Data API requests.
+        #
+        #     Values are of the form `projects/<project>/instances/<instance>`
+        # @!attribute [rw] app_profile_id
+        #   @return [::String]
+        #     Optional. The name of the AppProfile which will be used by the client when
+        #     sending requests in the Data API.
+        #
+        #     If not specified, the `default` application profile will be used.
+        class GetClientConfigurationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for how to balance vRPCs over sessions. Internal usage only.
+        # @!attribute [rw] least_in_flight
+        #   @return [::Google::Cloud::Bigtable::V2::LoadBalancingOptions::LeastInFlight]
+        #     Note: The following fields are mutually exclusive: `least_in_flight`, `peak_ewma`, `random`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] peak_ewma
+        #   @return [::Google::Cloud::Bigtable::V2::LoadBalancingOptions::PeakEwma]
+        #     Note: The following fields are mutually exclusive: `peak_ewma`, `least_in_flight`, `random`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] random
+        #   @return [::Google::Cloud::Bigtable::V2::LoadBalancingOptions::Random]
+        #     Note: The following fields are mutually exclusive: `random`, `least_in_flight`, `peak_ewma`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class LoadBalancingOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Balances vRPCs over backends, preferring to send new vRPCs to AFEs with the
+          # least number of active vRPCs.
+          # @!attribute [rw] random_subset_size
+          #   @return [::Integer]
+          #     Of all connected AFEs, the size of the random subset to run the algorithm
+          #     on. Zero implies all connected AFEs.
+          class LeastInFlight
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Balances vRPCs over backends, by maintaining a moving average of each AFE's
+          # round-trip time, weighted by the number of outstanding vRPCs, and
+          # distribute traffic to AFEs where that cost function is smallest.
+          #
+          # See:
+          # https://linkerd.io/2016/03/16/beyond-round-robin-load-balancing-for-latency
+          # @!attribute [rw] random_subset_size
+          #   @return [::Integer]
+          #     Of all connected AFEs, the size of the random subset to compare costs
+          #     over. Zero implies all connected AFEs.
+          class PeakEwma
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Balances vRPCs over backends, by randomly selecting a backend.
+          class Random
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Configuration for the Session API. Internal usage only.
+        # @!attribute [rw] session_load
+        #   @return [::Float]
+        #     What share of requests should operate on a session, [0, 1]. The rest
+        #     should operate on the old-style API.
+        # @!attribute [rw] load_balancing_options
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Cloud::Bigtable::V2::LoadBalancingOptions]
+        # @!attribute [rw] channel_configuration
+        #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration::ChannelPoolConfiguration]
+        #     Configuration for the channel pool.
+        # @!attribute [rw] session_pool_configuration
+        #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration::SessionPoolConfiguration]
+        #     Configuration for the session pools.
+        class SessionClientConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for the channel pool.
+          # @!attribute [rw] min_server_count
+          #   @return [::Integer]
+          #     The minimum number of distcint servers to connect to in the channel pool.
+          #     The client will ensure that the channel pool will have at least this many
+          #     distinct servers, but may have multiple channels connected to the same
+          #     server (e.g. the client may have M channels on N machines, where M > N).
+          # @!attribute [rw] max_server_count
+          #   @return [::Integer]
+          #     The maximum number of distinct servers to connect to in the channel pool.
+          #     The client will ensure that the channel pool will have at most this many
+          #     distinct servers.
+          # @!attribute [rw] per_server_session_count
+          #   @return [::Integer]
+          #     Soft maximum for how many sessions are allowed per server. Normally, the
+          #     client will ensure that it does not host more than this count of sessions
+          #     per server, unless there are other limits encountered (e.g. the connected
+          #     servers is already at max_servers).
+          # @!attribute [rw] direct_access_with_fallback
+          #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration::ChannelPoolConfiguration::DirectAccessWithFallback]
+          #     DirectAccess with a fallback to CloudPath.
+          #
+          #     Note: The following fields are mutually exclusive: `direct_access_with_fallback`, `direct_access_only`, `cloud_path_only`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] direct_access_only
+          #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration::ChannelPoolConfiguration::DirectAccessOnly]
+          #     DirectAccess only.
+          #
+          #     Note: The following fields are mutually exclusive: `direct_access_only`, `direct_access_with_fallback`, `cloud_path_only`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          # @!attribute [rw] cloud_path_only
+          #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration::ChannelPoolConfiguration::CloudPathOnly]
+          #     CloudPath only.
+          #
+          #     Note: The following fields are mutually exclusive: `cloud_path_only`, `direct_access_with_fallback`, `direct_access_only`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+          class ChannelPoolConfiguration
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A channel mode which allows DirectAccess with a fallback to CloudPath if
+            # DirectAccess is unavailable.
+            # @!attribute [rw] error_rate_threshold
+            #   @return [::Float]
+            #     The threshold for errors on DirectAccess to trigger CloudPath fallback.
+            #     The error rate is calculated based on a count of vRPCs with errors
+            #     divided by a total count of vRPCs, over a rolling window of the past
+            #     check_interval. If this ratio exceeds this threshold, the fallback to
+            #     CloudPath is triggered. [0, 1].
+            # @!attribute [rw] check_interval
+            #   @return [::Google::Protobuf::Duration]
+            #     The interval to check the error rate over.
+            class DirectAccessWithFallback
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A channel mode which only allows DirectAccess.
+            class DirectAccessOnly
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A channel mode which only allows CloudPath.
+            class CloudPathOnly
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Configuration for the session pools. Session pools are tied to a scope
+          # like a table, an app profile, and a permission.
+          # @!attribute [rw] headroom
+          #   @return [::Float]
+          #     Fraction of idle sessions to keep in order to manage an increase in
+          #     requests-in-flight. For example, a headroom of 0.5 will keep enough
+          #     sessions to deal with a 50% increase in QPS.
+          # @!attribute [rw] min_session_count
+          #   @return [::Integer]
+          #     The minimum number of sessions for a given scope.
+          # @!attribute [rw] max_session_count
+          #   @return [::Integer]
+          #     The maximum number of sessions for a given scope.
+          # @!attribute [rw] new_session_queue_length
+          #   @return [::Integer]
+          #     Number of vRPCs that can be queued per starting session.
+          # @!attribute [rw] new_session_creation_budget
+          #   @return [::Integer]
+          #     How many concurrent session establishments are allowed. The client will
+          #     hold onto a count against this budget whenever it is establishing a new
+          #     session, and release that count once the session is successfully
+          #     established or failed to establish.
+          # @!attribute [rw] new_session_creation_penalty
+          #   @return [::Google::Protobuf::Duration]
+          #     How long to penalize the creation budget for a failed session creation
+          #     attempt.
+          # @!attribute [rw] consecutive_session_failure_threshold
+          #   @return [::Integer]
+          #     A threshold for cancelling all pending vRPCs based on how many
+          #     consecutive session establishment errors have been observed. The client
+          #     will eagerly cancel queued vRPCs after this threshold is met to avoid
+          #     them waiting their entire deadlines before terminating (while waiting for
+          #     any session to establish to actually send the vRPC).
+          # @!attribute [rw] load_balancing_options
+          #   @return [::Google::Cloud::Bigtable::V2::LoadBalancingOptions]
+          #     How to balance vRPC load over connections to AFEs.
+          #     Set only if session_load > 0.
+          class SessionPoolConfiguration
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Server provided instructions for enabling finer grained observability on
+        # the client to help diagnose customer issues. Internal usage only.
+        # @!attribute [rw] debug_tag_level
+        #   @return [::Google::Cloud::Bigtable::V2::TelemetryConfiguration::Level]
+        #     Selector for the debug counters that should be uploaded.
+        class TelemetryConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The level of detail of telemetry to be sent from the client.
+          module Level
+            # Server did not specify a level. Should disable all debug tag counters.
+            LEVEL_UNSPECIFIED = 0
+
+            # Enables all debug tag counter levels.
+            DEBUG = 1
+
+            # Eables all debug tag counters except for DEBUG.
+            INFO = 2
+
+            # Enables all debug tag counters except for DEBUG and INFO.
+            WARN = 3
+
+            # Enables only error debug tag counters.
+            ERROR = 4
+          end
+        end
+
+        # Configuration for the Session API. Internal usage only.
+        # @!attribute [rw] session_configuration
+        #   @return [::Google::Cloud::Bigtable::V2::SessionClientConfiguration]
+        #     The configuration for Bigtable Sessions.
+        # @!attribute [rw] stop_polling
+        #   @return [::Boolean]
+        #     If the client should cease to check for new configurations, e.g. a
+        #     backstop to prevent excessive GetClientConfiguration RPCs.
+        #
+        #     Note: The following fields are mutually exclusive: `stop_polling`, `polling_interval`, `polling_configuration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] polling_interval
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Protobuf::Duration]
+        #     Deprecated, prerfer polling_configuration.
+        #
+        #     A duration describing the time between GetClientConfiguration RPCs.
+        #     Only strictly positive values are permissible.
+        #
+        #     Note: The following fields are mutually exclusive: `polling_interval`, `stop_polling`, `polling_configuration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] polling_configuration
+        #   @return [::Google::Cloud::Bigtable::V2::ClientConfiguration::PollingConfiguration]
+        #     If the client should continue to check for new configurations.
+        #
+        #     Note: The following fields are mutually exclusive: `polling_configuration`, `stop_polling`, `polling_interval`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] telemetry_configuration
+        #   @return [::Google::Cloud::Bigtable::V2::TelemetryConfiguration]
+        #     Configuration for telemetry.
+        class ClientConfiguration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] polling_interval
+          #   @return [::Google::Protobuf::Duration]
+          #     A duration describing the time between GetClientConfiguration RPCs.
+          #     Only strictly positive values are permissible.
+          # @!attribute [rw] validity_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     How long the client should consider the configuration it receives from
+          #     GetClientConfiguration valid for. Once this duration has passed, the
+          #     client should consider the configuration invalid and must either:
+          #       - Get a new configuration from GetClientConfiguration
+          #       - Or if it cannot, use a sane default configuration
+          #
+          #     This duration will be at least as long as the polling interval.
+          # @!attribute [rw] max_rpc_retry_count
+          #   @return [::Integer]
+          #     Number of times the client should retry a failed
+          #     GetClientConfiguration RPC per polling interval before giving up.
+          class PollingConfiguration
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] open_session
+        #   @return [::Google::Cloud::Bigtable::V2::OpenSessionRequest]
+        #     Note: The following fields are mutually exclusive: `open_session`, `close_session`, `virtual_rpc`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] close_session
+        #   @return [::Google::Cloud::Bigtable::V2::CloseSessionRequest]
+        #     Note: The following fields are mutually exclusive: `close_session`, `open_session`, `virtual_rpc`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] virtual_rpc
+        #   @return [::Google::Cloud::Bigtable::V2::VirtualRpcRequest]
+        #     Note: The following fields are mutually exclusive: `virtual_rpc`, `open_session`, `close_session`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class SessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] open_session
+        #   @return [::Google::Cloud::Bigtable::V2::OpenSessionResponse]
+        #     Note: The following fields are mutually exclusive: `open_session`, `virtual_rpc`, `error`, `session_parameters`, `heartbeat`, `go_away`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] virtual_rpc
+        #   @return [::Google::Cloud::Bigtable::V2::VirtualRpcResponse]
+        #     A vRPC can result in either a successful result or an error.
+        #     Error results are separate to allow for multiple vRPC responses,
+        #     e.g. for streaming calls like scans (post-V1). See Flow Control.
+        #
+        #     Note: The following fields are mutually exclusive: `virtual_rpc`, `open_session`, `error`, `session_parameters`, `heartbeat`, `go_away`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] error
+        #   @return [::Google::Cloud::Bigtable::V2::ErrorResponse]
+        #     Note: The following fields are mutually exclusive: `error`, `open_session`, `virtual_rpc`, `session_parameters`, `heartbeat`, `go_away`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] session_parameters
+        #   @return [::Google::Cloud::Bigtable::V2::SessionParametersResponse]
+        #     Note: The following fields are mutually exclusive: `session_parameters`, `open_session`, `virtual_rpc`, `error`, `heartbeat`, `go_away`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] heartbeat
+        #   @return [::Google::Cloud::Bigtable::V2::HeartbeatResponse]
+        #     Note: The following fields are mutually exclusive: `heartbeat`, `open_session`, `virtual_rpc`, `error`, `session_parameters`, `go_away`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] go_away
+        #   @return [::Google::Cloud::Bigtable::V2::GoAwayResponse]
+        #     Note: The following fields are mutually exclusive: `go_away`, `open_session`, `virtual_rpc`, `error`, `session_parameters`, `heartbeat`, `session_refresh_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] session_refresh_config
+        #   @return [::Google::Cloud::Bigtable::V2::SessionRefreshConfig]
+        #     Note: The following fields are mutually exclusive: `session_refresh_config`, `open_session`, `virtual_rpc`, `error`, `session_parameters`, `heartbeat`, `go_away`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class SessionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] protocol_version
+        #   @return [::Integer]
+        #     A version indicator from the client stating its understanding of the
+        #     protocol. This is to disambiguate client behavior amidst changes in
+        #     semantic usage of the API, e.g. if the structure remains the same but
+        #     behavior changes.
+        # @!attribute [rw] flags
+        #   @return [::Google::Cloud::Bigtable::V2::FeatureFlags]
+        #     Client settings, including a record of
+        # @!attribute [rw] consecutive_failed_connection_attempts
+        #   @return [::Integer]
+        #     Used for serverside observability.
+        # @!attribute [rw] routing_cookie
+        #   @return [::String]
+        #     How the request should be routed (if presented as part of a GOAWAY
+        #     from a previous session). Post V1.
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     Can be Open\\{Table,AuthorizedView,MaterializedView}Request,
+        #     (or in post-V1, PrepareSqlQueryRequest)
+        class OpenSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about the connected backends from a session client's
+        # perspective. This information may be used to make choices about session
+        # re-establishment en-masse for sessions with the same backend identifiers.
+        # Internal usage only.
+        # @!attribute [rw] google_frontend_id
+        #   @return [::Integer]
+        #     An opaque identifier for the Google Frontend which serviced this request.
+        #     Only set when not using DirectAccess.
+        # @!attribute [rw] application_frontend_id
+        #   @return [::Integer]
+        #     An opaque identifier for the application frontend which serviced this
+        #     request.
+        # @!attribute [rw] application_frontend_zone
+        #   @return [::String]
+        #     The zone of the application frontend that served this request.
+        class BackendIdentifier
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] backend
+        #   @return [::Google::Cloud::Bigtable::V2::BackendIdentifier]
+        #     Information on the backend(s) that are hosting this session.
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     Can be Open\\{Table,AuthorizedView,MaterializedView}Response,
+        #     (or in post-V1, PrepareSqlQueryResponse)
+        class OpenSessionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] reason
+        #   @return [::Google::Cloud::Bigtable::V2::CloseSessionRequest::CloseSessionReason]
+        # @!attribute [rw] description
+        #   @return [::String]
+        class CloseSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Client-generated reason for terminating the session, including a
+          # plain-text description of why.
+          # 'reason' may be used for metrics, while both may be logged (server-side).
+          module CloseSessionReason
+            CLOSE_SESSION_REASON_UNSET = 0
+
+            CLOSE_SESSION_REASON_GOAWAY = 1
+
+            CLOSE_SESSION_REASON_ERROR = 2
+
+            CLOSE_SESSION_REASON_USER = 3
+
+            CLOSE_SESSION_REASON_DOWNSIZE = 4
+
+            CLOSE_SESSION_REASON_MISSED_HEARTBEAT = 5
+          end
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] table_name
+        #   @return [::String]
+        # @!attribute [rw] app_profile_id
+        #   @return [::String]
+        # @!attribute [rw] permission
+        #   @return [::Google::Cloud::Bigtable::V2::OpenTableRequest::Permission]
+        class OpenTableRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module Permission
+            PERMISSION_UNSET = 0
+
+            PERMISSION_READ = 1
+
+            PERMISSION_WRITE = 2
+
+            PERMISSION_READ_WRITE = 3
+          end
+        end
+
+        # Internal usage only.
+        class OpenTableResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Open sessions for an AuthorizedView. Internal usage only.
+        # @!attribute [rw] authorized_view_name
+        #   @return [::String]
+        #     The Authorized view name to read and write from. Values are of the form
+        #     `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
+        # @!attribute [rw] app_profile_id
+        #   @return [::String]
+        #     The app profile id to use for the authorized view sessions.
+        # @!attribute [rw] permission
+        #   @return [::Google::Cloud::Bigtable::V2::OpenAuthorizedViewRequest::Permission]
+        #     Permission for the session.
+        class OpenAuthorizedViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module Permission
+            PERMISSION_UNSET = 0
+
+            PERMISSION_READ = 1
+
+            PERMISSION_WRITE = 2
+
+            PERMISSION_READ_WRITE = 3
+          end
+        end
+
+        # Internal usage only.
+        class OpenAuthorizedViewResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Open sessions for a MaterializedView. Internal usage only.
+        # @!attribute [rw] materialized_view_name
+        #   @return [::String]
+        #     The Materialized view name to read and write from. Values are of the form
+        #     `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
+        # @!attribute [rw] app_profile_id
+        #   @return [::String]
+        #     The app profile id to use for the materialized view sessions.
+        # @!attribute [rw] permission
+        #   @return [::Google::Cloud::Bigtable::V2::OpenMaterializedViewRequest::Permission]
+        #     Permission for the session.
+        class OpenMaterializedViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          module Permission
+            PERMISSION_UNSET = 0
+
+            PERMISSION_READ = 1
+          end
+        end
+
+        # Internal usage only.
+        class OpenMaterializedViewResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] rpc_id
+        #   @return [::Integer]
+        #     Client chosen, monotonically increasing identifier for the request.
+        #     Must be unique within a session.
+        # @!attribute [rw] deadline
+        #   @return [::Google::Protobuf::Duration]
+        #     Attempt deadline.
+        #
+        #     Note, this may not be needed for V1, TBD (e.g. operation vs attempt
+        #     deadline).
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::Bigtable::V2::VirtualRpcRequest::Metadata]
+        #     vRPC metadata.
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     Could be TableRequest (or in post-V1, SqlRequest)
+        class VirtualRpcRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Container for all vRPC Metadata.
+          # @!attribute [rw] attempt_number
+          #   @return [::Integer]
+          #     Track retry attempts for this vRPC at the AFE.
+          # @!attribute [rw] attempt_start
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Track the client's known start time for the attempt. This is likely not
+          #     easily compared with the server's time due to clock skew.
+          # @!attribute [rw] traceparent
+          #   @return [::String]
+          #     Link OpenTelemetry traces (e.g. Tapper). This can be used to link
+          #     attempts together for the same logical operation (e.g. in logs / traces).
+          #
+          #     Note, this may not be needed for V1, TBD.
+          class Metadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Information on which Cluster served a vRPC, e.g. for Client-Side metrics.
+        # Internal usage only.
+        # @!attribute [rw] cluster_id
+        #   @return [::String]
+        # @!attribute [rw] zone_id
+        #   @return [::String]
+        class ClusterInformation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] backend_latency
+        #   @return [::Google::Protobuf::Duration]
+        #     Backend (critical section) latency for the request.
+        class SessionRequestStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] rpc_id
+        #   @return [::Integer]
+        #     Which vRPC this response is for.
+        # @!attribute [rw] cluster_info
+        #   @return [::Google::Cloud::Bigtable::V2::ClusterInformation]
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Bigtable::V2::SessionRequestStats]
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     Could be TableResponse (or in post-V1, SqlResponse)
+        class VirtualRpcResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] rpc_id
+        #   @return [::Integer]
+        #     Which vRPC this response is for.
+        # @!attribute [rw] cluster_info
+        #   @return [::Google::Cloud::Bigtable::V2::ClusterInformation]
+        # @!attribute [rw] status
+        #   @return [::Google::Rpc::Status]
+        #     The error from the vRPC and any retry information to consider.
+        # @!attribute [rw] retry_info
+        #   @return [::Google::Rpc::RetryInfo]
+        class ErrorResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowRequest]
+        #     Note: The following fields are mutually exclusive: `read_row`, `mutate_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] mutate_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionMutateRowRequest]
+        #     Note: The following fields are mutually exclusive: `mutate_row`, `read_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class TableRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowResponse]
+        #     Note: The following fields are mutually exclusive: `read_row`, `mutate_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] mutate_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionMutateRowResponse]
+        #     Note: The following fields are mutually exclusive: `mutate_row`, `read_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class TableResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request wrapper for operations on an authorized view. Internal usage only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowRequest]
+        #     Note: The following fields are mutually exclusive: `read_row`, `mutate_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] mutate_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionMutateRowRequest]
+        #     Note: The following fields are mutually exclusive: `mutate_row`, `read_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class AuthorizedViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response wrapper for operations on an authorized view. Internal usage only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowResponse]
+        #     Note: The following fields are mutually exclusive: `read_row`, `mutate_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] mutate_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionMutateRowResponse]
+        #     Note: The following fields are mutually exclusive: `mutate_row`, `read_row`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class AuthorizedViewResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request wrapper for operations on a materialized view. Internal usage only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowRequest]
+        class MaterializedViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response wrapper for operations on a materialized view. Internal usage
+        # only.
+        # @!attribute [rw] read_row
+        #   @return [::Google::Cloud::Bigtable::V2::SessionReadRowResponse]
+        class MaterializedViewResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] key
+        #   @return [::String]
+        # @!attribute [rw] filter
+        #   @return [::Google::Cloud::Bigtable::V2::RowFilter]
+        class SessionReadRowRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] row
+        #   @return [::Google::Cloud::Bigtable::V2::Row]
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Bigtable::V2::RequestStats]
+        class SessionReadRowResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] key
+        #   @return [::String]
+        # @!attribute [rw] mutations
+        #   @return [::Array<::Google::Cloud::Bigtable::V2::Mutation>]
+        class SessionMutateRowRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        class SessionMutateRowResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] keep_alive
+        #   @return [::Google::Protobuf::Duration]
+        #     Maximum time between messages that the AFE will send to the client. The
+        #     client may use this information to determine its control-flow in relation
+        #     to pruning black-holed or otherwise non-responsive sessions. Must be set
+        #     and positive.
+        #
+        #     See also Heartbeats.
+        class SessionParametersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        class HeartbeatResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] reason
+        #   @return [::String]
+        #     Server-generated reason for GOAWAY, including a plain-text description of
+        #     why. 'reason' may be used for CSM, while both may be logged.
+        # @!attribute [rw] description
+        #   @return [::String]
+        # @!attribute [rw] last_rpc_id_admitted
+        #   @return [::Integer]
+        #     The last vRPC which was admitted by the AFE. The client may expect the
+        #     result from the vRPC on the stream before disconnecting, and should
+        #     retry vRPCs beyond this boundary.
+        class GoAwayResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Internal usage only.
+        # @!attribute [rw] optimized_open_request
+        #   @return [::Google::Cloud::Bigtable::V2::OpenSessionRequest]
+        #     An optimized Open request that the session may use on a retry when
+        #     establishing this session again. This can be sent from the AFE to
+        #     avoid certain work e.g. encoding a query plan for BTQL.
+        # @!attribute [r] metadata
+        #   @return [::Array<::Google::Cloud::Bigtable::V2::SessionRefreshConfig::Metadata>]
+        #     Output only. Any additional metadata to include when reconnecting.
+        class SessionRefreshConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Any additional metadata to include when reconnecting. Not a `map<>` type as
+          # this can be a multimap.
+          # @!attribute [r] key
+          #   @return [::String]
+          #     Output only. The key for the metadata entry.
+          # @!attribute [r] value
+          #   @return [::String]
+          #     Output only. The value for the metadata entry.
+          class Metadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Supported session types.
+        module SessionType
+          SESSION_TYPE_UNSET = 0
+
+          SESSION_TYPE_TABLE = 1
+
+          SESSION_TYPE_AUTHORIZED_VIEW = 2
+
+          SESSION_TYPE_MATERIALIZED_VIEW = 3
+
+          # For internal protocol testing only.
+          SESSION_TYPE_TEST = 9999
+        end
+      end
+    end
+  end
+end