package Search::Elasticsearch::Client::6_0::Direct::XPack::Watcher; $Search::Elasticsearch::Client::6_0::Direct::XPack::Watcher::VERSION = '6.80'; use Moo; with 'Search::Elasticsearch::Client::6_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use namespace::clean; __PACKAGE__->_install_api('xpack.watcher'); 1; # ABSTRACT: Plugin providing Watcher API for Search::Elasticsearch 6.x __END__ =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::6_0::Direct::XPack::Watcher - Plugin providing Watcher API for Search::Elasticsearch 6.x =head1 VERSION version 6.80 =head1 SYNOPSIS my $response = $es->xpack->watcher->start(); =head2 DESCRIPTION This class extends the L client with a C namespace, to support the L. =head1 METHODS The full documentation for the Watcher feature is available here: L =head2 C $response = $es->xpack->watcher->put_watch( id => $watch_id, # required body => {...} ); The C method is used to register a new watcher or to update an existing watcher. See the L for more information. Query string parameters: C, C, C, C, C, C, C =head2 C $response = $es->xpack->watcher->get_watch( id => $watch_id, # required ); The C method is used to retrieve a watch by ID. See the L for more information. Query string parameters: C, C =head2 C $response = $es->xpack->watcher->delete_watch( id => $watch_id, # required ); The C method is used to delete a watch by ID. Query string parameters: C, C, C, C See the L for more information. =head2 C $response = $es->xpack->watcher->execute_watch( id => $watch_id, # optional body => {...} # optional ); The C method forces the execution of a previously registered watch. Optional parameters may be passed in the C. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->xpack->watcher->ack_watch( watch_id => $watch_id, # required action_id => $action_id | \@action_ids # optional ); The C method is used to manually throttle the execution of a watch. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->xpack->watcher->activate_watch( watch_id => $watch_id, # required ); The C method is used to activate a deactive watch. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->xpack->watcher->deactivate_watch( watch_id => $watch_id, # required ); The C method is used to deactivate an active watch. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->xpack->watcher->stats( metric => $metric # optional ); The C method returns information about the status of the watcher plugin. See the L for more information. Query string parameters: C, C =head2 C $response = $es->xpack->watcher->stop(); The C method stops the watcher service if it is running. See the L for more information. Query string parameters: C, C =head2 C $response = $es->xpack->watcher->start(); The C method starts the watcher service if it is not already running. See the L for more information. Query string parameters: C, C =head2 C $response = $es->xpack->watcher->restart(); The C method stops then starts the watcher service. See the L for more information. Query string parameters: C, C =head1 AUTHOR Enrico Zimuel =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2020 by Elasticsearch BV. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut