Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Ingest.pm

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