elasticsearch-js/docs/reference/api/Ingest.md

Ingest

Constructor

::: new Ingest(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
deleteGeoipDatabase	deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;	Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
deleteGeoipDatabase	deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md), unknown>>;
deleteGeoipDatabase	deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;
deleteIpLocationDatabase	deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;	Delete IP geolocation database configurations.
deleteIpLocationDatabase	deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md), unknown>>;
deleteIpLocationDatabase	deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;
deletePipeline	deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;	Delete pipelines. Delete one or more ingest pipelines.
deletePipeline	deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md), unknown>>;
deletePipeline	deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;
geoIpStats	geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;	Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
geoIpStats	geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md), unknown>>;
geoIpStats	geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;
getGeoipDatabase	getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;	Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
getGeoipDatabase	getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md), unknown>>;
getGeoipDatabase	getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;
getIpLocationDatabase	getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;	Get IP geolocation database configurations.
getIpLocationDatabase	getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md), unknown>>;
getIpLocationDatabase	getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;
getPipeline	getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;	Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
getPipeline	getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md), unknown>>;
getPipeline	getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;
processorGrok	processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;	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.
processorGrok	processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md), unknown>>;
processorGrok	processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;
putGeoipDatabase	putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;	Create or update a GeoIP database configuration. Refer to the create or update IP geolocation database configuration API.
putGeoipDatabase	putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md), unknown>>;
putGeoipDatabase	putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;
putIpLocationDatabase	putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;	Create or update an IP geolocation database configuration.
putIpLocationDatabase	putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md), unknown>>;
putIpLocationDatabase	putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;
putPipeline	putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;	Create or update a pipeline. Changes made using this API take effect immediately.
putPipeline	putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md), unknown>>;
putPipeline	putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;
simulate	simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;	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.
simulate	simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestSimulateResponse](./IngestSimulateResponse.md), unknown>>;
simulate	simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;