Class: Google::Cloud::Bigtable::V2::Bigtable::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/bigtable/v2/bigtable/client.rb

Overview

Configuration class for the Bigtable API.

This class represents the configuration for Bigtable, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Rpcs for a list of RPCs that can be configured independently.

Configuration can be applied globally to all clients, or to a single client on construction.

Examples:


# Modify the global config, setting the timeout for
# read_rows to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Bigtable::V2::Bigtable::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.read_rows.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Bigtable::V2::Bigtable::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.read_rows.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

Credentials to send with calls. You may provide any of the following types:

  • (String) The path to a service account key file in JSON format
  • (Hash) A service account key as a Hash
  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

Returns:

  • (::Object) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional gRPC headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#retry_policy ⇒ ::Hash

The retry policy. The value is a hash with the following keys:

  • :initial_delay (type: Numeric) - The initial delay in seconds.
  • :max_delay (type: Numeric) - The max delay in seconds.
  • :multiplier (type: Numeric) - The incremental backoff multiplier.
  • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).

Returns:

  • (::String, nil) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1301

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtable.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Bigtable API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `read_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_rows
    ##
    # RPC-specific configuration for `sample_row_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :sample_row_keys
    ##
    # RPC-specific configuration for `mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_row
    ##
    # RPC-specific configuration for `mutate_rows`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_rows
    ##
    # RPC-specific configuration for `check_and_mutate_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_and_mutate_row
    ##
    # RPC-specific configuration for `ping_and_warm`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :ping_and_warm
    ##
    # RPC-specific configuration for `read_modify_write_row`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_modify_write_row
    ##
    # RPC-specific configuration for `generate_initial_change_stream_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_initial_change_stream_partitions
    ##
    # RPC-specific configuration for `read_change_stream`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read_change_stream

    # @private
    def initialize parent_rpcs = nil
      read_rows_config = parent_rpcs.read_rows if parent_rpcs.respond_to? :read_rows
      @read_rows = ::Gapic::Config::Method.new read_rows_config
      sample_row_keys_config = parent_rpcs.sample_row_keys if parent_rpcs.respond_to? :sample_row_keys
      @sample_row_keys = ::Gapic::Config::Method.new sample_row_keys_config
      mutate_row_config = parent_rpcs.mutate_row if parent_rpcs.respond_to? :mutate_row
      @mutate_row = ::Gapic::Config::Method.new mutate_row_config
      mutate_rows_config = parent_rpcs.mutate_rows if parent_rpcs.respond_to? :mutate_rows
      @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
      check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
      @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
      ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
      @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
      read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
      @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
      generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
      @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
      read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
      @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


1348
1349
1350
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1348

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/google/cloud/bigtable/v2/bigtable/client.rb', line 1336

def rpcs
  @rpcs ||= begin
    parent_rpcs = nil
    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
    Rpcs.new parent_rpcs
  end
end