1Search::Elasticsearch::UCsleirSeenCator:nc:th7r:_i:0bE:ul:taDesidtriePccestre:la:rIDcnohgc:eu:smCtel(ni3te)antti:o:n7_0::Direct::Ingest(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::7_0::Direct::Ingest - A client for
7       accessing the Ingest API
8

VERSION

10       version 7.30
11

DESCRIPTION

13       This module provides methods to access the Ingest API, such as
14       creating, getting, deleting and simulating ingest pipelines.
15
16       It does Search::Elasticsearch::Role::Client::Direct.
17

METHODS

19   "put_pipeline()"
20           $response = $e->ingest->put_pipeline(
21               id   => $id,                # required
22               body => { pipeline defn }   # required
23           );
24
25       The "put_pipeline()" method creates or updates a pipeline with the
26       specified ID.
27
28       Query string parameters:
29           "error_trace",
30           "human",
31           "master_timeout",
32           "timeout"
33
34       See the put pipeline docs
35       <https://www.elastic.co/guide/en/elasticsearch/reference/current/put-
36       pipeline-api.html> for more information.
37
38   "get_pipeline()"
39           $response = $e->ingest->get_pipeline(
40               id   => \@id,               # optional
41           );
42
43       The "get_pipeline()" method returns pipelines with the specified IDs
44       (or all pipelines).
45
46       Query string parameters:
47           "error_trace",
48           "human",
49           "master_timeout",
50           "timeout"
51
52       See the get pipeline docs
53       <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-
54       pipeline-api.html> for more information.
55
56   "delete_pipeline()"
57           $response = $e->ingest->delete_pipeline(
58               id   => $id,                # required
59           );
60
61       The "delete_pipeline()" method deletes the pipeline with the specified
62       ID.
63
64       Query string parameters:
65           "error_trace",
66           "human",
67           "master_timeout",
68           "timeout"
69
70       See the delete pipeline docs
71       <https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-
72       pipeline-api.html> for more information.
73
74   "simulate()"
75           $response = $e->ingest->put_pipeline(
76               id   => $id,                # optional
77               body => { simulate args }   # required
78           );
79
80       The "simulate()" method executes the pipeline specified by ID or inline
81       in the body against the docs provided in the body and provides
82       debugging output of the execution process.
83
84       Query string parameters:
85           "error_trace",
86           "human",
87           "verbose"
88
89       See the simulate pipeline docs
90       <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-
91       pipeline-api.html> for more information.
92
93   "simulate()"
94           $response = $e->ingest->put_pipeline(
95               id   => $id,                # optional
96               body => { simulate args }   # required
97           );
98
99       The "simulate()" method executes the pipeline specified by ID or inline
100       in the body against the docs provided in the body and provides
101       debugging output of the execution process.
102
103       Query string parameters:
104           "error_trace",
105           "human",
106           "verbose"
107
108       See the simulate pipeline docs
109       <https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-
110       pipeline-api.html> for more information.
111
112   "processor_grok"
113           $response = $e->inges->processor_grok()
114
115       Retrieves the configured patterns associated with the Grok processor.
116
117       Query string parameters:
118           "error_trace",
119           "human"
120
121       See the grok processor docs
122       <https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-
123       processor.html> for more information.
124

AUTHOR

126       Enrico Zimuel <enrico.zimuel@elastic.co>
127

129       This software is Copyright (c) 2020 by Elasticsearch BV.
130
131       This is free software, licensed under:
132
133         The Apache License, Version 2.0, January 2004
134
135
136
137perl v5.34.0             Search::E2l0a2s1t-i0c7s-e2a2rch::Client::7_0::Direct::Ingest(3)
Impressum