oracular (3) Search::Elasticsearch::Client::8_0::Direct::Rollup.3pm.gz

NAME

       Search::Elasticsearch::Client::8_0::Direct::Rollup - Plugin providing Rollups for Search::Elasticsearch
       8.x

VERSION

       version 8.12

SYNOPSIS

           my $response = $es->rollup->search( body => {...} )

   DESCRIPTION
       This class extends the Search::Elasticsearch client with a "rollup" namespace, to support the Rollup APIs
       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-apis.html>.

       The full documentation for the Rollups feature is available here:
       <https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html>

GENERAL METHODS

   search()
           $response = $es->rollup->search(
               index   => $index | \@indices,      # optional
               body    => {...}                    # optional
           )

       The search() method executes a normal search but can join the results from ordinary indices with those
       from rolled up indices.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human",
           "typed_keys"

       See the rollup search docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
       search.html> for more information.

JOB METHODS

   put_job()
           $response = $es->rollup->put_job(
               id      => $id,                     # required
               body    => {...}                    # optional
           )

       The put_job() method creates a rollup job which will rollup matching indices to a rolled up index in the
       background.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the rollup create job docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
       put-job.html> for more information.

   delete_job()
           $response = $es->rollup->delete_job(
               id      => $id,                     # required
           )

       The delete_job() method deletes a rollup job by ID.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the rollup delete job docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
       delete-job.html> for more information.

   get_jobs()
           $response = $es->rollup->get_jobs(
               id      => $id,     # optional
           )

       The get_job() method retrieves a rollup job by ID, or all jobs if not specified.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the rollup get jobs docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-
       job.html> for more information.

   start_job()
           $response = $es->rollup->start_job(
               id      => $id,     # required
           )

       The start_job() method starts the specified rollup job.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the rollup start job docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
       start-job.html> for more information.

   stop_job()
           $response = $es->rollup->stop_job(
               id      => $id,     # required
           )

       The stop_job() method stops the specified rollup job.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the rollup stop job docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
       stop-job.html> for more information.

DATA METHODS

   get_rollup_caps()
           $response = $es->rollup->get_rollup_caps(
               id => $index    # optional
           )

       The get_rollup_caps() method returns the capabilities of any rollup jobs that have been configured for a
       specific index or index pattern.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the get rollup caps docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-
       rollup-caps.html> for more information.

   get_rollup_index_caps()
           $response = $es->rollup->get_rollup_index_caps(
               id => $index    # optional
           )

       The get_rollup_index_caps() method returns the rollup capabilities of all jobs inside of a rollup index.

       Query string parameters:
           "error_trace",
           "filter_path",
           "human"

       See the get rollup index caps docs
       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html> for
       more information.

AUTHOR

       Enrico Zimuel <enrico.zimuel@elastic.co>

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

perl v5.38.2                                       2024-0Search::Elasticsearch::Client::8_0::Direct::Rollup(3pm)