Class: Google::Cloud::Retail::V2::CatalogService::Rest::Client::Configuration

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

Overview

Configuration class for the CatalogService REST API.

This class represents the configuration for CatalogService REST, 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
# list_catalogs to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Retail::V2::CatalogService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_catalogs.timeout = 20.0
end

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

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#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)
  • (nil) indicating no credentials

Returns:

  • (::Object) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_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) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#logger ⇒ ::Logger, ...

A custom logger to use for request/response debug logging, or the value :default (the default) to construct a default logger, or nil to explicitly disable logging.

Returns:

  • (::Logger, :default, nil) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.

Returns:

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


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_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) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_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) 


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
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1310

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.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.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 :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
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 RPC class for the CatalogService 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 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 `list_catalogs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_catalogs
    ##
    # RPC-specific configuration for `update_catalog`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_catalog
    ##
    # RPC-specific configuration for `set_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_branch
    ##
    # RPC-specific configuration for `get_default_branch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_default_branch
    ##
    # RPC-specific configuration for `get_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_completion_config
    ##
    # RPC-specific configuration for `update_completion_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_completion_config
    ##
    # RPC-specific configuration for `get_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_attributes_config
    ##
    # RPC-specific configuration for `update_attributes_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_attributes_config
    ##
    # RPC-specific configuration for `add_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_catalog_attribute
    ##
    # RPC-specific configuration for `remove_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_catalog_attribute
    ##
    # RPC-specific configuration for `replace_catalog_attribute`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :replace_catalog_attribute

    # @private
    def initialize parent_rpcs = nil
      list_catalogs_config = parent_rpcs.list_catalogs if parent_rpcs.respond_to? :list_catalogs
      @list_catalogs = ::Gapic::Config::Method.new list_catalogs_config
      update_catalog_config = parent_rpcs.update_catalog if parent_rpcs.respond_to? :update_catalog
      @update_catalog = ::Gapic::Config::Method.new update_catalog_config
      set_default_branch_config = parent_rpcs.set_default_branch if parent_rpcs.respond_to? :set_default_branch
      @set_default_branch = ::Gapic::Config::Method.new set_default_branch_config
      get_default_branch_config = parent_rpcs.get_default_branch if parent_rpcs.respond_to? :get_default_branch
      @get_default_branch = ::Gapic::Config::Method.new get_default_branch_config
      get_completion_config_config = parent_rpcs.get_completion_config if parent_rpcs.respond_to? :get_completion_config
      @get_completion_config = ::Gapic::Config::Method.new get_completion_config_config
      update_completion_config_config = parent_rpcs.update_completion_config if parent_rpcs.respond_to? :update_completion_config
      @update_completion_config = ::Gapic::Config::Method.new update_completion_config_config
      get_attributes_config_config = parent_rpcs.get_attributes_config if parent_rpcs.respond_to? :get_attributes_config
      @get_attributes_config = ::Gapic::Config::Method.new get_attributes_config_config
      update_attributes_config_config = parent_rpcs.update_attributes_config if parent_rpcs.respond_to? :update_attributes_config
      @update_attributes_config = ::Gapic::Config::Method.new update_attributes_config_config
      add_catalog_attribute_config = parent_rpcs.add_catalog_attribute if parent_rpcs.respond_to? :add_catalog_attribute
      @add_catalog_attribute = ::Gapic::Config::Method.new add_catalog_attribute_config
      remove_catalog_attribute_config = parent_rpcs.remove_catalog_attribute if parent_rpcs.respond_to? :remove_catalog_attribute
      @remove_catalog_attribute = ::Gapic::Config::Method.new remove_catalog_attribute_config
      replace_catalog_attribute_config = parent_rpcs.replace_catalog_attribute if parent_rpcs.respond_to? :replace_catalog_attribute
      @replace_catalog_attribute = ::Gapic::Config::Method.new replace_catalog_attribute_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1343
1344
1345
1346
1347
1348
1349
 
# File 'lib/google/cloud/retail/v2/catalog_service/rest/client.rb', line 1343

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