GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SEARCH::ELASTICSEARCH::ROLE::API::1_0 (3)

.ds Aq ’

NAME

Search::Elasticsearch::Role::API::1_0 - This class contains the spec for the Elasticsearch APIs

CONTENTS

VERSION

version 2.00

DESCRIPTION

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 => {
            desc     => The document,
            required => 1
        },

        doc    => /api/index_/,
        method => PUT,
        path   => {index}/{type}/{id|blank},
        qs     => [
            consistency, op_type,     parent,  percolate,
            refresh,     replication, routing, timeout,
            timestamp,   ttl,         version, version_type
        ],
    },



These definitions can be used by different Search::Elasticsearch::Role::Client implementations to provide distinct user interfaces.

METHODS

CWapi()



    $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:



    $defn = $e->api(indices.create);
    $defn = $e->api(cluster.node_stats);



SEE ALSO

o Search::Elasticsearch::Util::API::Path
o Search::Elasticsearch::Util::API::QS
o Search::Elasticsearch::Client::2_0::Direct
o Search::Elasticsearch::Client::0_90::Direct

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Elasticsearch BV.

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SEARCH::ELASTICSEARCH::ROLE::API::1_0 (3) 2015-10-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.