Cloud Bigtable API - Module Google::Cloud::Bigtable (v2.12.2)

Reference documentation and code samples for the Cloud Bigtable API module Google::Cloud::Bigtable.

Cloud Bigtable

Methods

.configure

  def 
  
 self 
 . 
 configure 
 () 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 Config

Configure the Google Cloud Bigtable library.

The following Bigtable configuration parameters are supported:

project_id - (String) Identifier for a Bigtable project. (The parameter project is considered deprecated, but may also be used.)
credentials - (String, Hash, Google::Auth::Credentials, GRPC::Core::Channel, GRPC::Core::ChannelCredentials) The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See Credentials ) (The parameter keyfile is considered deprecated, but may also be used.)
scope - (String, Array
quota_project - (String) The project ID for a project that can be used by client libraries for quota and billing purposes.
timeout - (Integer) Default timeout to use in requests.
endpoint - (String) Override of the endpoint host name, or nil to use the default endpoint.
endpoint_admin - (String) Override of the admin service endpoint host name, or nil to use the default admin endpoint.
channel_selection - (Symbol) The algorithm for selecting a channel from the pool of available channels. This parameter can have the following symbols: :least_loaded selects the channel having least number of concurrent streams.
channel_count - (Integer) The number of channels in the pool.

Yields

(Google::Cloud.configure.bigtable)

Returns

(Google::Cloud::Config) — The configuration object the Google::Cloud::Bigtable library uses.

.new

  def 
  
 self 
 . 
 new 
 ( 
 project_id 
 : 
  
 nil 
 , 
  
 credentials 
 : 
  
 nil 
 , 
  
 universe_domain 
 : 
  
 nil 
 , 
  
 emulator_host 
 : 
  
 nil 
 , 
  
 scope 
 : 
  
 nil 
 , 
  
 endpoint 
 : 
  
 nil 
 , 
  
 endpoint_admin 
 : 
  
 nil 
 , 
  
 timeout 
 : 
  
 nil 
 , 
  
 channel_selection 
 : 
  
 nil 
 , 
  
 channel_count 
 : 
  
 nil 
 ) 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 Bigtable 
 :: 
 Project

Service for managing Cloud Bigtable instances and tables and for reading from and writing to Bigtable tables.

Parameters

project_id(String) (defaults to: nil) — Project identifier for the Bigtable service you are connecting to. If not present, the default project for the credentials is used.
credentials(Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) — Provides the means for authenticating requests made by the client. This parameter can be one of the following types: Google::Auth::Credentials uses the properties of its represented keyfile for authenticating requests made by this client. GRPC::Core::Channel will be used to make calls through. GRPC::Core::ChannelCredentials for the setting up the gRPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. Proc will be used as an updater_proc for the gRPC channel. The proc transforms the metadata for requests, generally, to give OAuth credentials. @note Warning: Passing a String to a keyfile path or a Hash of credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.
universe_domain(String) (defaults to: nil) — Override of the universe domain. Optional.
endpoint(String) (defaults to: nil) — Override of the endpoint host name. Optional. If the param is nil, uses the default endpoint.
endpoint_admin(String) (defaults to: nil) — Override of the admin service endpoint host name. Optional. If the param is nil, uses the default admin endpoint.
emulator_host(String) (defaults to: nil) — Bigtable emulator host. Optional. If the parameter is nil, uses the value of the emulator_host config.
scope(Array<String>) (defaults to: nil) — The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs . The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.
timeout(Integer) (defaults to: nil) — The default timeout, in seconds, for calls made through this client. Optional.
channel_selection(Symbol) (defaults to: nil) —
The algorithm for selecting a channel from the pool of available channels. This parameter can have the following symbols:
- :least_loaded selects the channel having least number of concurrent streams.
channel_count(Integer) (defaults to: nil) — The number of channels in the pool.

Returns

( Google::Cloud::Bigtable::Project )

Raises

(ArgumentError)

Example

 require 
  
 "google/cloud/bigtable" 
 client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Bigtable 
 . 
 new

Constants

VERSION

value: "2.12.2".freeze

Cloud Bigtable API - Module Google::Cloud::Bigtable (v2.12.2) Stay organized with collections Save and categorize content based on your preferences.