Class: Google::Cloud::Vision::V1::ProductSearch::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/vision/v1/product_search/client.rb

Overview

Configuration class for the ProductSearch API.

This class represents the configuration for ProductSearch, 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
# create_product_set to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Vision::V1::ProductSearch::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.create_product_set.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Vision::V1::ProductSearch::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_product_set.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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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>)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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})


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2315

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "vision.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
  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 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 ProductSearch 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 `create_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product_set
    ##
    # RPC-specific configuration for `list_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_product_sets
    ##
    # RPC-specific configuration for `get_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product_set
    ##
    # RPC-specific configuration for `update_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product_set
    ##
    # RPC-specific configuration for `delete_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product_set
    ##
    # RPC-specific configuration for `create_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_product
    ##
    # RPC-specific configuration for `list_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products
    ##
    # RPC-specific configuration for `get_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_product
    ##
    # RPC-specific configuration for `update_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_product
    ##
    # RPC-specific configuration for `delete_product`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_product
    ##
    # RPC-specific configuration for `create_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reference_image
    ##
    # RPC-specific configuration for `delete_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reference_image
    ##
    # RPC-specific configuration for `list_reference_images`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reference_images
    ##
    # RPC-specific configuration for `get_reference_image`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reference_image
    ##
    # RPC-specific configuration for `add_product_to_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_product_to_product_set
    ##
    # RPC-specific configuration for `remove_product_from_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_product_from_product_set
    ##
    # RPC-specific configuration for `list_products_in_product_set`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_products_in_product_set
    ##
    # RPC-specific configuration for `import_product_sets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_product_sets
    ##
    # RPC-specific configuration for `purge_products`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_products

    # @private
    def initialize parent_rpcs = nil
      create_product_set_config = parent_rpcs.create_product_set if parent_rpcs.respond_to? :create_product_set
      @create_product_set = ::Gapic::Config::Method.new create_product_set_config
      list_product_sets_config = parent_rpcs.list_product_sets if parent_rpcs.respond_to? :list_product_sets
      @list_product_sets = ::Gapic::Config::Method.new list_product_sets_config
      get_product_set_config = parent_rpcs.get_product_set if parent_rpcs.respond_to? :get_product_set
      @get_product_set = ::Gapic::Config::Method.new get_product_set_config
      update_product_set_config = parent_rpcs.update_product_set if parent_rpcs.respond_to? :update_product_set
      @update_product_set = ::Gapic::Config::Method.new update_product_set_config
      delete_product_set_config = parent_rpcs.delete_product_set if parent_rpcs.respond_to? :delete_product_set
      @delete_product_set = ::Gapic::Config::Method.new delete_product_set_config
      create_product_config = parent_rpcs.create_product if parent_rpcs.respond_to? :create_product
      @create_product = ::Gapic::Config::Method.new create_product_config
      list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
      @list_products = ::Gapic::Config::Method.new list_products_config
      get_product_config = parent_rpcs.get_product if parent_rpcs.respond_to? :get_product
      @get_product = ::Gapic::Config::Method.new get_product_config
      update_product_config = parent_rpcs.update_product if parent_rpcs.respond_to? :update_product
      @update_product = ::Gapic::Config::Method.new update_product_config
      delete_product_config = parent_rpcs.delete_product if parent_rpcs.respond_to? :delete_product
      @delete_product = ::Gapic::Config::Method.new delete_product_config
      create_reference_image_config = parent_rpcs.create_reference_image if parent_rpcs.respond_to? :create_reference_image
      @create_reference_image = ::Gapic::Config::Method.new create_reference_image_config
      delete_reference_image_config = parent_rpcs.delete_reference_image if parent_rpcs.respond_to? :delete_reference_image
      @delete_reference_image = ::Gapic::Config::Method.new delete_reference_image_config
      list_reference_images_config = parent_rpcs.list_reference_images if parent_rpcs.respond_to? :list_reference_images
      @list_reference_images = ::Gapic::Config::Method.new list_reference_images_config
      get_reference_image_config = parent_rpcs.get_reference_image if parent_rpcs.respond_to? :get_reference_image
      @get_reference_image = ::Gapic::Config::Method.new get_reference_image_config
      add_product_to_product_set_config = parent_rpcs.add_product_to_product_set if parent_rpcs.respond_to? :add_product_to_product_set
      @add_product_to_product_set = ::Gapic::Config::Method.new add_product_to_product_set_config
      remove_product_from_product_set_config = parent_rpcs.remove_product_from_product_set if parent_rpcs.respond_to? :remove_product_from_product_set
      @remove_product_from_product_set = ::Gapic::Config::Method.new remove_product_from_product_set_config
      list_products_in_product_set_config = parent_rpcs.list_products_in_product_set if parent_rpcs.respond_to? :list_products_in_product_set
      @list_products_in_product_set = ::Gapic::Config::Method.new list_products_in_product_set_config
      import_product_sets_config = parent_rpcs.import_product_sets if parent_rpcs.respond_to? :import_product_sets
      @import_product_sets = ::Gapic::Config::Method.new import_product_sets_config
      purge_products_config = parent_rpcs.purge_products if parent_rpcs.respond_to? :purge_products
      @purge_products = ::Gapic::Config::Method.new purge_products_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)


2363
2364
2365
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2363

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

#rpcsRpcs

Configurations for individual RPCs

Returns:



2351
2352
2353
2354
2355
2356
2357
# File 'lib/google/cloud/vision/v1/product_search/client.rb', line 2351

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