Search::Elasticsearch::Client::2_0::Role::API - This class contains the spec for the Elasticsearch APIs
version 6.80
All of the Elasticsearch APIs are defined in this role. The example given below is the definition for the "index()" in Search::Elasticsearch::Client::2_0::Direct method:
'index' => { body => { required => 1 }, doc => "docs-index_", method => "POST", parts => { id => {}, index => { required => 1 }, type => { required => 1 } }, paths => [ [ { id => 2, index => 0, type => 1 }, "{index}", "{type}", "{id}" ], [ { index => 0, type => 1 }, "{index}", "{type}" ], ], qs => { consistency => "enum", filter_path => "list", op_type => "enum", parent => "string", refresh => "boolean", routing => "string", timeout => "time", timestamp => "time", ttl => "time", version => "number", version_type => "enum", }, },
These definitions can be used by different Search::Elasticsearch::Role::Client implementations to provide distinct user interfaces.
api()
$defn = $api->api($name);
The only method in this class is the api() method which takes the name of the action and returns its definition. Actions in the indices or cluster namespace use the namespace as a prefix, eg:
indices
cluster
$defn = $e->api('indices.create'); $defn = $e->api('cluster.node_stats');
Search::Elasticsearch::Role::API
Search::Elasticsearch::Client::2_0::Direct
Enrico Zimuel <enrico.zimuel@elastic.co>
This software is Copyright (c) 2020 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch::Client::2_0, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch::Client::2_0
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch::Client::2_0
For more information on module installation, please visit the detailed CPAN module installation guide.