Class: Google::Cloud::Kms::V1::EkmService::Rest::Client::Configuration

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

Overview

Configuration class for the EkmService REST API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Kms::V1::EkmService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_ekm_connections.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) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_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) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_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}) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_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) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_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) 


895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 895

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 EkmService 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_ekm_connections`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_ekm_connections
    ##
    # RPC-specific configuration for `get_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_connection
    ##
    # RPC-specific configuration for `create_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_ekm_connection
    ##
    # RPC-specific configuration for `update_ekm_connection`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_connection
    ##
    # RPC-specific configuration for `get_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_ekm_config
    ##
    # RPC-specific configuration for `update_ekm_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_ekm_config
    ##
    # RPC-specific configuration for `verify_connectivity`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :verify_connectivity

    # @private
    def initialize parent_rpcs = nil
      list_ekm_connections_config = parent_rpcs.list_ekm_connections if parent_rpcs.respond_to? :list_ekm_connections
      @list_ekm_connections = ::Gapic::Config::Method.new list_ekm_connections_config
      get_ekm_connection_config = parent_rpcs.get_ekm_connection if parent_rpcs.respond_to? :get_ekm_connection
      @get_ekm_connection = ::Gapic::Config::Method.new get_ekm_connection_config
      create_ekm_connection_config = parent_rpcs.create_ekm_connection if parent_rpcs.respond_to? :create_ekm_connection
      @create_ekm_connection = ::Gapic::Config::Method.new create_ekm_connection_config
      update_ekm_connection_config = parent_rpcs.update_ekm_connection if parent_rpcs.respond_to? :update_ekm_connection
      @update_ekm_connection = ::Gapic::Config::Method.new update_ekm_connection_config
      get_ekm_config_config = parent_rpcs.get_ekm_config if parent_rpcs.respond_to? :get_ekm_config
      @get_ekm_config = ::Gapic::Config::Method.new get_ekm_config_config
      update_ekm_config_config = parent_rpcs.update_ekm_config if parent_rpcs.respond_to? :update_ekm_config
      @update_ekm_config = ::Gapic::Config::Method.new update_ekm_config_config
      verify_connectivity_config = parent_rpcs.verify_connectivity if parent_rpcs.respond_to? :verify_connectivity
      @verify_connectivity = ::Gapic::Config::Method.new verify_connectivity_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



934
935
936
937
938
939
940
 
# File 'lib/google/cloud/kms/v1/ekm_service/rest/client.rb', line 934

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