google-cloud-spanner 1.16.2 → 2.4.0

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

@@ -1,162 +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/cloud/spanner/admin/instance/v1/instance_admin_client"
-require "google/spanner/admin/instance/v1/spanner_instance_admin_pb"
-
-module Google
-  module Cloud
-    module Spanner
-      module Admin
-        module Instance
-          # rubocop:disable LineLength
-
-          ##
-          # # Ruby Client for Cloud Spanner Instance Admin API
-          #
-          # [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 V1
-            # rubocop:enable LineLength
-
-            ##
-            # 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 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 \
-                credentials: nil,
-                scopes: nil,
-                client_config: nil,
-                timeout: nil,
-                metadata: nil,
-                exception_transformer: nil,
-                lib_name: nil,
-                lib_version: nil
-              kwargs = {
-                credentials: credentials,
-                scopes: scopes,
-                client_config: client_config,
-                timeout: timeout,
-                metadata: metadata,
-                exception_transformer: exception_transformer,
-                lib_name: lib_name,
-                lib_version: lib_version
-              }.select { |_, v| v != nil }
-              Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.new(**kwargs)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,46 +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 "googleauth"
-
-module Google
-  module Cloud
-    module Spanner
-      module Admin
-        module Instance
-          module V1
-            class Credentials < Google::Auth::Credentials
-              SCOPE = [
-                "https://www.googleapis.com/auth/cloud-platform",
-                "https://www.googleapis.com/auth/spanner.admin"
-              ].freeze
-              PATH_ENV_VARS = %w(SPANNER_ADMIN_INSTANCE_CREDENTIALS
-                                 SPANNER_ADMIN_INSTANCE_KEYFILE
-                                 GOOGLE_CLOUD_CREDENTIALS
-                                 GOOGLE_CLOUD_KEYFILE
-                                 GCLOUD_KEYFILE)
-              JSON_ENV_VARS = %w(SPANNER_ADMIN_INSTANCE_CREDENTIALS_JSON
-                                 SPANNER_ADMIN_INSTANCE_KEYFILE_JSON
-                                 GOOGLE_CLOUD_CREDENTIALS_JSON
-                                 GOOGLE_CLOUD_KEYFILE_JSON
-                                 GCLOUD_KEYFILE_JSON)
-              DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb

@@ -1,64 +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 Iam
-    module V1
-      # Request message for `SetIamPolicy` method.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy is being specified.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] policy
-      #   @return [Google::Iam::V1::Policy]
-      #     REQUIRED: The complete policy to be applied to the `resource`. The size of
-      #     the policy is limited to a few 10s of KB. An empty policy is a
-      #     valid policy but certain Cloud Platform services (such as Projects)
-      #     might reject them.
-      class SetIamPolicyRequest; end
-
-      # Request message for `GetIamPolicy` method.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy is being requested.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] options
-      #   @return [Google::Iam::V1::GetPolicyOptions]
-      #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
-      #     `GetIamPolicy`. This field is only used by Cloud IAM.
-      class GetIamPolicyRequest; end
-
-      # Request message for `TestIamPermissions` method.
-      # @!attribute [rw] resource
-      #   @return [String]
-      #     REQUIRED: The resource for which the policy detail is being requested.
-      #     See the operation documentation for the appropriate value for this field.
-      # @!attribute [rw] permissions
-      #   @return [Array<String>]
-      #     The set of permissions to check for the `resource`. Permissions with
-      #     wildcards (such as '*' or 'storage.*') are not allowed. For more
-      #     information see
-      #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
-      class TestIamPermissionsRequest; end
-
-      # Response message for `TestIamPermissions` method.
-      # @!attribute [rw] permissions
-      #   @return [Array<String>]
-      #     A subset of `TestPermissionsRequest.permissions` that the caller is
-      #     allowed.
-      class TestIamPermissionsResponse; end
-    end
-  end
-end

data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/options.rb

@@ -1,33 +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 Iam
-    module V1
-      # Encapsulates settings provided to GetIamPolicy.
-      # @!attribute [rw] requested_policy_version
-      #   @return [Integer]
-      #     Optional. The policy format version to be returned.
-      #
-      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
-      #     rejected.
-      #
-      #     Requests for policies with any conditional bindings must specify version 3.
-      #     Policies without any conditional bindings may specify any valid value or
-      #     leave the field unset.
-      class GetPolicyOptions; end
-    end
-  end
-end

data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb

