Class: Google::Cloud::Domains::V1beta1::Domains::Rest::Client::Configuration

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

Overview

Configuration class for the Domains REST API.

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

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

Examples:


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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.search_domains.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_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) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.

Returns:

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


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_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) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_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) 


1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1695

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the Domains API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `search_domains`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_domains
    ##
    # RPC-specific configuration for `retrieve_register_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_register_parameters
    ##
    # RPC-specific configuration for `register_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_domain
    ##
    # RPC-specific configuration for `retrieve_transfer_parameters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_transfer_parameters
    ##
    # RPC-specific configuration for `transfer_domain`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :transfer_domain
    ##
    # RPC-specific configuration for `list_registrations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_registrations
    ##
    # RPC-specific configuration for `get_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_registration
    ##
    # RPC-specific configuration for `update_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_registration
    ##
    # RPC-specific configuration for `configure_management_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_management_settings
    ##
    # RPC-specific configuration for `configure_dns_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_dns_settings
    ##
    # RPC-specific configuration for `configure_contact_settings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :configure_contact_settings
    ##
    # RPC-specific configuration for `export_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_registration
    ##
    # RPC-specific configuration for `delete_registration`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_registration
    ##
    # RPC-specific configuration for `retrieve_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :retrieve_authorization_code
    ##
    # RPC-specific configuration for `reset_authorization_code`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_authorization_code

    # @private
    def initialize parent_rpcs = nil
      search_domains_config = parent_rpcs.search_domains if parent_rpcs.respond_to? :search_domains
      @search_domains = ::Gapic::Config::Method.new search_domains_config
      retrieve_register_parameters_config = parent_rpcs.retrieve_register_parameters if parent_rpcs.respond_to? :retrieve_register_parameters
      @retrieve_register_parameters = ::Gapic::Config::Method.new retrieve_register_parameters_config
      register_domain_config = parent_rpcs.register_domain if parent_rpcs.respond_to? :register_domain
      @register_domain = ::Gapic::Config::Method.new register_domain_config
      retrieve_transfer_parameters_config = parent_rpcs.retrieve_transfer_parameters if parent_rpcs.respond_to? :retrieve_transfer_parameters
      @retrieve_transfer_parameters = ::Gapic::Config::Method.new retrieve_transfer_parameters_config
      transfer_domain_config = parent_rpcs.transfer_domain if parent_rpcs.respond_to? :transfer_domain
      @transfer_domain = ::Gapic::Config::Method.new transfer_domain_config
      list_registrations_config = parent_rpcs.list_registrations if parent_rpcs.respond_to? :list_registrations
      @list_registrations = ::Gapic::Config::Method.new list_registrations_config
      get_registration_config = parent_rpcs.get_registration if parent_rpcs.respond_to? :get_registration
      @get_registration = ::Gapic::Config::Method.new get_registration_config
      update_registration_config = parent_rpcs.update_registration if parent_rpcs.respond_to? :update_registration
      @update_registration = ::Gapic::Config::Method.new update_registration_config
      configure_management_settings_config = parent_rpcs.configure_management_settings if parent_rpcs.respond_to? :configure_management_settings
      @configure_management_settings = ::Gapic::Config::Method.new configure_management_settings_config
      configure_dns_settings_config = parent_rpcs.configure_dns_settings if parent_rpcs.respond_to? :configure_dns_settings
      @configure_dns_settings = ::Gapic::Config::Method.new configure_dns_settings_config
      configure_contact_settings_config = parent_rpcs.configure_contact_settings if parent_rpcs.respond_to? :configure_contact_settings
      @configure_contact_settings = ::Gapic::Config::Method.new configure_contact_settings_config
      export_registration_config = parent_rpcs.export_registration if parent_rpcs.respond_to? :export_registration
      @export_registration = ::Gapic::Config::Method.new export_registration_config
      delete_registration_config = parent_rpcs.delete_registration if parent_rpcs.respond_to? :delete_registration
      @delete_registration = ::Gapic::Config::Method.new delete_registration_config
      retrieve_authorization_code_config = parent_rpcs.retrieve_authorization_code if parent_rpcs.respond_to? :retrieve_authorization_code
      @retrieve_authorization_code = ::Gapic::Config::Method.new retrieve_authorization_code_config
      reset_authorization_code_config = parent_rpcs.reset_authorization_code if parent_rpcs.respond_to? :reset_authorization_code
      @reset_authorization_code = ::Gapic::Config::Method.new reset_authorization_code_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1727
1728
1729
1730
1731
1732
1733
 
# File 'lib/google/cloud/domains/v1beta1/domains/rest/client.rb', line 1727

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