Files
elasticsearch-js/docs/reference-shared-types--global-get.asciidoc
2024-12-05 14:46:52 -06:00

99 lines
4.3 KiB
Plaintext

[[reference-shared-types-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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
== Shared Get types
[discrete]
[[GetGetResult]]
=== GetGetResult
[pass]
++++
<pre>
++++
interface GetGetResult<TDocument = unknown> {
_index: <<IndexName>>
fields?: Record<string, any>
_ignored?: string[]
found: boolean
_id: <<Id>>
_primary_term?: <<long>>
_routing?: string
_seq_no?: <<SequenceNumber>>
_source?: TDocument
_version?: <<VersionNumber>>
}
[pass]
++++
</pre>
++++
[discrete]
[[GetRequest]]
=== GetRequest
[pass]
++++
<pre>
++++
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>>
}
[pass]
++++
</pre>
++++
[discrete]
[[GetResponse]]
=== GetResponse
[pass]
++++
<pre>
++++
type GetResponse<TDocument = unknown> = <<GetGetResult>><TDocument>
[pass]
++++
</pre>
++++