Debian Codegraph @

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

raw
1 # Licensed to Elasticsearch B.V. under one or more contributor
2 # license agreements. See the NOTICE file distributed with
3 # this work for additional information regarding copyright
4 # ownership. Elasticsearch B.V. licenses this file to you under
5 # the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing,
12 # software distributed under the License is distributed on an
13 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 # KIND, either express or implied. See the License for the
15 # specific language governing permissions and limitations
16 # under the License.
17
18 package Search::Elasticsearch::Client::8_0::Direct::Simulate;
19 $Search::Elasticsearch::Client::8_0::Direct::Simulate::VERSION = '8.12';
20 use Moo;
21 with 'Search::Elasticsearch::Client::8_0::Role::API';
22 with 'Search::Elasticsearch::Role::Client::Direct';
23 use namespace::clean;
24
25 __PACKAGE__->_install_api('simulate');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::Simulate - Executes ingest pipelines against a set of provided
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head2 DESCRIPTION
42
43 The full documentation for Simulate ingest API is available here:
44 L<https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html>
45
46 =head1 FOLLOW METHODS
47
48 =head2 C<follow()>
49
50 my $response = $es->simulate->ingest(
51 'index' => 'test',
52 'body' => {
53 'docs' => [
54 {
55 '_id' => '123',
56 '_source' => {
57 'foo': 'bar'
58 }
59 },
60 {
61 '_id' => '456',
62 '_source' => {
63 'foo': 'baz'
64 }
65 },
66 ]
67 }
68 );
69
70 =head1 AUTHOR
71
72 Enrico Zimuel <[email protected]>
73
74 =head1 COPYRIGHT AND LICENSE
75
76 This software is Copyright (c) 2024 by Elasticsearch BV.
77
78 This is free software, licensed under:
79
80 The Apache License, Version 2.0, January 2004
81
82 =cut
83
84 __END__
85
86 # ABSTRACT: Executes ingest pipelines against a set of provided
87 documents, optionally with substitute pipeline definitions.
88 This API is meant to be used for troubleshooting or pipeline
89 development, as it does not actually index any data into Elasticsearch.
90