Module: Google::Cloud::Spanner::Admin::Instance

Defined in:
lib/google/cloud/spanner/admin/instance.rb,
lib/google/cloud/spanner/admin/instance/v1.rb,
lib/google/cloud/spanner/admin/instance/credentials.rb,
lib/google/cloud/spanner/admin/instance/v1/doc/overview.rb,
lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb

Overview

# Ruby Client for Cloud Spanner Instance Admin API ([Alpha](github.com/GoogleCloudPlatform/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.](console.cloud.google.com/project)

  2. [Enable billing for your project.](cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)

  3. [Enable the Cloud Spanner Instance Admin API.](console.cloud.google.com/apis/api/spanner-admin-instance)

  4. [Setup Authentication.](googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)

### Installation “‘ $ gem install google-cloud-spanner-admin-instance “`

### Next Steps

[Product Documentation]: cloud.google.com/spanner-admin-instance

Defined Under Namespace

Modules: V1 Classes: Credentials

Constant Summary collapse

FILE_DIR =

rubocop:enable LineLength

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) }

Class Method Summary collapse

Class Method Details

.new(version: , credentials: , scopes: , client_config: , timeout: ) ⇒ Object

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.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: ) —

    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.

  • scopes (Array<String>) (defaults to: ) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: ) —

    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.

  • timeout (Numeric) (defaults to: ) —

    The default timeout, in seconds, for calls made through this client.

Parameters:

  • version (Symbol, String) (defaults to: :v1) —

    The major version of the service to be used. By default :v1 is used.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/spanner/admin/instance.rb', line 111

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