Class: Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client::Configuration

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

Overview

Configuration class for the SiteSearchEngineService API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.get_site_search_engine.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

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

Returns:

  • (::Hash) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

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

Returns:

  • (::String, nil) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

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

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

Returns:

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


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

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

Additional gRPC headers to be sent with the call.

Returns:

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


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_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) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

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

Returns:

  • (::String, nil) 


1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1484

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SiteSearchEngineService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_site_search_engine`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_site_search_engine
    ##
    # RPC-specific configuration for `create_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_target_site
    ##
    # RPC-specific configuration for `batch_create_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_target_sites
    ##
    # RPC-specific configuration for `get_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_target_site
    ##
    # RPC-specific configuration for `update_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_target_site
    ##
    # RPC-specific configuration for `delete_target_site`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_target_site
    ##
    # RPC-specific configuration for `list_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_target_sites
    ##
    # RPC-specific configuration for `enable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_advanced_site_search
    ##
    # RPC-specific configuration for `disable_advanced_site_search`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_advanced_site_search
    ##
    # RPC-specific configuration for `recrawl_uris`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :recrawl_uris
    ##
    # RPC-specific configuration for `batch_verify_target_sites`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_verify_target_sites
    ##
    # RPC-specific configuration for `fetch_domain_verification_status`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_domain_verification_status

    # @private
    def initialize parent_rpcs = nil
      get_site_search_engine_config = parent_rpcs.get_site_search_engine if parent_rpcs.respond_to? :get_site_search_engine
      @get_site_search_engine = ::Gapic::Config::Method.new get_site_search_engine_config
      create_target_site_config = parent_rpcs.create_target_site if parent_rpcs.respond_to? :create_target_site
      @create_target_site = ::Gapic::Config::Method.new create_target_site_config
      batch_create_target_sites_config = parent_rpcs.batch_create_target_sites if parent_rpcs.respond_to? :batch_create_target_sites
      @batch_create_target_sites = ::Gapic::Config::Method.new batch_create_target_sites_config
      get_target_site_config = parent_rpcs.get_target_site if parent_rpcs.respond_to? :get_target_site
      @get_target_site = ::Gapic::Config::Method.new get_target_site_config
      update_target_site_config = parent_rpcs.update_target_site if parent_rpcs.respond_to? :update_target_site
      @update_target_site = ::Gapic::Config::Method.new update_target_site_config
      delete_target_site_config = parent_rpcs.delete_target_site if parent_rpcs.respond_to? :delete_target_site
      @delete_target_site = ::Gapic::Config::Method.new delete_target_site_config
      list_target_sites_config = parent_rpcs.list_target_sites if parent_rpcs.respond_to? :list_target_sites
      @list_target_sites = ::Gapic::Config::Method.new list_target_sites_config
      enable_advanced_site_search_config = parent_rpcs.enable_advanced_site_search if parent_rpcs.respond_to? :enable_advanced_site_search
      @enable_advanced_site_search = ::Gapic::Config::Method.new enable_advanced_site_search_config
      disable_advanced_site_search_config = parent_rpcs.disable_advanced_site_search if parent_rpcs.respond_to? :disable_advanced_site_search
      @disable_advanced_site_search = ::Gapic::Config::Method.new disable_advanced_site_search_config
      recrawl_uris_config = parent_rpcs.recrawl_uris if parent_rpcs.respond_to? :recrawl_uris
      @recrawl_uris = ::Gapic::Config::Method.new recrawl_uris_config
      batch_verify_target_sites_config = parent_rpcs.batch_verify_target_sites if parent_rpcs.respond_to? :batch_verify_target_sites
      @batch_verify_target_sites = ::Gapic::Config::Method.new batch_verify_target_sites_config
      fetch_domain_verification_status_config = parent_rpcs.fetch_domain_verification_status if parent_rpcs.respond_to? :fetch_domain_verification_status
      @fetch_domain_verification_status = ::Gapic::Config::Method.new fetch_domain_verification_status_config

      yield self if block_given?
    end
  end
end

Instance Method Details

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

Configuration for the channel pool

Returns:

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


1531
1532
1533
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1531

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb', line 1519

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