@@ -1,151 +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 Iam
-    module V1
-      # Defines an Identity and Access Management (IAM) policy. It is used to
-      # specify access control policies for Cloud Platform resources.
-      #
-      #
-      # A `Policy` is a collection of `bindings`. A `binding` binds one or more
-      # `members` to a single `role`. Members can be user accounts, service accounts,
-      # Google groups, and domains (such as G Suite). A `role` is a named list of
-      # permissions (defined by IAM or configured by users). A `binding` can
-      # optionally specify a `condition`, which is a logic expression that further
-      # constrains the role binding based on attributes about the request and/or
-      # target resource.
-      #
-      # **JSON Example**
-      #
-      #     {
-      #       "bindings": [
-      #         {
-      #           "role": "roles/resourcemanager.organizationAdmin",
-      #           "members": [
-      #             "user:mike@example.com",
-      #             "group:admins@example.com",
-      #             "domain:google.com",
-      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
-      #           ]
-      #         },
-      #         {
-      #           "role": "roles/resourcemanager.organizationViewer",
-      #           "members": ["user:eve@example.com"],
-      #           "condition": {
-      #             "title": "expirable access",
-      #             "description": "Does not grant access after Sep 2020",
-      #             "expression": "request.time <
-      #             timestamp('2020-10-01T00:00:00.000Z')",
-      #           }
-      #         }
-      #       ]
-      #     }
-      #
-      # **YAML Example**
-      #
-      #     bindings:
-      # * members:
-      #   * user:mike@example.com
-      #     * group:admins@example.com
-      #       * domain:google.com
-      #       * serviceAccount:my-project-id@appspot.gserviceaccount.com
-      #         role: roles/resourcemanager.organizationAdmin
-      #       * members:
-      #       * user:eve@example.com
-      #         role: roles/resourcemanager.organizationViewer
-      #         condition:
-      #         title: expirable access
-      #         description: Does not grant access after Sep 2020
-      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
-      #
-      #       For a description of IAM and its features, see the
-      #       [IAM developer's guide](https://cloud.google.com/iam/docs).
-      # @!attribute [rw] version
-      #   @return [Integer]
-      #     Specifies the format of the policy.
-      #
-      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
-      #     rejected.
-      #
-      #     Operations affecting conditional bindings must specify version 3. This can
-      #     be either setting a conditional policy, modifying a conditional binding,
-      #     or removing a binding (conditional or unconditional) from the stored
-      #     conditional policy.
-      #     Operations on non-conditional policies may specify any valid value or
-      #     leave the field unset.
-      #
-      #     If no etag is provided in the call to `setIamPolicy`, version compliance
-      #     checks against the stored policy is skipped.
-      # @!attribute [rw] bindings
-      #   @return [Array<Google::Iam::V1::Binding>]
-      #     Associates a list of `members` to a `role`. Optionally may specify a
-      #     `condition` that determines when binding is in effect.
-      #     `bindings` with no members will result in an error.
-      # @!attribute [rw] etag
-      #   @return [String]
-      #     `etag` is used for optimistic concurrency control as a way to help
-      #     prevent simultaneous updates of a policy from overwriting each other.
-      #     It is strongly suggested that systems make use of the `etag` in the
-      #     read-modify-write cycle to perform policy updates in order to avoid race
-      #     conditions: An `etag` is returned in the response to `getIamPolicy`, and
-      #     systems are expected to put that etag in the request to `setIamPolicy` to
-      #     ensure that their change will be applied to the same version of the policy.
-      #
-      #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
-      #     policy is overwritten. Due to blind-set semantics of an etag-less policy,
-      #     'setIamPolicy' will not fail even if the incoming policy version does not
-      #     meet the requirements for modifying the stored policy.
-      class Policy; end
-
-      # Associates `members` with a `role`.
-      # @!attribute [rw] role
-      #   @return [String]
-      #     Role that is assigned to `members`.
-      #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
-      # @!attribute [rw] members
-      #   @return [Array<String>]
-      #     Specifies the identities requesting access for a Cloud Platform resource.
-      #     `members` can have the following values:
-      #
-      #     * `allUsers`: A special identifier that represents anyone who is
-      #       on the internet; with or without a Google account.
-      #
-      #     * `allAuthenticatedUsers`: A special identifier that represents anyone
-      #       who is authenticated with a Google account or a service account.
-      #
-      #     * `user:{emailid}`: An email address that represents a specific Google
-      #       account. For example, `alice@example.com` .
-      #
-      #
-      #     * `serviceAccount:{emailid}`: An email address that represents a service
-      #       account. For example, `my-other-app@appspot.gserviceaccount.com`.
-      #
-      #     * `group:{emailid}`: An email address that represents a Google group.
-      #       For example, `admins@example.com`.
-      #
-      #
-      #     * `domain:{domain}`: The G Suite domain (primary) that represents all the
-      #       users of that domain. For example, `google.com` or `example.com`.
-      # @!attribute [rw] condition
-      #   @return [Google::Type::Expr]
-      #     The condition that is associated with this binding.
-      #     NOTE: An unsatisfied condition will not allow user access via current
-      #     binding. Different bindings, including their conditions, are examined
-      #     independently.
-      class Binding; end
-    end
-  end
-end