1Search::Elasticsearch::UCsleirSeenCator:nc:th7r:_i:0bE:ul:taDesidtriePccestre:la:rRDcoohlc:lu:umCpel(ni3te)antti:o:n7_0::Direct::Rollup(3)
2
3
4

NAME

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

VERSION

10       version 7.715
11

SYNOPSIS

13           my $response = $es->rollup->search( body => {...} )
14
15   DESCRIPTION
16       This class extends the Search::Elasticsearch client with a "rollup"
17       namespace, to support the Rollup APIs
18       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
19       apis.html>.
20
21       The full documentation for the Rollups feature is available here:
22       <https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html>
23

GENERAL METHODS

25   "search()"
26           $response = $es->rollup->search(
27               index   => $index | \@indices,      # optional
28               body    => {...}                    # optional
29           )
30
31       The "search()" method executes a normal search but can join the results
32       from ordinary indices with those from rolled up indices.
33
34       Query string parameters:
35           "error_trace",
36           "filter_path",
37           "human",
38           "typed_keys"
39
40       See the rollup search docs
41       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
42       search.html> for more information.
43

JOB METHODS

45   "put_job()"
46           $response = $es->rollup->put_job(
47               id      => $id,                     # required
48               body    => {...}                    # optional
49           )
50
51       The "put_job()" method creates a rollup job which will rollup matching
52       indices to a rolled up index in the background.
53
54       Query string parameters:
55           "error_trace",
56           "filter_path",
57           "human"
58
59       See the rollup create job docs
60       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
61       put-job.html> for more information.
62
63   "delete_job()"
64           $response = $es->rollup->delete_job(
65               id      => $id,                     # required
66           )
67
68       The "delete_job()" method deletes a rollup job by ID.
69
70       Query string parameters:
71           "error_trace",
72           "filter_path",
73           "human"
74
75       See the rollup delete job docs
76       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
77       delete-job.html> for more information.
78
79   "get_jobs()"
80           $response = $es->rollup->get_jobs(
81               id      => $id,     # optional
82           )
83
84       The "get_job()" method retrieves a rollup job by ID, or all jobs if not
85       specified.
86
87       Query string parameters:
88           "error_trace",
89           "filter_path",
90           "human"
91
92       See the rollup get jobs docs
93       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
94       get-job.html> for more information.
95
96   "start_job()"
97           $response = $es->rollup->start_job(
98               id      => $id,     # required
99           )
100
101       The "start_job()" method starts the specified rollup job.
102
103       Query string parameters:
104           "error_trace",
105           "filter_path",
106           "human"
107
108       See the rollup start job docs
109       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
110       start-job.html> for more information.
111
112   "stop_job()"
113           $response = $es->rollup->stop_job(
114               id      => $id,     # required
115           )
116
117       The "stop_job()" method stops the specified rollup job.
118
119       Query string parameters:
120           "error_trace",
121           "filter_path",
122           "human"
123
124       See the rollup stop job docs
125       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
126       stop-job.html> for more information.
127

DATA METHODS

129   "get_rollup_caps()"
130           $response = $es->rollup->get_rollup_caps(
131               id => $index    # optional
132           )
133
134       The "get_rollup_caps()" method returns the capabilities of any rollup
135       jobs that have been configured for a specific index or index pattern.
136
137       Query string parameters:
138           "error_trace",
139           "filter_path",
140           "human"
141
142       See the get rollup caps docs
143       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
144       get-rollup-caps.html> for more information.
145
146   "get_rollup_index_caps()"
147           $response = $es->rollup->get_rollup_index_caps(
148               id => $index    # optional
149           )
150
151       The "get_rollup_index_caps()" method returns the rollup capabilities of
152       all jobs inside of a rollup index.
153
154       Query string parameters:
155           "error_trace",
156           "filter_path",
157           "human"
158
159       See the get rollup index caps docs
160       <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-
161       get-rollup-index-caps.html> for more information.
162

AUTHOR

164       Enrico Zimuel <enrico.zimuel@elastic.co>
165

167       This software is Copyright (c) 2021 by Elasticsearch BV.
168
169       This is free software, licensed under:
170
171         The Apache License, Version 2.0, January 2004
172
173
174
175perl v5.34.0             Search::E2l0a2s2t-i0c1s-e2a1rch::Client::7_0::Direct::Rollup(3)
Impressum