# Licensed to Elasticsearch B.V. under one or more contributor # license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright # ownership. Elasticsearch B.V. licenses this file to you under # the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. package Search::Elasticsearch::Client::7_0::Direct::Watcher; $Search::Elasticsearch::Client::7_0::Direct::Watcher::VERSION = '7.717'; use Moo; with 'Search::Elasticsearch::Client::7_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use namespace::clean; __PACKAGE__->_install_api('watcher'); 1; =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::7_0::Direct::Watcher - Plugin providing Watcher API for Search::Elasticsearch 7.x =head1 VERSION version 7.717 =head1 SYNOPSIS my $response = $es->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->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->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->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->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->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->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->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->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->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->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->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) 2022 by Elasticsearch BV. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut __END__ # ABSTRACT: Plugin providing Watcher API for Search::Elasticsearch 7.x