# 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::8_0::Direct::Rollup; $Search::Elasticsearch::Client::8_0::Direct::Rollup::VERSION = '8.12'; use Moo; with 'Search::Elasticsearch::Client::8_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use namespace::clean; __PACKAGE__->_install_api('rollup'); 1; =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::8_0::Direct::Rollup - Plugin providing Rollups for Search::Elasticsearch 8.x =head1 VERSION version 8.12 =head1 SYNOPSIS my $response = $es->rollup->search( body => {...} ) =head2 DESCRIPTION This class extends the L client with a C namespace, to support the L. The full documentation for the Rollups feature is available here: L =head1 GENERAL METHODS =head2 C $response = $es->rollup->search( index => $index | \@indices, # optional body => {...} # optional ) The C method executes a normal search but can join the results from ordinary indices with those from rolled up indices. Query string parameters: C, C, C, C See the L for more information. =head1 JOB METHODS =head2 C $response = $es->rollup->put_job( id => $id, # required body => {...} # optional ) The C method creates a rollup job which will rollup matching indices to a rolled up index in the background. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->rollup->delete_job( id => $id, # required ) The C method deletes a rollup job by ID. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->rollup->get_jobs( id => $id, # optional ) The C method retrieves a rollup job by ID, or all jobs if not specified. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->rollup->start_job( id => $id, # required ) The C method starts the specified rollup job. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->rollup->stop_job( id => $id, # required ) The C method stops the specified rollup job. Query string parameters: C, C, C See the L for more information. =head1 DATA METHODS =head2 C $response = $es->rollup->get_rollup_caps( id => $index # optional ) The C method returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->rollup->get_rollup_index_caps( id => $index # optional ) The C method returns the rollup capabilities of all jobs inside of a rollup index. Query string parameters: C, C, C See the L for more information. =head1 AUTHOR Enrico Zimuel =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2024 by Elasticsearch BV. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut __END__ # ABSTRACT: Plugin providing Rollups for Search::Elasticsearch 8.x