habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/reference-get.asciidoc Normal file
View File

@ -0,0 +1,72 @@
[[reference-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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== 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]
----
(GetRequest, options?): Promise<GetResponse>
----
[discrete]
===== `GetRequest`
[source,ts]
----
interface GetRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
index: <<shared-type-index-name, IndexName>>
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<shared-type-routing, Routing>>
_source?: SearchSourceConfigParam
_source_excludes?: <<shared-type-fields, Fields>>
_source_includes?: <<shared-type-fields, Fields>>
stored_fields?: <<shared-type-fields, Fields>>
version?: <<shared-type-version-number, VersionNumber>>
version_type?: <<shared-type-version-type, VersionType>>
}
----
[discrete]
===== `GetResponse`
[source,ts]
----
type GetResponse<TDocument = unknown> = GetGetResult<TDocument>
----