Module: Google::Cloud

Defined in:: lib/google-cloud-bigtable.rb,
lib/google/cloud/bigtable.rb,
lib/google/cloud/bigtable/v2.rb,
lib/google/cloud/bigtable/row.rb,
lib/google/cloud/bigtable/admin.rb,
lib/google/cloud/bigtable/table.rb,
lib/google/cloud/bigtable/errors.rb,
lib/google/cloud/bigtable/policy.rb,
lib/google/cloud/bigtable/cluster.rb,
lib/google/cloud/bigtable/convert.rb,
lib/google/cloud/bigtable/gc_rule.rb,
lib/google/cloud/bigtable/project.rb,
lib/google/cloud/bigtable/service.rb,
lib/google/cloud/bigtable/version.rb,
lib/google/cloud/bigtable/admin/v2.rb,
lib/google/cloud/bigtable/instance.rb,
lib/google/cloud/bigtable/row_range.rb,
lib/google/cloud/bigtable/row_filter.rb,
lib/google/cloud/bigtable/table/list.rb,
lib/google/cloud/bigtable/app_profile.rb,
lib/google/cloud/bigtable/cluster/job.rb,
lib/google/cloud/bigtable/credentials.rb,
lib/google/cloud/bigtable/rows_reader.rb,
lib/google/cloud/bigtable/value_range.rb,
lib/google/cloud/bigtable/cluster/list.rb,
lib/google/cloud/bigtable/column_range.rb,
lib/google/cloud/bigtable/instance/job.rb,
lib/google/cloud/bigtable/rows_mutator.rb,
lib/google/cloud/bigtable/column_family.rb,
lib/google/cloud/bigtable/instance/list.rb,
lib/google/cloud/bigtable/mutation_entry.rb,
lib/google/cloud/bigtable/sample_row_key.rb,
lib/google/cloud/bigtable/v2/credentials.rb,
lib/google/cloud/bigtable/app_profile/job.rb,
lib/google/cloud/bigtable/chunk_processor.rb,
lib/google/cloud/bigtable/longrunning_job.rb,
lib/google/cloud/bigtable/read_operations.rb,
lib/google/cloud/bigtable/app_profile/list.rb,
lib/google/cloud/bigtable/admin/credentials.rb,
lib/google/cloud/bigtable/v2/bigtable_client.rb,
lib/google/cloud/bigtable/mutation_operations.rb,
lib/google/cloud/bigtable/table/cluster_state.rb,
lib/google/cloud/bigtable/admin/v2/credentials.rb,
lib/google/cloud/bigtable/instance/cluster_map.rb,
lib/google/cloud/bigtable/read_modify_write_rule.rb,
lib/google/cloud/bigtable/row_filter/chain_filter.rb,
lib/google/cloud/bigtable/table/column_family_map.rb,
lib/google/cloud/bigtable/row_filter/simple_filter.rb,
lib/google/cloud/bigtable/row_filter/condition_filter.rb,
lib/google/cloud/bigtable/row_filter/interleave_filter.rb,
lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb,
lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb

Defined Under Namespace

Modules: Bigtable

Class Method Summary collapse

.bigtable(project_id: nil, credentials: nil, scope: nil, timeout: nil, client_config: nil) ⇒ Google::Cloud::Bigtable::Project
Create bigtable client instance for data, table admin and instance admin operartions.

Instance Method Summary collapse

#bigtable(scope: nil, timeout: nil, credentials: nil, client_config: nil) ⇒ Google::Cloud::Bigtable::Project
Creates a new object for connecting to the Bigtable service.

Class Method Details

.bigtable(project_id: nil, credentials: nil, scope: nil, timeout: nil, client_config: nil) ⇒ `Google::Cloud::Bigtable::Project`

Create bigtable client instance for data, table admin and instance admin operartions.

Examples:

require "google/cloud"

bigtable = Google::Cloud.bigtable

Parameters:

project_id (String) —
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) —
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.
scope (Array<String>) —
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) —
The default timeout, in seconds, for calls made through this client.
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. Optional.

Returns:

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

# File 'lib/google-cloud-bigtable.rb', line 122

def self.bigtable \
    project_id: nil,
    credentials: nil,
    scope: nil,
    timeout: nil,
    client_config: nil
  require "google/cloud/bigtable"
  Google::Cloud::Bigtable.new(
    project_id: project_id,
    credentials: credentials,
    scope: scope,
    timeout: timeout,
    client_config: client_config
  )
end

Instance Method Details

#bigtable(scope: nil, timeout: nil, credentials: nil, client_config: nil) ⇒ `Google::Cloud::Bigtable::Project`

Creates a new object for connecting to the Bigtable service.

For more information on connecting to Google Cloud see the Authentication Guide.