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

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

Overview

Configuration class for the SecretManagerService REST API.

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

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

Examples:


# Modify the global config, setting the timeout for
# list_secrets to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::SecretManager::V1::SecretManagerService::Rest::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::Rest::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

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 headers to be sent with the call.

Returns:

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


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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>) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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) 


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1626

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.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/rest/client.rb', line 1665

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