Class: Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Rest::Client::Configuration
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Rest::Client::Configuration
- Extended by:
- Gapic::Config
- Defined in:
- lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb
Overview
Configuration class for the DocumentService REST API.
This class represents the configuration for DocumentService 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.
Defined Under Namespace
Classes: Rpcs
Constant Summary collapse
- DEFAULT_ENDPOINT =
"discoveryengine.googleapis.com"
Instance Attribute Summary collapse
-
#credentials ⇒ ::Object
Credentials to send with calls.
-
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint.
-
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging.
-
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging.
-
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
-
#quota_project ⇒ ::String
A separate project against which to charge quota.
-
#retry_policy ⇒ ::Hash
The retry policy.
-
#scope ⇒ ::Array<::String>
The OAuth scopes.
-
#timeout ⇒ ::Numeric
The call timeout in seconds.
Instance Method Summary collapse
-
#rpcs ⇒ Rpcs
Configurations for individual RPCs.
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
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint.
Defaults to "discoveryengine.googleapis.com"
.
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#quota_project ⇒ ::String
A separate project against which to charge quota.
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_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.
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#scope ⇒ ::Array<::String>
The OAuth scopes
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
#timeout ⇒ ::Numeric
The call timeout in seconds.
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 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 989 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String 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 # @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 DocumentService 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 `get_document` # @return [::Gapic::Config::Method] # attr_reader :get_document ## # RPC-specific configuration for `list_documents` # @return [::Gapic::Config::Method] # attr_reader :list_documents ## # RPC-specific configuration for `create_document` # @return [::Gapic::Config::Method] # attr_reader :create_document ## # RPC-specific configuration for `update_document` # @return [::Gapic::Config::Method] # attr_reader :update_document ## # RPC-specific configuration for `delete_document` # @return [::Gapic::Config::Method] # attr_reader :delete_document ## # RPC-specific configuration for `import_documents` # @return [::Gapic::Config::Method] # attr_reader :import_documents ## # RPC-specific configuration for `purge_documents` # @return [::Gapic::Config::Method] # attr_reader :purge_documents # @private def initialize parent_rpcs = nil get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document @get_document = ::Gapic::Config::Method.new get_document_config list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents @list_documents = ::Gapic::Config::Method.new list_documents_config create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document @create_document = ::Gapic::Config::Method.new create_document_config update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document @update_document = ::Gapic::Config::Method.new update_document_config delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document @delete_document = ::Gapic::Config::Method.new delete_document_config import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents @import_documents = ::Gapic::Config::Method.new import_documents_config purge_documents_config = parent_rpcs.purge_documents if parent_rpcs.respond_to? :purge_documents @purge_documents = ::Gapic::Config::Method.new purge_documents_config yield self if block_given? end end end |
Instance Method Details
#rpcs ⇒ Rpcs
Configurations for individual RPCs
1018 1019 1020 1021 1022 1023 1024 |
# File 'lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb', line 1018 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 |