Search::Elasticsearch::Plugin::XPack::2_0::Watcher - Plugin providing Watcher API for Search::Elasticsearch 2.x
version 5.00
use Search::Elasticsearch(); my $es = Search::Elasticsearch->new( nodes => \@nodes, plugins => ['XPack'] ); my $response = $es->watcher->info();
This class extends the Search::Elasticsearch client with a watcher namespace, to support the API for the Watcher plugin for Elasticsearch. In other words, it can be used as follows:
watcher
use Search::Elasticsearch(); my $es = Search::Elasticsearch->new( nodes => \@nodes, plugins => ['Watcher'] ); my $response = $es->watcher->info();
The full documentation for the Watcher plugin is available here: http://www.elastic.co/guide/en/watcher/current/
put_watch()
$response = $es->watcher->put_watch( id => $watch_id, # required body => {...} # required );
The put_watch() method is used to register a new watcher or to update an existing watcher.
See the put_watch docs for more information.
Query string parameters: active, master_timeout
active
master_timeout
get_watch()
$response = $es->watcher->get_watch( id => $watch_id, # required );
The get_watch() method is used to retrieve a watch by ID.
See the get_watch docs for more information.
delete_watch()
$response = $es->watcher->delete_watch( id => $watch_id, # required );
The delete_watch() method is used to delete a watch by ID.
Query string parameters: force, master_timeout
force
See the delete_watch docs for more information.
execute_watch()
$response = $es->watcher->execute_watch( id => $watch_id, # optional body => {...} # optional );
The execute_watch() method forces the execution of a previously registered watch. Optional parameters may be passed in the body.
body
Query string parameters: debug
debug
See the execute_watch docs for more information.
ack_watch()
$response = $es->watcher->ack_watch( watch_id => $watch_id, # required action_id => $action_id | \@action_ids # optional );
The ack_watch() method is used to manually throttle the execution of a watch.
Query string parameters: master_timeout
See the ack_watch docs for more information.
activate_watch()
$response = $es->watcher->activate_watch( watch_id => $watch_id, # required );
The activate_watch() method is used to activate a deactive watch.
See the activate_watch docs for more information.
deactivate_watch()
$response = $es->watcher->deactivate_watch( watch_id => $watch_id, # required );
The deactivate_watch() method is used to deactivate an active watch.
See the deactivate_watch docs for more information.
info()
$response = $es->watcher->info();
The info() method returns basic information about the watcher plugin that is installed.
See the info docs for more information.
stats()
$response = $es->watcher->stats( metric => $metric # optional );
The stats() method returns information about the status of the watcher plugin.
See the stats docs for more information.
stop()
$response = $es->watcher->stop();
The stop() method stops the watcher service if it is running.
See the stop docs for more information.
start()
$response = $es->watcher->start();
The start() method starts the watcher service if it is not already running.
See the start docs for more information.
restart()
$response = $es->watcher->restart();
The restart() method stops then starts the watcher service.
See the restart docs for more information.
Clinton Gormley <drtech@cpan.org>
This software is Copyright (c) 2016 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch::Plugin::XPack, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch::Plugin::XPack
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch::Plugin::XPack
For more information on module installation, please visit the detailed CPAN module installation guide.