Class: Google::Cloud::Talent::V4::JobService::Rest::Client::Configuration

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

Overview

Configuration class for the JobService REST API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Talent::V4::JobService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_job.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)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_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)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_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})


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_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)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_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)


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
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1768

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "jobs.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 JobService 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 `create_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_job
    ##
    # RPC-specific configuration for `batch_create_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_jobs
    ##
    # RPC-specific configuration for `get_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_job
    ##
    # RPC-specific configuration for `update_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_job
    ##
    # RPC-specific configuration for `batch_update_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_update_jobs
    ##
    # RPC-specific configuration for `delete_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_job
    ##
    # RPC-specific configuration for `batch_delete_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_jobs
    ##
    # RPC-specific configuration for `list_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_jobs
    ##
    # RPC-specific configuration for `search_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs
    ##
    # RPC-specific configuration for `search_jobs_for_alert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_jobs_for_alert

    # @private
    def initialize parent_rpcs = nil
      create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job
      @create_job = ::Gapic::Config::Method.new create_job_config
      batch_create_jobs_config = parent_rpcs.batch_create_jobs if parent_rpcs.respond_to? :batch_create_jobs
      @batch_create_jobs = ::Gapic::Config::Method.new batch_create_jobs_config
      get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job
      @get_job = ::Gapic::Config::Method.new get_job_config
      update_job_config = parent_rpcs.update_job if parent_rpcs.respond_to? :update_job
      @update_job = ::Gapic::Config::Method.new update_job_config
      batch_update_jobs_config = parent_rpcs.batch_update_jobs if parent_rpcs.respond_to? :batch_update_jobs
      @batch_update_jobs = ::Gapic::Config::Method.new batch_update_jobs_config
      delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job
      @delete_job = ::Gapic::Config::Method.new delete_job_config
      batch_delete_jobs_config = parent_rpcs.batch_delete_jobs if parent_rpcs.respond_to? :batch_delete_jobs
      @batch_delete_jobs = ::Gapic::Config::Method.new batch_delete_jobs_config
      list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs
      @list_jobs = ::Gapic::Config::Method.new list_jobs_config
      search_jobs_config = parent_rpcs.search_jobs if parent_rpcs.respond_to? :search_jobs
      @search_jobs = ::Gapic::Config::Method.new search_jobs_config
      search_jobs_for_alert_config = parent_rpcs.search_jobs_for_alert if parent_rpcs.respond_to? :search_jobs_for_alert
      @search_jobs_for_alert = ::Gapic::Config::Method.new search_jobs_for_alert_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcsRpcs

Configurations for individual RPCs

Returns:



1800
1801
1802
1803
1804
1805
1806
# File 'lib/google/cloud/talent/v4/job_service/rest/client.rb', line 1800

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