Class: Google::Cloud::SecretManager::V1::SecretManagerService::Client::Configuration

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

Overview

Configuration class for the SecretManagerService API.

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

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

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

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

Returns:

  • (::Hash) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_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) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

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

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

Returns:

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


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

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

Additional gRPC headers to be sent with the call.

Returns:

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


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_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) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_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) 


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
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
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1764

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the SecretManagerService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_secrets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secrets
    ##
    # RPC-specific configuration for `create_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_secret
    ##
    # RPC-specific configuration for `add_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_secret_version
    ##
    # RPC-specific configuration for `get_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret
    ##
    # RPC-specific configuration for `update_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_secret
    ##
    # RPC-specific configuration for `delete_secret`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_secret
    ##
    # RPC-specific configuration for `list_secret_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_secret_versions
    ##
    # RPC-specific configuration for `get_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_secret_version
    ##
    # RPC-specific configuration for `access_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :access_secret_version
    ##
    # RPC-specific configuration for `disable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_secret_version
    ##
    # RPC-specific configuration for `enable_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_secret_version
    ##
    # RPC-specific configuration for `destroy_secret_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_secret_version
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions

    # @private
    def initialize parent_rpcs = nil
      list_secrets_config = parent_rpcs.list_secrets if parent_rpcs.respond_to? :list_secrets
      @list_secrets = ::Gapic::Config::Method.new list_secrets_config
      create_secret_config = parent_rpcs.create_secret if parent_rpcs.respond_to? :create_secret
      @create_secret = ::Gapic::Config::Method.new create_secret_config
      add_secret_version_config = parent_rpcs.add_secret_version if parent_rpcs.respond_to? :add_secret_version
      @add_secret_version = ::Gapic::Config::Method.new add_secret_version_config
      get_secret_config = parent_rpcs.get_secret if parent_rpcs.respond_to? :get_secret
      @get_secret = ::Gapic::Config::Method.new get_secret_config
      update_secret_config = parent_rpcs.update_secret if parent_rpcs.respond_to? :update_secret
      @update_secret = ::Gapic::Config::Method.new update_secret_config
      delete_secret_config = parent_rpcs.delete_secret if parent_rpcs.respond_to? :delete_secret
      @delete_secret = ::Gapic::Config::Method.new delete_secret_config
      list_secret_versions_config = parent_rpcs.list_secret_versions if parent_rpcs.respond_to? :list_secret_versions
      @list_secret_versions = ::Gapic::Config::Method.new list_secret_versions_config
      get_secret_version_config = parent_rpcs.get_secret_version if parent_rpcs.respond_to? :get_secret_version
      @get_secret_version = ::Gapic::Config::Method.new get_secret_version_config
      access_secret_version_config = parent_rpcs.access_secret_version if parent_rpcs.respond_to? :access_secret_version
      @access_secret_version = ::Gapic::Config::Method.new access_secret_version_config
      disable_secret_version_config = parent_rpcs.disable_secret_version if parent_rpcs.respond_to? :disable_secret_version
      @disable_secret_version = ::Gapic::Config::Method.new disable_secret_version_config
      enable_secret_version_config = parent_rpcs.enable_secret_version if parent_rpcs.respond_to? :enable_secret_version
      @enable_secret_version = ::Gapic::Config::Method.new enable_secret_version_config
      destroy_secret_version_config = parent_rpcs.destroy_secret_version if parent_rpcs.respond_to? :destroy_secret_version
      @destroy_secret_version = ::Gapic::Config::Method.new destroy_secret_version_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config

      yield self if block_given?
    end
  end
end

Instance Method Details

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

Configuration for the channel pool

Returns:

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


1811
1812
1813
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1811

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1799
1800
1801
1802
1803
1804
1805
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1799

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