/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::Rollups

NAME

OpenSearch::Client::Core::3_0::Direct::Rollups

VERSION

version 3.007009

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

delete

Deletes an index rollup job configuration.

Paths served by this method:

DELETE /_plugins/_rollup/jobs/{id}

Method added in OpenSearch version 1.0

$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

explain

Retrieves the execution status information for an index rollup job.

Paths served by this method:

GET /_plugins/_rollup/jobs/{id}/_explain

Method added in OpenSearch version 1.0

$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

get

Retrieves an index rollup job configuration by ID.

Paths served by this method:

GET /_plugins/_rollup/jobs/{id}

Method added in OpenSearch version 1.0

$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

put

Creates or updates an index rollup job configuration.

Paths served by this method:

PUT /_plugins/_rollup/jobs/{id}

Method added in OpenSearch version 1.0

$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

start

Starts the execution of an index rollup job.

Paths served by this method:

POST /_plugins/_rollup/jobs/{id}/_start

Method added in OpenSearch version 1.0

$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

stop

Stops the execution of an index rollup job.

Paths served by this method:

POST /_plugins/_rollup/jobs/{id}/_stop

Method added in OpenSearch version 1.0

$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

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->rollups->method_supported_in_version(
    method  => 'delete',
    version => '2.4.0'
);

Both method and version are required.

See also global_method_supported_in_version

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