133 lines
4.5 KiB
JavaScript
133 lines
4.5 KiB
JavaScript
// Licensed to Elasticsearch B.V under one or more agreements.
|
|
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
|
|
// See the LICENSE file in the project root for more information
|
|
|
|
'use strict'
|
|
|
|
/* eslint camelcase: 0 */
|
|
/* eslint no-unused-vars: 0 */
|
|
|
|
function buildGet (opts) {
|
|
// eslint-disable-next-line no-unused-vars
|
|
const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
|
|
/**
|
|
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
|
|
*
|
|
* @param {string} id - The document ID
|
|
* @param {string} index - The name of the index
|
|
* @param {string} type - The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
|
* @param {list} stored_fields - A comma-separated list of stored fields to return in the response
|
|
* @param {string} parent - The ID of the parent document
|
|
* @param {string} preference - Specify the node or shard the operation should be performed on (default: random)
|
|
* @param {boolean} realtime - Specify whether to perform the operation in realtime or search mode
|
|
* @param {boolean} refresh - Refresh the shard containing the document before performing the operation
|
|
* @param {string} routing - Specific routing value
|
|
* @param {list} _source - True or false to return the _source field or not, or a list of fields to return
|
|
* @param {list} _source_excludes - A list of fields to exclude from the returned _source field
|
|
* @param {list} _source_includes - A list of fields to extract and return from the _source field
|
|
* @param {list} _source_exclude - A list of fields to exclude from the returned _source field
|
|
* @param {list} _source_include - A list of fields to extract and return from the _source field
|
|
* @param {number} version - Explicit version number for concurrency control
|
|
* @param {enum} version_type - Specific version type
|
|
*/
|
|
|
|
const acceptedQuerystring = [
|
|
'stored_fields',
|
|
'parent',
|
|
'preference',
|
|
'realtime',
|
|
'refresh',
|
|
'routing',
|
|
'_source',
|
|
'_source_excludes',
|
|
'_source_exclude',
|
|
'_source_includes',
|
|
'_source_include',
|
|
'version',
|
|
'version_type',
|
|
'pretty',
|
|
'human',
|
|
'error_trace',
|
|
'source',
|
|
'filter_path'
|
|
]
|
|
|
|
const snakeCase = {
|
|
storedFields: 'stored_fields',
|
|
_sourceExcludes: '_source_excludes',
|
|
_sourceExclude: '_source_exclude',
|
|
_sourceIncludes: '_source_includes',
|
|
_sourceInclude: '_source_include',
|
|
versionType: 'version_type',
|
|
errorTrace: 'error_trace',
|
|
filterPath: 'filter_path'
|
|
}
|
|
|
|
return function get (params, options, callback) {
|
|
options = options || {}
|
|
if (typeof options === 'function') {
|
|
callback = options
|
|
options = {}
|
|
}
|
|
if (typeof params === 'function' || params == null) {
|
|
callback = params
|
|
params = {}
|
|
options = {}
|
|
}
|
|
|
|
// check required parameters
|
|
if (params['id'] == null) {
|
|
const err = new ConfigurationError('Missing required parameter: id')
|
|
return handleError(err, callback)
|
|
}
|
|
if (params['index'] == null) {
|
|
const err = new ConfigurationError('Missing required parameter: index')
|
|
return handleError(err, callback)
|
|
}
|
|
if (params['type'] == null) {
|
|
const err = new ConfigurationError('Missing required parameter: type')
|
|
return handleError(err, callback)
|
|
}
|
|
if (params.body != null) {
|
|
const err = new ConfigurationError('This API does not require a body')
|
|
return handleError(err, callback)
|
|
}
|
|
|
|
// validate headers object
|
|
if (options.headers != null && typeof options.headers !== 'object') {
|
|
const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
|
|
return handleError(err, callback)
|
|
}
|
|
|
|
var warnings = []
|
|
var { method, body, id, index, type, ...querystring } = params
|
|
querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
|
|
|
|
if (method == null) {
|
|
method = 'GET'
|
|
}
|
|
|
|
var ignore = options.ignore
|
|
if (typeof ignore === 'number') {
|
|
options.ignore = [ignore]
|
|
}
|
|
|
|
var path = ''
|
|
|
|
path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + encodeURIComponent(id)
|
|
|
|
// build request object
|
|
const request = {
|
|
method,
|
|
path,
|
|
body: null,
|
|
querystring
|
|
}
|
|
|
|
options.warnings = warnings.length === 0 ? null : warnings
|
|
return makeRequest(request, options, callback)
|
|
}
|
|
}
|
|
|
|
module.exports = buildGet
|