google-cloud-spanner 1.14.0 → 2.0.0

data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb

@@ -1,29 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Protobuf
-    # A generic empty message that you can re-use to avoid defining duplicated
-    # empty messages in your APIs. A typical example is to use it as the request
-    # or the response type of an API method. For instance:
-    #
-    #     service Foo {
-    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-    #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
-    class Empty; end
-  end
-end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb

@@ -1,39 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Rpc
-    # The `Status` type defines a logical error model that is suitable for
-    # different programming environments, including REST APIs and RPC APIs. It is
-    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
-    # three pieces of data: error code, error message, and error details.
-    #
-    # You can find out more about this error model and how to work with it in the
-    # [API Design Guide](https://cloud.google.com/apis/design/errors).
-    # @!attribute [rw] code
-    #   @return [Integer]
-    #     The status code, which should be an enum value of {Google::Rpc::Code}.
-    # @!attribute [rw] message
-    #   @return [String]
-    #     A developer-facing error message, which should be in English. Any
-    #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized by the client.
-    # @!attribute [rw] details
-    #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There is a common set of
-    #     message types for APIs to use.
-    class Status; end
-  end
-end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb

@@ -1,201 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Spanner
-    module Admin
-      module Database
-        module V1
-          # A Cloud Spanner database.
-          # @!attribute [rw] name
-          #   @return [String]
-          #     Required. The name of the database. Values are of the form
-          #     `projects/<project>/instances/<instance>/databases/<database>`,
-          #     where `<database>` is as specified in the `CREATE DATABASE`
-          #     statement. This name can be passed to other API methods to
-          #     identify the database.
-          # @!attribute [rw] state
-          #   @return [Google::Spanner::Admin::Database::V1::Database::State]
-          #     Output only. The current database state.
-          class Database
-            # Indicates the current state of the database.
-            module State
-              # Not specified.
-              STATE_UNSPECIFIED = 0
-
-              # The database is still being created. Operations on the database may fail
-              # with `FAILED_PRECONDITION` in this state.
-              CREATING = 1
-
-              # The database is fully created and ready for use.
-              READY = 2
-            end
-          end
-
-          # The request for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::ListDatabases ListDatabases}.
-          # @!attribute [rw] parent
-          #   @return [String]
-          #     Required. The instance whose databases should be listed.
-          #     Values are of the form `projects/<project>/instances/<instance>`.
-          # @!attribute [rw] page_size
-          #   @return [Integer]
-          #     Number of databases to be returned in the response. If 0 or less,
-          #     defaults to the server's maximum allowed page size.
-          # @!attribute [rw] page_token
-          #   @return [String]
-          #     If non-empty, `page_token` should contain a
-          #     {Google::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
-          #     from a previous
-          #     {Google::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
-          class ListDatabasesRequest; end
-
-          # The response for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::ListDatabases ListDatabases}.
-          # @!attribute [rw] databases
-          #   @return [Array<Google::Spanner::Admin::Database::V1::Database>]
-          #     Databases that matched the request.
-          # @!attribute [rw] next_page_token
-          #   @return [String]
-          #     `next_page_token` can be sent in a subsequent
-          #     {Google::Spanner::Admin::Database::V1::DatabaseAdmin::ListDatabases ListDatabases}
-          #     call to fetch more of the matching databases.
-          class ListDatabasesResponse; end
-
-          # The request for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::CreateDatabase CreateDatabase}.
-          # @!attribute [rw] parent
-          #   @return [String]
-          #     Required. The name of the instance that will serve the new database.
-          #     Values are of the form `projects/<project>/instances/<instance>`.
-          # @!attribute [rw] create_statement
-          #   @return [String]
-          #     Required. A `CREATE DATABASE` statement, which specifies the ID of the
-          #     new database.  The database ID must conform to the regular expression
-          #     `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
-          #     If the database ID is a reserved word or if it contains a hyphen, the
-          #     database ID must be enclosed in backticks (`` ` ``).
-          # @!attribute [rw] extra_statements
-          #   @return [Array<String>]
-          #     An optional list of DDL statements to run inside the newly created
-          #     database. Statements can create tables, indexes, etc. These
-          #     statements execute atomically with the creation of the database:
-          #     if there is an error in any statement, the database is not created.
-          class CreateDatabaseRequest; end
-
-          # Metadata type for the operation returned by
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::CreateDatabase CreateDatabase}.
-          # @!attribute [rw] database
-          #   @return [String]
-          #     The database being created.
-          class CreateDatabaseMetadata; end
-
-          # The request for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::GetDatabase GetDatabase}.
-          # @!attribute [rw] name
-          #   @return [String]
-          #     Required. The name of the requested database. Values are of the form
-          #     `projects/<project>/instances/<instance>/databases/<database>`.
-          class GetDatabaseRequest; end
-
-          # Enqueues the given DDL statements to be applied, in order but not
-          # necessarily all at once, to the database schema at some point (or
-          # points) in the future. The server checks that the statements
-          # are executable (syntactically valid, name tables that exist, etc.)
-          # before enqueueing them, but they may still fail upon
-          # later execution (e.g., if a statement from another batch of
-          # statements is applied first and it conflicts in some way, or if
-          # there is some data-related problem like a `NULL` value in a column to
-          # which `NOT NULL` would be added). If a statement fails, all
-          # subsequent statements in the batch are automatically cancelled.
-          #
-          # Each batch of statements is assigned a name which can be used with
-          # the {Google::Longrunning::Operations Operations} API to monitor
-          # progress. See the
-          # {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id}
-          # field for more details.
-          # @!attribute [rw] database
-          #   @return [String]
-          #     Required. The database to update.
-          # @!attribute [rw] statements
-          #   @return [Array<String>]
-          #     Required. DDL statements to be applied to the database.
-          # @!attribute [rw] operation_id
-          #   @return [String]
-          #     If empty, the new update request is assigned an
-          #     automatically-generated operation ID. Otherwise, `operation_id`
-          #     is used to construct the name of the resulting
-          #     {Google::Longrunning::Operation Operation}.
-          #
-          #     Specifying an explicit operation ID simplifies determining
-          #     whether the statements were executed in the event that the
-          #     {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl}
-          #     call is replayed, or the return value is otherwise lost: the
-          #     {Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
-          #     and `operation_id` fields can be combined to form the
-          #     {Google::Longrunning::Operation#name name} of the resulting
-          #     {Google::Longrunning::Operation longrunning::Operation}:
-          #     `<database>/operations/<operation_id>`.
-          #
-          #     `operation_id` should be unique within the database, and must be
-          #     a valid identifier: `[a-z][a-z0-9_]*`. Note that
-          #     automatically-generated operation IDs always begin with an
-          #     underscore. If the named operation already exists,
-          #     {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl}
-          #     returns `ALREADY_EXISTS`.
-          class UpdateDatabaseDdlRequest; end
-
-          # Metadata type for the operation returned by
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::UpdateDatabaseDdl UpdateDatabaseDdl}.
-          # @!attribute [rw] database
-          #   @return [String]
-          #     The database being modified.
-          # @!attribute [rw] statements
-          #   @return [Array<String>]
-          #     For an update this list contains all the statements. For an
-          #     individual statement, this list contains only that statement.
-          # @!attribute [rw] commit_timestamps
-          #   @return [Array<Google::Protobuf::Timestamp>]
-          #     Reports the commit timestamps of all statements that have
-          #     succeeded so far, where `commit_timestamps[i]` is the commit
-          #     timestamp for the statement `statements[i]`.
-          class UpdateDatabaseDdlMetadata; end
-
-          # The request for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::DropDatabase DropDatabase}.
-          # @!attribute [rw] database
-          #   @return [String]
-          #     Required. The database to be dropped.
-          class DropDatabaseRequest; end
-
-          # The request for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::GetDatabaseDdl GetDatabaseDdl}.
-          # @!attribute [rw] database
-          #   @return [String]
-          #     Required. The database whose schema we wish to get.
-          class GetDatabaseDdlRequest; end
-
-          # The response for
-          # {Google::Spanner::Admin::Database::V1::DatabaseAdmin::GetDatabaseDdl GetDatabaseDdl}.
-          # @!attribute [rw] statements
-          #   @return [Array<String>]
-          #     A list of formatted DDL statements defining the schema of the database
-          #     specified in the request.
-          class GetDatabaseDdlResponse; end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/type/expr.rb

