Namespace: API-Ingest

API-Ingest

Source:

Methods

(static) IngestApi#deletePipeline(params, options, callback) → {Object|Promise.<never>|*}

Deletes a pipeline.
See Also: OpenSearch - Delete a pipeline
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
id string Pipeline ID
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
timeout string <optional>
 Explicit operation timeout
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Delete Pipeline Response
Type
Object | Promise.<never> | *

(static) IngestApi#geoIpStats(params, options, callback) → {Object|Promise.<never>|*}

Returns statistical information about geoip databases
Parameters:
Name Type Description
params Object (Unused)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IngestApi#getPipeline(params, options, callback) → {Object|Promise.<never>|*}

Returns a pipeline.
See Also: OpenSearch - Get pipeline
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
id string <optional>
 Comma separated list of pipeline ids. Wildcards supported
summary boolean <optional>
 false Return pipelines without their definitions
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Get Pipeline Response
Type
Object | Promise.<never> | *

(static) IngestApi#processorGrok(params, options, callback) → {Object|Promise.<never>|*}

Returns a list of the built-in patterns.
Parameters:
Name Type Description
params Object (Unused)
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) IngestApi#putPipeline(params, options, callback) → {Object|Promise.<never>|*}

Creates or updates a pipeline.
See Also: OpenSearch - Create/Update pipeline
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
id string Pipeline ID
body Object Ingest definition
cluster_manager_timeout string <optional>
 Explicit operation timeout for connection to cluster_manager node
timeout string <optional>
 Explicit operation timeout
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Create/Update Pipeline Response
Type
Object | Promise.<never> | *

(static) IngestApi#simulate(params, options, callback) → {Object|Promise.<never>|*}

Allows to simulate a pipeline with example documents.
See Also: OpenSearch - Simulate Pipeline
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
id string <optional>
 Pipeline ID
verbose boolean <optional>
 Verbose mode. Display data output for each processor in executed pipeline
body Object Simulate definition
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *