Files
elasticsearch-js/docs/reference/api/GetSourceRequest.md
2025-05-27 15:30:21 -05:00

2.3 KiB

Interface GetSourceRequest

Name Type Description
_source_excludes Fields A comma-separated list of source fields to exclude in the response.
_source_includes Fields A comma-separated list of source fields to include in the response.
_source SearchSourceConfigParam Indicates whether to return the _source field ( true or false) or lists the fields to return.
body string ({ [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; })
id Id A unique document identifier.
index IndexName The name of the index that contains the document.
preference string The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas.
querystring { [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; } All values in querystring will be added to the request querystring.
realtime boolean If true, the request is real-time as opposed to near-real-time.
refresh boolean If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
routing Routing A custom value used to route operations to a specific shard.
stored_fields Fields A comma-separated list of stored fields to return as part of a hit.
version_type VersionType The version type.
version VersionNumber The version number for concurrency control. It must match the current version of the document for the request to succeed.