Class: Google::Cloud::DiscoveryEngine::V1::DocumentService::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/discovery_engine/v1/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.

Examples:


# Modify the global config, setting the timeout for
# get_document to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::DiscoveryEngine::V1::DocumentService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.get_document.timeout = 20.0
end

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


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_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) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_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}) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_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) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_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) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1142

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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
    ##
    # RPC-specific configuration for `batch_get_documents_metadata`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents_metadata

    # @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
      batch_get_documents_metadata_config = parent_rpcs.batch_get_documents_metadata if parent_rpcs.respond_to? :batch_get_documents_metadata
      @batch_get_documents_metadata = ::Gapic::Config::Method.new batch_get_documents_metadata_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1174

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