443 lines
12 KiB
Plaintext
443 lines
12 KiB
Plaintext
[[reference-ingest]]
|
|
== client.ingest
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.ingest.deleteGeoipDatabase]]
|
|
== `client.ingest.deleteGeoipDatabase()`
|
|
|
|
Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
|
|
|
|
{ref}/delete-geoip-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestDeleteGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestDeleteGeoipDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestDeleteGeoipDatabaseRequest extends <<RequestBase>> {
|
|
id: <<Ids>>
|
|
master_timeout?: <<Duration>>
|
|
timeout?: <<Duration>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type IngestDeleteGeoipDatabaseResponse = <<AcknowledgedResponseBase>>
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.deleteIpLocationDatabase]]
|
|
== `client.ingest.deleteIpLocationDatabase()`
|
|
|
|
Deletes an ip location database configuration
|
|
|
|
{ref}/delete-ip-location-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestDeleteIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestDeleteIpLocationDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
[[client.ingest.deletePipeline]]
|
|
== `client.ingest.deletePipeline()`
|
|
|
|
Delete pipelines. Delete one or more ingest pipelines.
|
|
|
|
{ref}/delete-pipeline-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestDeletePipelineRequest, options?: TransportRequestOptions) => Promise<IngestDeletePipelineResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestDeletePipelineRequest extends <<RequestBase>> {
|
|
id: <<Id>>
|
|
master_timeout?: <<Duration>>
|
|
timeout?: <<Duration>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type IngestDeletePipelineResponse = <<AcknowledgedResponseBase>>
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.geoIpStats]]
|
|
== `client.ingest.geoIpStats()`
|
|
|
|
Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
|
|
|
|
{ref}/geoip-processor.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestGeoIpStatsRequest, options?: TransportRequestOptions) => Promise<IngestGeoIpStatsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestGeoIpStatsRequest extends <<RequestBase>> {}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestGeoIpStatsResponse {
|
|
stats: IngestGeoIpStatsGeoIpDownloadStatistics
|
|
nodes: Record<<<Id>>, IngestGeoIpStatsGeoIpNodeDatabases>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.getGeoipDatabase]]
|
|
== `client.ingest.getGeoipDatabase()`
|
|
|
|
Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
|
|
|
|
{ref}/get-geoip-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestGetGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestGetGeoipDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestGetGeoipDatabaseRequest extends <<RequestBase>> {
|
|
id?: <<Ids>>
|
|
master_timeout?: <<Duration>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestGetGeoipDatabaseResponse {
|
|
databases: IngestGetGeoipDatabaseDatabaseConfigurationMetadata[]
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.getIpLocationDatabase]]
|
|
== `client.ingest.getIpLocationDatabase()`
|
|
|
|
Returns the specified ip location database configuration
|
|
|
|
{ref}/get-ip-location-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestGetIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestGetIpLocationDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
[[client.ingest.getPipeline]]
|
|
== `client.ingest.getPipeline()`
|
|
|
|
Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
|
|
|
|
{ref}/get-pipeline-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestGetPipelineRequest, options?: TransportRequestOptions) => Promise<IngestGetPipelineResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestGetPipelineRequest extends <<RequestBase>> {
|
|
id?: <<Id>>
|
|
master_timeout?: <<Duration>>
|
|
summary?: boolean
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type IngestGetPipelineResponse = Record<string, <<IngestPipeline>>>
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.processorGrok]]
|
|
== `client.ingest.processorGrok()`
|
|
|
|
Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
|
|
|
{ref}/grok-processor.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestProcessorGrokRequest, options?: TransportRequestOptions) => Promise<IngestProcessorGrokResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestProcessorGrokRequest extends <<RequestBase>> {}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestProcessorGrokResponse {
|
|
patterns: Record<string, string>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.putGeoipDatabase]]
|
|
== `client.ingest.putGeoipDatabase()`
|
|
|
|
Create or update GeoIP database configurations. Create or update IP geolocation database configurations.
|
|
|
|
{ref}/put-geoip-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestPutGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestPutGeoipDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestPutGeoipDatabaseRequest extends <<RequestBase>> {
|
|
id: <<Id>>
|
|
master_timeout?: <<Duration>>
|
|
timeout?: <<Duration>>
|
|
name: <<Name>>
|
|
maxmind: <<IngestMaxmind>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type IngestPutGeoipDatabaseResponse = <<AcknowledgedResponseBase>>
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.putIpLocationDatabase]]
|
|
== `client.ingest.putIpLocationDatabase()`
|
|
|
|
Puts the configuration for a ip location database to be downloaded
|
|
|
|
{ref}/put-ip-location-database-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestPutIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestPutIpLocationDatabaseResponse>
|
|
----
|
|
|
|
[discrete]
|
|
[[client.ingest.putPipeline]]
|
|
== `client.ingest.putPipeline()`
|
|
|
|
Create or update a pipeline. Changes made using this API take effect immediately.
|
|
|
|
{ref}/ingest.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestPutPipelineRequest, options?: TransportRequestOptions) => Promise<IngestPutPipelineResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestPutPipelineRequest extends <<RequestBase>> {
|
|
id: <<Id>>
|
|
master_timeout?: <<Duration>>
|
|
timeout?: <<Duration>>
|
|
if_version?: <<VersionNumber>>
|
|
_meta?: <<Metadata>>
|
|
description?: string
|
|
on_failure?: <<IngestProcessorContainer>>[]
|
|
processors?: <<IngestProcessorContainer>>[]
|
|
version?: <<VersionNumber>>
|
|
deprecated?: boolean
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
type IngestPutPipelineResponse = <<AcknowledgedResponseBase>>
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
[[client.ingest.simulate]]
|
|
== `client.ingest.simulate()`
|
|
|
|
Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
|
|
|
|
{ref}/simulate-pipeline-api.html[{es} documentation]
|
|
[discrete]
|
|
=== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(request: IngestSimulateRequest, options?: TransportRequestOptions) => Promise<IngestSimulateResponse>
|
|
----
|
|
|
|
[discrete]
|
|
=== Request
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestSimulateRequest extends <<RequestBase>> {
|
|
id?: <<Id>>
|
|
verbose?: boolean
|
|
docs: IngestSimulateDocument[]
|
|
pipeline?: <<IngestPipeline>>
|
|
}
|
|
|
|
----
|
|
|
|
|
|
[discrete]
|
|
=== Response
|
|
|
|
[source,ts,subs=+macros]
|
|
----
|
|
interface IngestSimulateResponse {
|
|
docs: IngestSimulateSimulateDocumentResult[]
|
|
}
|
|
|
|
----
|
|
|
|
|