NAME
OpenSearch::Client::Core::3_0::Direct::Rollups
VERSION
version 3.007002
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->rollups-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Index rollups API
Time series data increases storage costs, strains cluster health, and slows down aggregations over time. Index rollup lets you periodically reduce data granularity by rolling up old data into summarized indexes.
See OpenSearch documentation for rollups.
METHODS
rollups->delete
Deletes an index rollup job configuration.
Paths served by this method:
$resp = $client->rollups->delete(
# path parameters
'id' => $id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for rollups.delete
rollups->explain
Retrieves the execution status information for an index rollup job.
Paths served by this method:
$resp = $client->rollups->explain(
# path parameters
'id' => $id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for rollups.explain
rollups->get
Retrieves an index rollup job configuration by ID.
Paths served by this method:
$resp = $client->rollups->get(
# path parameters
'id' => $id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for rollups.get
rollups->put
Creates or updates an index rollup job configuration.
Paths served by this method:
$resp = $client->rollups->put(
'body' => $body, # optional
# path parameters
'id' => $id, # required
# Endpoint specific query string parameters
'if_primary_term' => $qval1, # number
'if_seq_no' => $qval2, # number
# Common API query string parameters
'error_trace' => $qval3, # boolean
'filter_path' => $qval4, # list
'human' => $qval5, # boolean
'pretty' => $qval6, # boolean
'source' => $qval7, # string
);OpenSearch documentation for rollups.put
rollups->start
Starts the execution of an index rollup job.
Paths served by this method:
$resp = $client->rollups->start(
# path parameters
'id' => $id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for rollups.start
rollups->stop
Stops the execution of an index rollup job.
Paths served by this method:
$resp = $client->rollups->stop(
# path parameters
'id' => $id, # required
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for rollups.stop
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004