Class: Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb

Overview

Configuration class for the DocumentProcessorService REST API.

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

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

Examples:


# Modify the global config, setting the timeout for
# process_document to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.process_document.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.process_document.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT = 
"documentai.googleapis.com"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

The hostname or hostname:port of the service endpoint. Defaults to "documentai.googleapis.com".

Returns:

  • (::String) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.

Returns:

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


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_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) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2323

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_types
    ##
    # RPC-specific configuration for `get_processor_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_type
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `get_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor
    ##
    # RPC-specific configuration for `train_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :train_processor_version
    ##
    # RPC-specific configuration for `get_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_processor_version
    ##
    # RPC-specific configuration for `list_processor_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processor_versions
    ##
    # RPC-specific configuration for `delete_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor_version
    ##
    # RPC-specific configuration for `deploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :deploy_processor_version
    ##
    # RPC-specific configuration for `undeploy_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :undeploy_processor_version
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `set_default_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_default_processor_version
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document
    ##
    # RPC-specific configuration for `evaluate_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :evaluate_processor_version
    ##
    # RPC-specific configuration for `get_evaluation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_evaluation
    ##
    # RPC-specific configuration for `list_evaluations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_evaluations
    ##
    # RPC-specific configuration for `import_processor_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_processor_version

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
      @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
      get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
      @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor
      @get_processor = ::Gapic::Config::Method.new get_processor_config
      train_processor_version_config = parent_rpcs.train_processor_version if parent_rpcs.respond_to? :train_processor_version
      @train_processor_version = ::Gapic::Config::Method.new train_processor_version_config
      get_processor_version_config = parent_rpcs.get_processor_version if parent_rpcs.respond_to? :get_processor_version
      @get_processor_version = ::Gapic::Config::Method.new get_processor_version_config
      list_processor_versions_config = parent_rpcs.list_processor_versions if parent_rpcs.respond_to? :list_processor_versions
      @list_processor_versions = ::Gapic::Config::Method.new list_processor_versions_config
      delete_processor_version_config = parent_rpcs.delete_processor_version if parent_rpcs.respond_to? :delete_processor_version
      @delete_processor_version = ::Gapic::Config::Method.new delete_processor_version_config
      deploy_processor_version_config = parent_rpcs.deploy_processor_version if parent_rpcs.respond_to? :deploy_processor_version
      @deploy_processor_version = ::Gapic::Config::Method.new deploy_processor_version_config
      undeploy_processor_version_config = parent_rpcs.undeploy_processor_version if parent_rpcs.respond_to? :undeploy_processor_version
      @undeploy_processor_version = ::Gapic::Config::Method.new undeploy_processor_version_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      set_default_processor_version_config = parent_rpcs.set_default_processor_version if parent_rpcs.respond_to? :set_default_processor_version
      @set_default_processor_version = ::Gapic::Config::Method.new set_default_processor_version_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config
      evaluate_processor_version_config = parent_rpcs.evaluate_processor_version if parent_rpcs.respond_to? :evaluate_processor_version
      @evaluate_processor_version = ::Gapic::Config::Method.new evaluate_processor_version_config
      get_evaluation_config = parent_rpcs.get_evaluation if parent_rpcs.respond_to? :get_evaluation
      @get_evaluation = ::Gapic::Config::Method.new get_evaluation_config
      list_evaluations_config = parent_rpcs.list_evaluations if parent_rpcs.respond_to? :list_evaluations
      @list_evaluations = ::Gapic::Config::Method.new list_evaluations_config
      import_processor_version_config = parent_rpcs.import_processor_version if parent_rpcs.respond_to? :import_processor_version
      @import_processor_version = ::Gapic::Config::Method.new import_processor_version_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2359
2360
2361
2362
2363
2364
2365
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/rest/client.rb', line 2359

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