NAME
OpenSearch::Client::Core::3_0::Direct::Transforms
VERSION
version 3.007005
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->transforms-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Index transforms
Whereas index rollup jobs let you reduce data granularity by rolling up old data into condensed indexes, transform jobs let you create a different, summarized view of your data centered around certain fields, so you can visualize or analyze the data in different ways.
See OpenSearch documentation for transforms.
METHODS
transforms->delete
Delete an index transform.
Paths served by this method:
$resp = $client->transforms->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 transforms.delete
transforms->explain
Returns the status and metadata of a transform job.
Paths served by this method:
$resp = $client->transforms->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 transforms.explain
transforms->get
Returns the status and metadata of a transform job.
Paths served by this method:
$resp = $client->transforms->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 transforms.get
transforms->preview
Returns a preview of what a transformed index would look like.
Paths served by this method:
$resp = $client->transforms->preview(
'body' => $body, # optional
# 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 transforms.preview
transforms->put
Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided.
Paths served by this method:
$resp = $client->transforms->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 transforms.put
transforms->search
Returns the details of all transform jobs.
Paths served by this method:
$resp = $client->transforms->search(
# Endpoint specific query string parameters
'from' => $qval1, # number
'search' => $qval2, # string
'size' => $qval3, # number
'sortDirection' => $qval4, # string
'sortField' => $qval5, # string
# Common API query string parameters
'error_trace' => $qval6, # boolean
'filter_path' => $qval7, # list
'human' => $qval8, # boolean
'pretty' => $qval9, # boolean
'source' => $qval10, # string
);OpenSearch documentation for transforms.search
transforms->start
Start transform.
Paths served by this method:
$resp = $client->transforms->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 transforms.start
transforms->stop
Stop transform.
Paths served by this method:
$resp = $client->transforms->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 transforms.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