More docs changes

This commit is contained in:
Josh Mock
2024-12-04 13:59:24 -06:00
parent 1fde515fcf
commit eef143073c
601 changed files with 21926 additions and 34500 deletions

View File

@ -0,0 +1,148 @@
[[reference-logstash]]
== client.logstash
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.logstash.deletePipeline]]
== `client.logstash.deletePipeline()`
Deletes a pipeline used for Logstash Central Management.
{ref}/logstash-api-delete-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashDeletePipelineRequest, options?: TransportRequestOptions) => Promise<LogstashDeletePipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashDeletePipelineRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashDeletePipelineResponse = boolean
----
[discrete]
[[client.logstash.getPipeline]]
== `client.logstash.getPipeline()`
Retrieves pipelines used for Logstash Central Management.
{ref}/logstash-api-get-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashGetPipelineRequest, options?: TransportRequestOptions) => Promise<LogstashGetPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashGetPipelineRequest extends <<RequestBase>> {
id?: <<Ids>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashGetPipelineResponse = Record<<<Id>>, <<LogstashPipeline>>>
----
[discrete]
[[client.logstash.putPipeline]]
== `client.logstash.putPipeline()`
Creates or updates a pipeline used for Logstash Central Management.
{ref}/logstash-api-put-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashPutPipelineRequest, options?: TransportRequestOptions) => Promise<LogstashPutPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashPutPipelineRequest extends <<RequestBase>> {
id: <<Id>>
pipeline?: <<LogstashPipeline>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashPutPipelineResponse = boolean
----