@@ -1,45 +0,0 @@
-# Copyright 2020 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.
-
-
-module Google
-  module Type
-    # Represents an expression text. Example:
-    #
-    #     title: "User account presence"
-    #     description: "Determines whether the request has a user account"
-    #     expression: "size(request.user) > 0"
-    # @!attribute [rw] expression
-    #   @return [String]
-    #     Textual representation of an expression in
-    #     Common Expression Language syntax.
-    #
-    #     The application context of the containing message determines which
-    #     well-known feature set of CEL is supported.
-    # @!attribute [rw] title
-    #   @return [String]
-    #     An optional title for the expression, i.e. a short string describing
-    #     its purpose. This can be used e.g. in UIs which allow to enter the
-    #     expression.
-    # @!attribute [rw] description
-    #   @return [String]
-    #     An optional description of the expression. This is a longer text which
-    #     describes the expression, e.g. when hovered over it in a UI.
-    # @!attribute [rw] location
-    #   @return [String]
-    #     An optional string indicating the location of the expression for error
-    #     reporting, e.g. a file name and a position in the file.
-    class Expr; end
-  end
-end

data/lib/google/cloud/spanner/admin/instance.rb

@@ -1,164 +0,0 @@
-# Copyright 2020 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.
-
-
-require "google/gax"
-require "pathname"
-
-module Google
-  module Cloud
-    module Spanner
-      module Admin
-        # rubocop:disable LineLength
-
-        ##
-        # # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
-        #
-        # [Cloud Spanner Instance Admin API][Product Documentation]:
-        #
-        # - [Product Documentation][]
-        #
-        # ## Quick Start
-        # In order to use this library, you first need to go through the following
-        # steps:
-        #
-        # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-        # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-        # 3. [Enable the Cloud Spanner Instance Admin API.](https://console.cloud.google.com/apis/library/spanner.googleapis.com)
-        # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-spanner/latest/file.AUTHENTICATION.html)
-        #
-        # ### Installation
-        # ```
-        # $ gem install google-cloud-spanner
-        # ```
-        #
-        # ### Next Steps
-        # - Read the [Cloud Spanner Instance Admin API Product documentation][Product Documentation]
-        #   to learn more about the product and see How-to Guides.
-        # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-        #   to see the full list of Cloud APIs that we cover.
-        #
-        # [Product Documentation]: https://cloud.google.com/spanner
-        #
-        # ## Enabling Logging
-        #
-        # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-        # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-        # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-        # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-        # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-        #
-        # Configuring a Ruby stdlib logger:
-        #
-        # ```ruby
-        # require "logger"
-        #
-        # module MyLogger
-        #   LOGGER = Logger.new $stderr, level: Logger::WARN
-        #   def logger
-        #     LOGGER
-        #   end
-        # end
-        #
-        # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-        # module GRPC
-        #   extend MyLogger
-        # end
-        # ```
-        #
-        module Instance
-          # rubocop:enable LineLength
-
-          FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("instance"))
-
-          AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-            .select { |file| File.directory?(file) }
-            .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
-            .select { |dir| File.exist?(dir + ".rb") }
-            .map { |dir| File.basename(dir) }
-
-          ##
-          # Cloud Spanner Instance Admin API
-          #
-          # The Cloud Spanner Instance Admin API can be used to create, delete,
-          # modify and list instances. Instances are dedicated Cloud Spanner serving
-          # and storage resources to be used by Cloud Spanner databases.
-          #
-          # Each instance has a "configuration", which dictates where the
-          # serving resources for the Cloud Spanner instance are located (e.g.,
-          # US-central, Europe). Configurations are created by Google based on
-          # resource availability.
-          #
-          # Cloud Spanner billing is based on the instances that exist and their
-          # sizes. After an instance exists, there are no additional
-          # per-database or per-operation charges for use of the instance
-          # (though there may be additional network bandwidth charges).
-          # Instances offer isolation: problems with databases in one instance
-          # will not affect other instances. However, within an instance
-          # databases can affect each other. For example, if one database in an
-          # instance receives a lot of requests and consumes most of the
-          # instance resources, fewer resources are available for other
-          # databases in that instance, and their performance may suffer.
-          #
-          # @param version [Symbol, String]
-          #   The major version of the service to be used. By default :v1
-          #   is used.
-          # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
-          #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-          #     Provides the means for authenticating requests made by the client. This parameter can
-          #     be many types.
-          #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
-          #     authenticating requests made by this client.
-          #     A `String` will be treated as the path to the keyfile to be used for the construction of
-          #     credentials for this client.
-          #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-          #     credentials for this client.
-          #     A `GRPC::Core::Channel` will be used to make calls through.
-          #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-          #     should already be composed with a `GRPC::Core::CallCredentials` object.
-          #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-          #     metadata for requests, generally, to give OAuth credentials.
-          #   @param scopes [Array<String>]
-          #     The OAuth scopes for this service. This parameter is ignored if
-          #     an updater_proc is supplied.
-          #   @param client_config [Hash]
-          #     A Hash for call options for each method. See
-          #     Google::Gax#construct_settings for the structure of
-          #     this data. Falls back to the default config if not specified
-          #     or the specified config is missing data points.
-          #   @param timeout [Numeric]
-          #     The default timeout, in seconds, for calls made through this client.
-          #   @param metadata [Hash]
-          #     Default metadata to be sent with each request. This can be overridden on a per call basis.
-          #   @param exception_transformer [Proc]
-          #     An optional proc that intercepts any exceptions raised during an API call to inject
-          #     custom error handling.
-          def self.new(*args, version: :v1, **kwargs)
-            unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
-              raise "The version: #{version} is not available. The available versions " \
-                "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
-            end
-
-            require "#{FILE_DIR}/#{version.to_s.downcase}"
-            version_module = Google::Cloud::Spanner::Admin::Instance
-              .constants
-              .select {|sym| sym.to_s.downcase == version.to_s.downcase}
-              .first
-            Google::Cloud::Spanner::Admin::Instance.const_get(version_module).new(*args, **kwargs)
-          end
-        end
-      end
-    end
-  end
-end