1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
# Licensed to Elasticsearch B.V under one or more agreements.
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
# See the LICENSE file in the project root for more information
package Search::Elasticsearch::Client::8_0::Direct::Ingest;
$Search::Elasticsearch::Client::8_0::Direct::Ingest::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
__PACKAGE__->_install_api('ingest');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::Ingest - A client for accessing the Ingest API
=head1 VERSION
version 8.12
=head1 DESCRIPTION
This module provides methods to access the Ingest API, such as creating,
getting, deleting and simulating ingest pipelines.
It does L<Search::Elasticsearch::Role::Client::Direct>.
=head1 METHODS
=head2 C<put_pipeline()>
$response = $e->ingest->put_pipeline(
id => $id, # required
body => { pipeline defn } # required
);
The C<put_pipeline()> method creates or updates a pipeline with the specified ID.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>
See the L<put pipeline docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html>
for more information.
=head2 C<get_pipeline()>
$response = $e->ingest->get_pipeline(
id => \@id, # optional
);
The C<get_pipeline()> method returns pipelines with the specified IDs (or all pipelines).
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>
See the L<get pipeline docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html>
for more information.
=head2 C<delete_pipeline()>
$response = $e->ingest->delete_pipeline(
id => $id, # required
);
The C<delete_pipeline()> method deletes the pipeline with the specified ID.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>
See the L<delete pipeline docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html>
for more information.
=head2 C<simulate()>
$response = $e->ingest->put_pipeline(
id => $id, # optional
body => { simulate args } # required
);
The C<simulate()> method executes the pipeline specified by ID or inline in the body
against the docs provided in the body and provides debugging output of the execution
process.
Query string parameters:
C<error_trace>,
C<human>,
C<verbose>
See the L<simulate pipeline docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html>
for more information.
=head2 C<simulate()>
$response = $e->ingest->put_pipeline(
id => $id, # optional
body => { simulate args } # required
);
The C<simulate()> method executes the pipeline specified by ID or inline in the body
against the docs provided in the body and provides debugging output of the execution
process.
Query string parameters:
C<error_trace>,
C<human>,
C<verbose>
See the L<simulate pipeline docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html>
for more information.
=head2 C<processor_grok>
$response = $e->inges->processor_grok()
Retrieves the configured patterns associated with the Grok processor.
Query string parameters:
C<error_trace>,
C<human>
See the L<grok processor docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A client for accessing the Ingest API
|
