86 lines
4.2 KiB
Plaintext
86 lines
4.2 KiB
Plaintext
[[reference-get]]
|
|
== client.get
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
++++
|
|
<style>
|
|
.lang-ts a.xref {
|
|
text-decoration: underline !important;
|
|
}
|
|
</style>
|
|
++++
|
|
|
|
|
|
[discrete]
|
|
[[client.get]]
|
|
== `client.get()`
|
|
|
|
Get a document by its ID. Retrieves the document with the specified ID from an index.
|
|
|
|
{ref}/docs-get.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: GetRequest, options?: TransportRequestOptions) => Promise<GetResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface GetRequest extends <<RequestBase>> {
|
|
id: <<Id>>
|
|
index: <<IndexName>>
|
|
force_synthetic_source?: boolean
|
|
preference?: string
|
|
realtime?: boolean
|
|
refresh?: boolean
|
|
routing?: <<Routing>>
|
|
_source?: <<SearchSourceConfigParam>>
|
|
_source_excludes?: <<Fields>>
|
|
_source_includes?: <<Fields>>
|
|
stored_fields?: <<Fields>>
|
|
version?: <<VersionNumber>>
|
|
version_type?: <<VersionType>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type GetResponse<TDocument = unknown> = <<GetGetResult>><TDocument>
|
|
|
|
----
|
|
|
|
|