Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Graph.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::Graph;
19 $Search::Elasticsearch::Client::8_0::Direct::Graph::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('graph');
26
27 1;
28
29 =pod
30
31 =encoding UTF-8
32
33 =head1 NAME
34
35 Search::Elasticsearch::Client::8_0::Direct::Graph - Plugin providing Graph API for Search::Elasticsearch 8.x
36
37 =head1 VERSION
38
39 version 8.12
40
41 =head1 SYNOPSIS
42
43 my $response = $es->graph->explore(...);
44
45 =head2 DESCRIPTION
46
47 This class extends the L<Search::Elasticsearch> client with a C<graph>
48 namespace, to support the API for the
49 L<Graph|https://www.elastic.co/guide/en/x-pack/current/xpack-graph.html> plugin for Elasticsearch.
50
51 =head1 METHODS
52
53 The full documentation for the Graph plugin is available here:
54 L<https://www.elastic.co/guide/en/graph/current/index.html>
55
56 =head2 C<explore()>
57
58 $response = $es->graph->explore(
59 index => $index | \@indices, # optional
60 type => $type | \@types, # optional
61 body => {...}
62 )
63
64 The C<explore()> method allows you to discover vertices and connections which relate
65 to your query.
66
67 See the L<explore docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html>
68 for more information.
69
70 Query string parameters:
71 C<error_trace>,
72 C<human>,
73 C<routing>,
74 C<timeout>
75
76 =head1 AUTHOR
77
78 Enrico Zimuel <[email protected]>
79
80 =head1 COPYRIGHT AND LICENSE
81
82 This software is Copyright (c) 2024 by Elasticsearch BV.
83
84 This is free software, licensed under:
85
86 The Apache License, Version 2.0, January 2004
87
88 =cut
89
90 __END__
91
92 # ABSTRACT: Plugin providing Graph API for Search::Elasticsearch 8.x
93